Documentation ¶
Overview ¶
Package niddau provides primitives to interact with the openapi HTTP API.
Code generated by github.com/deepmap/oapi-codegen/v2 version v2.0.1-0.20240123090344-d326c01d279a DO NOT EDIT.
Index ¶
- Constants
- func GetKinOpenApi3Document() (*openapi3.T, error)
- func GetKinOpenApi3DocumentMust() *openapi3.T
- func NewAuthorizeNiddDataRequest(server string, ueIdentity string, body AuthorizeNiddDataJSONRequestBody) (*http.Request, error)
- func NewAuthorizeNiddDataRequestWithBody(server string, ueIdentity string, contentType string, body io.Reader) (*http.Request, error)
- func RegisterHandlers(router gin.IRouter, si ServerInterface)
- func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
- type AuthorizationData
- type AuthorizationInfo
- type AuthorizeNiddData200JSONResponse
- type AuthorizeNiddData400ApplicationProblemPlusJSONResponse
- type AuthorizeNiddData403ApplicationProblemPlusJSONResponse
- type AuthorizeNiddData404ApplicationProblemPlusJSONResponse
- type AuthorizeNiddData500ApplicationProblemPlusJSONResponse
- type AuthorizeNiddData501ApplicationProblemPlusJSONResponse
- type AuthorizeNiddData503ApplicationProblemPlusJSONResponse
- type AuthorizeNiddDataJSONRequestBody
- type AuthorizeNiddDataRequestObject
- type AuthorizeNiddDataResponse
- type AuthorizeNiddDataResponseObject
- type AuthorizeNiddDatadefaultApplicationProblemPlusJSONResponse
- type Client
- type ClientInterface
- type ClientOption
- type ClientWithResponses
- func (c *ClientWithResponses) AuthorizeNiddDataWithBodyWithResponse(ctx context.Context, ueIdentity string, contentType string, body io.Reader, ...) (*AuthorizeNiddDataResponse, error)
- func (c *ClientWithResponses) AuthorizeNiddDataWithResponse(ctx context.Context, ueIdentity string, body AuthorizeNiddDataJSONRequestBody, ...) (*AuthorizeNiddDataResponse, error)
- type ClientWithResponsesInterface
- type GinServerOptions
- type HttpRequestDoer
- type MiddlewareFunc
- type NiddAuthUpdateInfo
- type NiddAuthUpdateNotification
- func (a NiddAuthUpdateNotification) Get(fieldName string) (value interface{}, found bool)
- func (a NiddAuthUpdateNotification) MarshalJSON() ([]byte, error)
- func (a *NiddAuthUpdateNotification) Set(fieldName string, value interface{})
- func (a *NiddAuthUpdateNotification) UnmarshalJSON(b []byte) error
- type NiddCause
- type RequestEditorFn
- type ServerInterface
- type ServerInterfaceWrapper
- type StrictHandlerFunc
- type StrictMiddlewareFunc
- type StrictServerInterface
- type UserIdentifier
Constants ¶
const (
OAuth2ClientCredentialsScopes = "oAuth2ClientCredentials.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func GetKinOpenApi3Document ¶
func NewAuthorizeNiddDataRequest ¶
func NewAuthorizeNiddDataRequest(server string, ueIdentity string, body AuthorizeNiddDataJSONRequestBody) (*http.Request, error)
NewAuthorizeNiddDataRequest calls the generic AuthorizeNiddData builder with application/json body
func NewAuthorizeNiddDataRequestWithBody ¶
func NewAuthorizeNiddDataRequestWithBody(server string, ueIdentity string, contentType string, body io.Reader) (*http.Request, error)
NewAuthorizeNiddDataRequestWithBody generates requests for AuthorizeNiddData with any type of body
func RegisterHandlers ¶
func RegisterHandlers(router gin.IRouter, si ServerInterface)
RegisterHandlers creates http.Handler with routing matching OpenAPI spec.
func RegisterHandlersWithOptions ¶
func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
RegisterHandlersWithOptions creates http.Handler with additional options
Types ¶
type AuthorizationData ¶
type AuthorizationData struct { AuthorizationData []UserIdentifier `json:"authorizationData"` ValidityTime *externalRef0.DateTime `json:"validityTime,omitempty"` AdditionalProperties map[string]interface{} `json:"-"` }
AuthorizationData defines model for AuthorizationData.
func (AuthorizationData) Get ¶
func (a AuthorizationData) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for AuthorizationData. Returns the specified element and whether it was found
func (AuthorizationData) MarshalJSON ¶
func (a AuthorizationData) MarshalJSON() ([]byte, error)
Override default JSON handling for AuthorizationData to handle AdditionalProperties
func (*AuthorizationData) Set ¶
func (a *AuthorizationData) Set(fieldName string, value interface{})
Setter for additional properties for AuthorizationData
func (*AuthorizationData) UnmarshalJSON ¶
func (a *AuthorizationData) UnmarshalJSON(b []byte) error
Override default JSON handling for AuthorizationData to handle AdditionalProperties
type AuthorizationInfo ¶
type AuthorizationInfo struct { AfId *string `json:"afId,omitempty"` AuthUpdateCallbackUri externalRef0.Uri `json:"authUpdateCallbackUri"` Dnn externalRef0.Dnn `json:"dnn"` MtcProviderInformation externalRef0.MtcProviderInformation `json:"mtcProviderInformation"` // NefId Identity of the NEF NefId *externalRef1.NefId `json:"nefId,omitempty"` Snssai externalRef0.Snssai `json:"snssai"` ValidityTime *externalRef0.DateTime `json:"validityTime,omitempty"` AdditionalProperties map[string]interface{} `json:"-"` }
AuthorizationInfo defines model for AuthorizationInfo.
func (AuthorizationInfo) Get ¶
func (a AuthorizationInfo) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for AuthorizationInfo. Returns the specified element and whether it was found
func (AuthorizationInfo) MarshalJSON ¶
func (a AuthorizationInfo) MarshalJSON() ([]byte, error)
Override default JSON handling for AuthorizationInfo to handle AdditionalProperties
func (*AuthorizationInfo) Set ¶
func (a *AuthorizationInfo) Set(fieldName string, value interface{})
Setter for additional properties for AuthorizationInfo
func (*AuthorizationInfo) UnmarshalJSON ¶
func (a *AuthorizationInfo) UnmarshalJSON(b []byte) error
Override default JSON handling for AuthorizationInfo to handle AdditionalProperties
type AuthorizeNiddData200JSONResponse ¶
type AuthorizeNiddData200JSONResponse AuthorizationData
func (AuthorizeNiddData200JSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData200JSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddData400ApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddData400ApplicationProblemPlusJSONResponse struct {
externalRef0.N400ApplicationProblemPlusJSONResponse
}
func (AuthorizeNiddData400ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData400ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddData403ApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddData403ApplicationProblemPlusJSONResponse struct {
externalRef0.N403ApplicationProblemPlusJSONResponse
}
func (AuthorizeNiddData403ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData403ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddData404ApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddData404ApplicationProblemPlusJSONResponse struct {
externalRef0.N404ApplicationProblemPlusJSONResponse
}
func (AuthorizeNiddData404ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData404ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddData500ApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddData500ApplicationProblemPlusJSONResponse struct {
externalRef0.N500ApplicationProblemPlusJSONResponse
}
func (AuthorizeNiddData500ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData500ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddData501ApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddData501ApplicationProblemPlusJSONResponse struct {
externalRef0.N501ApplicationProblemPlusJSONResponse
}
func (AuthorizeNiddData501ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData501ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddData503ApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddData503ApplicationProblemPlusJSONResponse struct {
externalRef0.N503ApplicationProblemPlusJSONResponse
}
func (AuthorizeNiddData503ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddData503ApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type AuthorizeNiddDataJSONRequestBody ¶
type AuthorizeNiddDataJSONRequestBody = AuthorizationInfo
AuthorizeNiddDataJSONRequestBody defines body for AuthorizeNiddData for application/json ContentType.
type AuthorizeNiddDataRequestObject ¶
type AuthorizeNiddDataRequestObject struct { UeIdentity string `json:"ueIdentity"` Body *AuthorizeNiddDataJSONRequestBody }
type AuthorizeNiddDataResponse ¶
type AuthorizeNiddDataResponse struct { Body []byte HTTPResponse *http.Response JSON200 *AuthorizationData ApplicationproblemJSON400 *externalRef0.N400 ApplicationproblemJSON403 *externalRef0.N403 ApplicationproblemJSON404 *externalRef0.N404 ApplicationproblemJSON500 *externalRef0.N500 ApplicationproblemJSON501 *externalRef0.N501 ApplicationproblemJSON503 *externalRef0.N503 ApplicationproblemJSONDefault *externalRef0.ProblemDetails }
func ParseAuthorizeNiddDataResponse ¶
func ParseAuthorizeNiddDataResponse(rsp *http.Response) (*AuthorizeNiddDataResponse, error)
ParseAuthorizeNiddDataResponse parses an HTTP response from a AuthorizeNiddDataWithResponse call
func (AuthorizeNiddDataResponse) Status ¶
func (r AuthorizeNiddDataResponse) Status() string
Status returns HTTPResponse.Status
func (AuthorizeNiddDataResponse) StatusCode ¶
func (r AuthorizeNiddDataResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type AuthorizeNiddDataResponseObject ¶
type AuthorizeNiddDataResponseObject interface {
VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
}
type AuthorizeNiddDatadefaultApplicationProblemPlusJSONResponse ¶
type AuthorizeNiddDatadefaultApplicationProblemPlusJSONResponse struct { Body externalRef0.ProblemDetails StatusCode int }
func (AuthorizeNiddDatadefaultApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse ¶
func (response AuthorizeNiddDatadefaultApplicationProblemPlusJSONResponse) VisitAuthorizeNiddDataResponse(w http.ResponseWriter) error
type Client ¶
type Client struct { // The endpoint of the server conforming to this interface, with scheme, // https://api.deepmap.com for example. This can contain a path relative // to the server, such as https://api.deepmap.com/dev-test, and all the // paths in the swagger spec will be appended to the server. Server string // Doer for performing requests, typically a *http.Client with any // customized settings, such as certificate chains. Client HttpRequestDoer // A list of callbacks for modifying requests which are generated before sending over // the network. RequestEditors []RequestEditorFn }
Client which conforms to the OpenAPI3 specification for this service.
func NewClient ¶
func NewClient(server string, opts ...ClientOption) (*Client, error)
Creates a new Client, with reasonable defaults
func (*Client) AuthorizeNiddData ¶
func (c *Client) AuthorizeNiddData(ctx context.Context, ueIdentity string, body AuthorizeNiddDataJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
type ClientInterface ¶
type ClientInterface interface { // AuthorizeNiddDataWithBody request with any body AuthorizeNiddDataWithBody(ctx context.Context, ueIdentity string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) AuthorizeNiddData(ctx context.Context, ueIdentity string, body AuthorizeNiddDataJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) }
The interface specification for the client above.
type ClientOption ¶
ClientOption allows setting custom parameters during construction
func WithHTTPClient ¶
func WithHTTPClient(doer HttpRequestDoer) ClientOption
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.
func WithRequestEditorFn ¶
func WithRequestEditorFn(fn RequestEditorFn) ClientOption
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.
type ClientWithResponses ¶
type ClientWithResponses struct {
ClientInterface
}
ClientWithResponses builds on ClientInterface to offer response payloads
func NewClientWithResponses ¶
func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling
func (*ClientWithResponses) AuthorizeNiddDataWithBodyWithResponse ¶
func (c *ClientWithResponses) AuthorizeNiddDataWithBodyWithResponse(ctx context.Context, ueIdentity string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AuthorizeNiddDataResponse, error)
AuthorizeNiddDataWithBodyWithResponse request with arbitrary body returning *AuthorizeNiddDataResponse
func (*ClientWithResponses) AuthorizeNiddDataWithResponse ¶
func (c *ClientWithResponses) AuthorizeNiddDataWithResponse(ctx context.Context, ueIdentity string, body AuthorizeNiddDataJSONRequestBody, reqEditors ...RequestEditorFn) (*AuthorizeNiddDataResponse, error)
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // AuthorizeNiddDataWithBodyWithResponse request with any body AuthorizeNiddDataWithBodyWithResponse(ctx context.Context, ueIdentity string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*AuthorizeNiddDataResponse, error) AuthorizeNiddDataWithResponse(ctx context.Context, ueIdentity string, body AuthorizeNiddDataJSONRequestBody, reqEditors ...RequestEditorFn) (*AuthorizeNiddDataResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type GinServerOptions ¶
type GinServerOptions struct { BaseURL string Middlewares []MiddlewareFunc ErrorHandler func(*gin.Context, error, int) }
GinServerOptions provides options for the Gin server.
type HttpRequestDoer ¶
Doer performs HTTP requests.
The standard http.Client implements this interface.
type MiddlewareFunc ¶
type NiddAuthUpdateInfo ¶
type NiddAuthUpdateInfo struct { AuthorizationData AuthorizationData `json:"authorizationData"` Dnn *externalRef0.Dnn `json:"dnn,omitempty"` InvalidityInd *bool `json:"invalidityInd,omitempty"` NiddCause *NiddCause `json:"niddCause,omitempty"` Snssai *externalRef0.Snssai `json:"snssai,omitempty"` AdditionalProperties map[string]interface{} `json:"-"` }
NiddAuthUpdateInfo defines model for NiddAuthUpdateInfo.
func (NiddAuthUpdateInfo) Get ¶
func (a NiddAuthUpdateInfo) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for NiddAuthUpdateInfo. Returns the specified element and whether it was found
func (NiddAuthUpdateInfo) MarshalJSON ¶
func (a NiddAuthUpdateInfo) MarshalJSON() ([]byte, error)
Override default JSON handling for NiddAuthUpdateInfo to handle AdditionalProperties
func (*NiddAuthUpdateInfo) Set ¶
func (a *NiddAuthUpdateInfo) Set(fieldName string, value interface{})
Setter for additional properties for NiddAuthUpdateInfo
func (*NiddAuthUpdateInfo) UnmarshalJSON ¶
func (a *NiddAuthUpdateInfo) UnmarshalJSON(b []byte) error
Override default JSON handling for NiddAuthUpdateInfo to handle AdditionalProperties
type NiddAuthUpdateNotification ¶
type NiddAuthUpdateNotification struct { NiddAuthUpdateInfoList []NiddAuthUpdateInfo `json:"niddAuthUpdateInfoList"` AdditionalProperties map[string]interface{} `json:"-"` }
NiddAuthUpdateNotification defines model for NiddAuthUpdateNotification.
func (NiddAuthUpdateNotification) Get ¶
func (a NiddAuthUpdateNotification) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for NiddAuthUpdateNotification. Returns the specified element and whether it was found
func (NiddAuthUpdateNotification) MarshalJSON ¶
func (a NiddAuthUpdateNotification) MarshalJSON() ([]byte, error)
Override default JSON handling for NiddAuthUpdateNotification to handle AdditionalProperties
func (*NiddAuthUpdateNotification) Set ¶
func (a *NiddAuthUpdateNotification) Set(fieldName string, value interface{})
Setter for additional properties for NiddAuthUpdateNotification
func (*NiddAuthUpdateNotification) UnmarshalJSON ¶
func (a *NiddAuthUpdateNotification) UnmarshalJSON(b []byte) error
Override default JSON handling for NiddAuthUpdateNotification to handle AdditionalProperties
type RequestEditorFn ¶
RequestEditorFn is the function signature for the RequestEditor callback function
type ServerInterface ¶
type ServerInterface interface { // Authorize the NIDD configuration request. // (POST /{ueIdentity}/authorize) AuthorizeNiddData(c *gin.Context, ueIdentity string) }
ServerInterface represents all server handlers.
func NewStrictHandler ¶
func NewStrictHandler(ssi StrictServerInterface, middlewares []StrictMiddlewareFunc) ServerInterface
type ServerInterfaceWrapper ¶
type ServerInterfaceWrapper struct { Handler ServerInterface HandlerMiddlewares []MiddlewareFunc ErrorHandler func(*gin.Context, error, int) }
ServerInterfaceWrapper converts contexts to parameters.
func (*ServerInterfaceWrapper) AuthorizeNiddData ¶
func (siw *ServerInterfaceWrapper) AuthorizeNiddData(c *gin.Context)
AuthorizeNiddData operation middleware
type StrictHandlerFunc ¶
type StrictHandlerFunc = strictgin.StrictGinHandlerFunc
type StrictMiddlewareFunc ¶
type StrictMiddlewareFunc = strictgin.StrictGinMiddlewareFunc
type StrictServerInterface ¶
type StrictServerInterface interface { // Authorize the NIDD configuration request. // (POST /{ueIdentity}/authorize) AuthorizeNiddData(ctx context.Context, request AuthorizeNiddDataRequestObject) (AuthorizeNiddDataResponseObject, error) }
StrictServerInterface represents all server handlers.
type UserIdentifier ¶
type UserIdentifier struct { Gpsi externalRef0.Gpsi `json:"gpsi,omitempty"` Supi externalRef0.Supi `json:"supi"` ValidityTime *externalRef0.DateTime `json:"validityTime,omitempty"` AdditionalProperties map[string]interface{} `json:"-"` }
UserIdentifier defines model for UserIdentifier.
func (UserIdentifier) Get ¶
func (a UserIdentifier) Get(fieldName string) (value interface{}, found bool)
Getter for additional properties for UserIdentifier. Returns the specified element and whether it was found
func (UserIdentifier) MarshalJSON ¶
func (a UserIdentifier) MarshalJSON() ([]byte, error)
Override default JSON handling for UserIdentifier to handle AdditionalProperties
func (*UserIdentifier) Set ¶
func (a *UserIdentifier) Set(fieldName string, value interface{})
Setter for additional properties for UserIdentifier
func (*UserIdentifier) UnmarshalJSON ¶
func (a *UserIdentifier) UnmarshalJSON(b []byte) error
Override default JSON handling for UserIdentifier to handle AdditionalProperties