idmap

package
v0.0.0-...-b1a38c4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 26, 2024 License: Apache-2.0 Imports: 49 Imported by: 0

Documentation

Overview

Package idmap 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

View Source
const (
	OAuth2ClientCredentialsScopes = "oAuth2ClientCredentials.Scopes"
)

Variables

This section is empty.

Functions

func GetKinOpenApi3Document

func GetKinOpenApi3Document() (*openapi3.T, error)

func GetKinOpenApi3DocumentMust

func GetKinOpenApi3DocumentMust() *openapi3.T

func NewGetNfGroupIDsRequest

func NewGetNfGroupIDsRequest(server string, params *GetNfGroupIDsParams) (*http.Request, error)

NewGetNfGroupIDsRequest generates requests for GetNfGroupIDs

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 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) GetNfGroupIDs

func (c *Client) GetNfGroupIDs(ctx context.Context, params *GetNfGroupIDsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetNfGroupIDs request
	GetNfGroupIDs(ctx context.Context, params *GetNfGroupIDsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

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) GetNfGroupIDsWithResponse

func (c *ClientWithResponses) GetNfGroupIDsWithResponse(ctx context.Context, params *GetNfGroupIDsParams, reqEditors ...RequestEditorFn) (*GetNfGroupIDsResponse, error)

GetNfGroupIDsWithResponse request returning *GetNfGroupIDsResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetNfGroupIDsWithResponse request
	GetNfGroupIDsWithResponse(ctx context.Context, params *GetNfGroupIDsParams, reqEditors ...RequestEditorFn) (*GetNfGroupIDsResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type GetNfGroupIDs200JSONResponse

type GetNfGroupIDs200JSONResponse NfGroupIdMapResult

func (GetNfGroupIDs200JSONResponse) VisitGetNfGroupIDsResponse

func (response GetNfGroupIDs200JSONResponse) VisitGetNfGroupIDsResponse(w http.ResponseWriter) error

type GetNfGroupIDs404ApplicationProblemPlusJSONResponse

type GetNfGroupIDs404ApplicationProblemPlusJSONResponse struct {
	externalRef0.N404ApplicationProblemPlusJSONResponse
}

func (GetNfGroupIDs404ApplicationProblemPlusJSONResponse) VisitGetNfGroupIDsResponse

func (response GetNfGroupIDs404ApplicationProblemPlusJSONResponse) VisitGetNfGroupIDsResponse(w http.ResponseWriter) error

type GetNfGroupIDsParams

type GetNfGroupIDsParams struct {
	// NfType Type of NF
	NfType []externalRef1.NFType `form:"nf-type" json:"nf-type"`

	// SubscriberId Identifier of the subscriber
	SubscriberId SubscriberId `form:"subscriberId" json:"subscriberId"`
}

GetNfGroupIDsParams defines parameters for GetNfGroupIDs.

type GetNfGroupIDsRequestObject

type GetNfGroupIDsRequestObject struct {
	Params GetNfGroupIDsParams
}

type GetNfGroupIDsResponse

type GetNfGroupIDsResponse struct {
	Body                          []byte
	HTTPResponse                  *http.Response
	JSON200                       *NfGroupIdMapResult
	ApplicationproblemJSON404     *externalRef0.N404
	ApplicationproblemJSONDefault *externalRef0.ProblemDetails
}

func ParseGetNfGroupIDsResponse

func ParseGetNfGroupIDsResponse(rsp *http.Response) (*GetNfGroupIDsResponse, error)

ParseGetNfGroupIDsResponse parses an HTTP response from a GetNfGroupIDsWithResponse call

func (GetNfGroupIDsResponse) Status

func (r GetNfGroupIDsResponse) Status() string

Status returns HTTPResponse.Status

func (GetNfGroupIDsResponse) StatusCode

func (r GetNfGroupIDsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetNfGroupIDsResponseObject

type GetNfGroupIDsResponseObject interface {
	VisitGetNfGroupIDsResponse(w http.ResponseWriter) error
}

type GetNfGroupIDsdefaultApplicationProblemPlusJSONResponse

type GetNfGroupIDsdefaultApplicationProblemPlusJSONResponse struct {
	Body       externalRef0.ProblemDetails
	StatusCode int
}

func (GetNfGroupIDsdefaultApplicationProblemPlusJSONResponse) VisitGetNfGroupIDsResponse

type GinServerOptions

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

GinServerOptions provides options for the Gin server.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type MiddlewareFunc

type MiddlewareFunc func(c *gin.Context)

type NfGroupIdMapResult

type NfGroupIdMapResult map[string]externalRef0.NfGroupId

NfGroupIdMapResult defines model for NfGroupIdMapResult.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerInterface

type ServerInterface interface {
	// Retrieves NF-Group IDs for provided Subscriber and NF types
	// (GET /nf-group-ids)
	GetNfGroupIDs(c *gin.Context, params GetNfGroupIDsParams)
}

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) GetNfGroupIDs

func (siw *ServerInterfaceWrapper) GetNfGroupIDs(c *gin.Context)

GetNfGroupIDs operation middleware

type StrictHandlerFunc

type StrictHandlerFunc = strictgin.StrictGinHandlerFunc

type StrictMiddlewareFunc

type StrictMiddlewareFunc = strictgin.StrictGinMiddlewareFunc

type StrictServerInterface

type StrictServerInterface interface {
	// Retrieves NF-Group IDs for provided Subscriber and NF types
	// (GET /nf-group-ids)
	GetNfGroupIDs(ctx context.Context, request GetNfGroupIDsRequestObject) (GetNfGroupIDsResponseObject, error)
}

StrictServerInterface represents all server handlers.

type SubscriberId

type SubscriberId = string

SubscriberId defines model for SubscriberId.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL