v0

package
v12.0.0 Latest Latest
Warning

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

 Go to latest Published: Sep 1, 2025 License: Apache-2.0 Imports: 14 Imported by: 1

Documentation

Overview

Package v0 provides access to the Akamai APIDefinitions V0 API

Package v0 provides access to the Akamai APIDefinitions V0 API

Index

Constants

View Source 
const (
	// SecuritySchemeLocationHeader holds value for http 'header' security scheme location
	SecuritySchemeLocationHeader SecuritySchemeLocation = "header"
	// SecuritySchemeLocationQuery holds value for http 'query' security scheme location
	SecuritySchemeLocationQuery SecuritySchemeLocation = "query"
	// SecuritySchemeLocationCookie holds value for http 'cookie' security scheme location
	SecuritySchemeLocationCookie SecuritySchemeLocation = "cookie"

	// ConsumeTypeJSON holds value for consume type json
	ConsumeTypeJSON ConsumeType = "json"
	// ConsumeTypeXML holds value for consume type xml
	ConsumeTypeXML ConsumeType = "xml"
	// ConsumeTypeUrlencoded holds value for consume type urlencoded
	ConsumeTypeUrlencoded ConsumeType = "urlencoded"
	// ConsumeTypeAny holds value for consume type any
	ConsumeTypeAny ConsumeType = "any"

	// ParameterTypeString holds value for string ParameterType
	ParameterTypeString ParameterType = "string"
	// ParameterTypeNumber holds value for number ParameterType
	ParameterTypeNumber ParameterType = "number"
	// ParameterTypeInteger holds value for integer ParameterType
	ParameterTypeInteger ParameterType = "integer"
	// ParameterTypeBoolean holds value for boolean ParameterType
	ParameterTypeBoolean ParameterType = "boolean"

	// ParameterLocationQuery holds value for 'query' parameter location
	ParameterLocationQuery ParameterLocation = "query"
	// ParameterLocationHeader holds value for 'header' parameter location
	ParameterLocationHeader ParameterLocation = "header"
	// ParameterLocationCookie holds value for 'cookie' parameter location
	ParameterLocationCookie ParameterLocation = "cookie"
	// ParameterLocationPath holds value for 'path' parameter location
	ParameterLocationPath ParameterLocation = "path"

	// PropertyTypeObject holds value for boolean PropertyType
	PropertyTypeObject PropertyType = "object"
	// PropertyTypeArray holds value for boolean PropertyType
	PropertyTypeArray PropertyType = "array"

	// MaxBodySizeSize6KB represents MaxBodySize of value "6KB"
	MaxBodySizeSize6KB MaxBodySize = "6KB"
	// MaxBodySizeSize8KB represents MaxBodySize of value "8KB"
	MaxBodySizeSize8KB MaxBodySize = "8KB"
	// MaxBodySizeSize12KB represents MaxBodySize of value "12KB"
	MaxBodySizeSize12KB MaxBodySize = "12KB"
	// MaxBodySizeSize16kB represents MaxBodySize of value "16KB"
	MaxBodySizeSize16kB MaxBodySize = "16KB"

	// VersioningLocationHeader holds value for versioning location 'header'
	VersioningLocationHeader VersioningLocation = "header"
	// VersioningLocationPath holds value for versioning location 'path'
	VersioningLocationPath VersioningLocation = "path"
	// VersioningLocationQuery holds value for versioning location 'query'
	VersioningLocationQuery VersioningLocation = "query"
)

Variables

View Source 
var (
	// ErrRegisterAPI is returned when GetAPIVersion fails
	ErrRegisterAPI = errors.New("register API")
	// ErrGetAPIVersion is returned when GetEndpointVersion fails
	ErrGetAPIVersion = errors.New("get API version")
	// ErrUpdateAPIVersion is returned when UpdateEndpointVersion fails
	ErrUpdateAPIVersion = errors.New("update API version")
	// ErrFromOpenAPIFile is returned when FromOpenAPIFile fails
	ErrFromOpenAPIFile = errors.New("mapping openapi file")
	// ErrToOpenAPIFile is returned when ErrToOpenAPIFile fails
	ErrToOpenAPIFile = errors.New("to openapi file")
	// ErrStructValidation is returned when given struct validation failed
	ErrStructValidation = errors.New("struct validation")
)
View Source 
var (
	// ErrGetResourceOperation is returned when GetResourceOperation fails
	ErrGetResourceOperation = errors.New("get resource operations")
	// ErrUpdateResourceOperation is returned when UpdateResourceOperation fails
	ErrUpdateResourceOperation = errors.New("update resource operations")
	// ErrDeleteResourceOperation is returned when DeleteResourceOperation fails
	ErrDeleteResourceOperation = errors.New("delete resource operations")
)

Functions

This section is empty.

Types

type API 

type API struct {
	RegisterAPIRequest
	ID            *int64 `json:"id,omitempty"`
	RecordVersion *int64 `json:"recordVersion,omitempty"`
}

API holds configuration for an API

func (API) Validate 

func (r API) Validate() error

Validate validates API

type APIAttributes 

type APIAttributes struct {
	Name                      string                                   `json:"name"`
	Hostnames                 []string                                 `json:"hostnames"`
	BasePath                  *string                                  `json:"basePath,omitempty"`
	Tags                      []string                                 `json:"tags,omitempty"`
	Description               *string                                  `json:"description,omitempty"`
	MatchPathSegmentParameter bool                                     `json:"matchPathSegmentParameter,omitempty"`
	MatchCaseSensitive        bool                                     `json:"matchCaseSensitive,omitempty"`
	EnableAPIGateway          bool                                     `json:"enableApiGateway,omitempty"`
	GraphQL                   bool                                     `json:"graphQl,omitempty"`
	SecuritySchemes           *SecuritySchemes                         `json:"securitySchemes,omitempty"`
	Constraints               *Constraints                             `json:"constraints,omitempty"`
	Versioning                *Versioning                              `json:"versioning,omitempty"`
	Resources                 *orderedmap.OrderedMap[string, Resource] `json:"resources,omitempty"`
}

APIAttributes hold information about API (without contract and group)

type APIDefinitions 

type APIDefinitions interface {
	// RegisterAPI creates the first version of an API endpoint configuration
	RegisterAPI(context.Context, RegisterAPIRequest) (*RegisterAPIResponse, error)
	// GetAPIVersion returns an API version. Use this operation's response object when modifying an endpoint version through Edit a version.
	GetAPIVersion(context.Context, GetAPIVersionRequest) (*GetAPIVersionResponse, error)
	// UpdateAPIVersion updates details about an API version that has never been activated on the staging or production network.
	UpdateAPIVersion(context.Context, UpdateAPIVersionRequest) (*UpdateAPIVersionResponse, error)
	// FromOpenAPIFile map OpenAPI file to API
	FromOpenAPIFile(context.Context, FromOpenAPIFileRequest) (*FromOpenAPIFileResponse, error)
	// ToOpenAPIFile map API to OpenAPI
	ToOpenAPIFile(context.Context, ToOpenAPIFileRequest) (*ToOpenAPIFileResponse, error)
	// GetResourceOperation reads resource operations for a particular endpoint
	GetResourceOperation(context.Context, GetResourceOperationRequest) (*GetResourceOperationResponse, error)
	// UpdateResourceOperation updates resource operations for a particular endpoint
	UpdateResourceOperation(context.Context, UpdateResourceOperationRequest) (*UpdateResourceOperationResponse, error)
	// DeleteResourceOperation deletes resource operations for a particular endpoint
	DeleteResourceOperation(context.Context, DeleteResourceOperationRequest) (*DeleteResourceOperationResponse, error)
}

APIDefinitions is the api definitions api interface

func Client 

func Client(sess session.Session, opts ...Option) APIDefinitions

Client returns a new apidefinitions Client instance with the specified controller

type ClientFunc 

type ClientFunc func(sess session.Session, opts ...Option) APIDefinitions

ClientFunc is an apidefinitions client new method, this can be used for mocking

type Constraints 

type Constraints struct {
	EnforceOn   *EnforceOn              `json:"enforceOn,omitempty"`
	RequestBody *ConstraintsRequestBody `json:"requestBody,omitempty"`
}

Constraints holds configuration for Constraints

func (Constraints) Validate 

func (c Constraints) Validate() error

Validate validates Constraints

type ConstraintsRequestBody 

type ConstraintsRequestBody struct {
	ConsumeType     []ConsumeType                     `json:"consumeType,omitempty"`
	MaxBodySize     *int64                            `json:"maxContentLength,omitempty"`
	MaxNestingDepth *int64                            `json:"maxNestingDepth,omitempty"`
	Properties      *ConstraintsRequestBodyProperties `json:"properties,omitempty"`
}

ConstraintsRequestBody holds configuration for Constraints

func (ConstraintsRequestBody) Validate 

func (c ConstraintsRequestBody) Validate() error

Validate validates ConstraintsRequestBody

type ConstraintsRequestBodyProperties 

type ConstraintsRequestBodyProperties struct {
	MaxStringLength *int64 `json:"maxStringLength,omitempty"`
	MaxIntegerValue *int64 `json:"maxIntegerValue,omitempty"`
	MaxCount        *int64 `json:"maxCount,omitempty"`
	MaxNameLength   *int64 `json:"maxNameLength,omitempty"`
}

ConstraintsRequestBodyProperties holds configuration for Constraints

type ConsumeType 

type ConsumeType string

ConsumeType content type the endpoint exchanges

func (ConsumeType) Validate 

func (s ConsumeType) Validate() error

Validate validates ConsumeType

type DeleteResourceOperationRequest 

type DeleteResourceOperationRequest struct {
	VersionNumber int64
	APIID         int64
}

DeleteResourceOperationRequest contains parameters for DeleteResourceOperation method

func (DeleteResourceOperationRequest) Validate 

func (r DeleteResourceOperationRequest) Validate() error

Validate validates DeleteResourceOperationRequest

type DeleteResourceOperationResponse 

type DeleteResourceOperationResponse struct {
	APIID         int64  `json:"apiEndpointId,omitempty"`
	VersionNumber int64  `json:"versionNumber,omitempty"`
	Status        int64  `json:"status,omitempty"`
	Detail        string `json:"detail,omitempty"`
}

DeleteResourceOperationResponse contains parameters for DeleteResourceOperation method

type EnforceOn 

type EnforceOn struct {
	Request             *bool                `json:"request,omitempty"`
	Response            *bool                `json:"response,omitempty"`
	UndefinedMethods    *UndefinedMethods    `json:"undefinedMethods,omitempty"`
	UndefinedParameters *UndefinedParameters `json:"undefinedParameters,omitempty"`
}

EnforceOn holds configuration for Constraints enforcement

func (EnforceOn) Validate 

func (b EnforceOn) Validate() error

Validate validates EnforceOn

type Error 

type Error struct {
	Type            string       `json:"type"`
	Title           string       `json:"title"`
	Detail          string       `json:"detail"`
	Instance        string       `json:"instance,omitempty"`
	Status          int64        `json:"status,omitempty"`
	RequestInstance *string      `json:"requestInstance,omitempty"`
	Method          *string      `json:"method,omitempty"`
	RequestTime     *string      `json:"requestTime,omitempty"`
	BehaviorName    *string      `json:"behaviorName,omitempty"`
	ErrorLocation   *string      `json:"errorLocation,omitempty"`
	DomainPrefix    *string      `json:"domainPrefix,omitempty"`
	DomainSuffix    *string      `json:"domainSuffix,omitempty"`
	Severity        *string      `json:"severity,omitempty"`
	Field           *string      `json:"field,omitempty"`
	RejectedValue   *interface{} `json:"rejectedValue,omitempty"`
	AuthzRealm      *string      `json:"authzRealm,omitempty"`
	ServerIP        *string      `json:"serverIp,omitempty"`
	ClientIP        *string      `json:"clientIp,omitempty"`
	RequestID       *string      `json:"requestId,omitempty"`
	Network         *string      `json:"network,omitempty"`
	VersionNumber   *int64       `json:"versionNumber,omitempty"`
	EndpointID      *int64       `json:"endpointId,omitempty"`
	EndpointName    *string      `json:"endpointName,omitempty"`
	Errors          []Error      `json:"errors,omitempty"`
}

Error is an apidefinitions error interface

func (*Error) Error 

func (e *Error) Error() string

func (*Error) Is 

func (e *Error) Is(target error) bool

Is handles error comparisons

type FromOpenAPIFileRequest 

type FromOpenAPIFileRequest struct {
	Content  []byte
	RootFile *string
}

FromOpenAPIFileRequest contains body for FromOpenAPIFile operation

type FromOpenAPIFileResponse 

type FromOpenAPIFileResponse struct {
	Problems []Error       `json:"problems"`
	API      APIAttributes `json:"api"`
}

FromOpenAPIFileResponse holds the response for FromOpenAPIFile operation

type GetAPIVersionRequest 

type GetAPIVersionRequest struct {
	Version int64
	ID      int64
}

GetAPIVersionRequest contains parameters for GetAPIVersion method

func (GetAPIVersionRequest) Validate 

func (r GetAPIVersionRequest) Validate() error

Validate validates GetAPIVersionRequest

type GetAPIVersionResponse 

type GetAPIVersionResponse API

GetAPIVersionResponse holds the response from GetAPIVersion operation

type GetResourceOperationRequest 

type GetResourceOperationRequest struct {
	VersionNumber int64
	APIID         int64
}

GetResourceOperationRequest contains parameters for GetResourceOperation method

func (GetResourceOperationRequest) Validate 

func (r GetResourceOperationRequest) Validate() error

Validate validates GetResourceOperationRequest

type GetResourceOperationResponse 

type GetResourceOperationResponse ResourceOperationResponse

GetResourceOperationResponse holds response parameter for GetResourceOperation method

type Items 

type Items struct {
	Type       PropertyType `json:"type"`
	Required   bool         `json:"required,omitempty"`
	Minimum    *float32     `json:"minimum,omitempty"`
	Maximum    *float32     `json:"maximum,omitempty"`
	MinLength  *int64       `json:"minLength,omitempty"`
	MaxLength  *int64       `json:"maxLength,omitempty"`
	MinItems   *int64       `json:"minItems,omitempty"`
	MaxItems   *int64       `json:"maxItems,omitempty"`
	Properties []Property   `json:"properties,omitempty"`
}

Items holds configuration for an Array Property Items

func (Items) Validate 

func (p Items) Validate() error

Validate validates Items

type MaxBodySize 

type MaxBodySize string

MaxBodySize represents MaxBodySize value

func (MaxBodySize) Validate 

func (b MaxBodySize) Validate() error

Validate validates MaxBodySize

type Method 

type Method struct {
	Parameters  []Parameter                              `json:"parameters,omitempty"`
	RequestBody *orderedmap.OrderedMap[string, Property] `json:"requestBody,omitempty"`
	Responses   *Responses                               `json:"responses,omitempty"`
	Constraints *MethodConstraints                       `json:"constraints,omitempty"`
}

Method holds configuration for an API Method

func (Method) Validate 

func (m Method) Validate() error

Validate validates Method

type MethodConstraints 

type MethodConstraints struct {
	EnforceOn *MethodEnforceOn `json:"enforceOn,omitempty"`
}

MethodConstraints holds configuration for Method Constraints

type MethodEnforceOn 

type MethodEnforceOn struct {
	UndefinedParameters *UndefinedParameters `json:"undefinedParameters,omitempty"`
}

MethodEnforceOn holds configuration for Method Constraints

type Mock 

type Mock struct {
	mock.Mock
}

func (*Mock) DeleteResourceOperation 

func (m *Mock) DeleteResourceOperation(ctx context.Context, req DeleteResourceOperationRequest) (*DeleteResourceOperationResponse, error)

func (*Mock) FromOpenAPIFile 

func (m *Mock) FromOpenAPIFile(ctx context.Context, body FromOpenAPIFileRequest) (*FromOpenAPIFileResponse, error)

func (*Mock) GetAPIVersion 

func (m *Mock) GetAPIVersion(ctx context.Context, request GetAPIVersionRequest) (*GetAPIVersionResponse, error)

func (*Mock) GetResourceOperation 

func (m *Mock) GetResourceOperation(ctx context.Context, req GetResourceOperationRequest) (*GetResourceOperationResponse, error)

func (*Mock) RegisterAPI 

func (m *Mock) RegisterAPI(ctx context.Context, request RegisterAPIRequest) (*RegisterAPIResponse, error)

func (*Mock) ToOpenAPIFile 

func (m *Mock) ToOpenAPIFile(ctx context.Context, request ToOpenAPIFileRequest) (*ToOpenAPIFileResponse, error)

func (*Mock) UpdateAPIVersion 

func (m *Mock) UpdateAPIVersion(ctx context.Context, request UpdateAPIVersionRequest) (*UpdateAPIVersionResponse, error)

func (*Mock) UpdateResourceOperation 

func (m *Mock) UpdateResourceOperation(ctx context.Context, req UpdateResourceOperationRequest) (*UpdateResourceOperationResponse, error)

type Operation 

type Operation struct {
	Method                *string                                            `json:"method"`
	Purpose               *string                                            `json:"purpose"`
	MultistepGroupName    *string                                            `json:"multistepGroupName,omitempty"`
	Parameters            *orderedmap.OrderedMap[string, OperationParameter] `json:"parameters,omitempty"`
	Conditions            []ParameterPathCondition                           `json:"conditions,omitempty"`
	FailureConditions     []OperationCondition                               `json:"failureConditions,omitempty"`
	SuccessConditions     []OperationCondition                               `json:"successConditions,omitempty"`
	StepSuccessConditions []OperationCondition                               `json:"stepSuccessConditions,omitempty"`
	OriginUserIDCondition *OperationCondition                                `json:"originUserIdCondition,omitempty"`
}

Operation represents single resource operation

type OperationCondition 

type OperationCondition struct {
	HeaderName                 *string  `json:"headerName,omitempty"`
	PositiveMatch              *bool    `json:"positiveMatch,omitempty"`
	SuppressFromClientResponse *bool    `json:"suppressFromClientResponse,omitempty"`
	Type                       *string  `json:"type,omitempty"`
	ValueCase                  *bool    `json:"valueCase,omitempty"`
	ValueWildcard              *bool    `json:"valueWildcard,omitempty"`
	Path                       *string  `json:"xPath,omitempty"`
	Values                     []string `json:"values,omitempty"`
}

OperationCondition represents condition data for a resource operation

type OperationParameter 

type OperationParameter struct {
	Path                       []string `json:"path,omitempty"`
	Location                   *string  `json:"location,omitempty"`
	ReferenceParameterLocation *string  `json:"referenceParameterLocation,omitempty"`
	UsedForLogin               *bool    `json:"usedForLogin,omitempty"`
}

OperationParameter parameter details

type Option 

type Option func(*apidefinitions)

Option defines a api definition option

type Parameter 

type Parameter struct {
	Name        string            `json:"name"`
	Type        ParameterType     `json:"type"`
	In          ParameterLocation `json:"in,omitempty"`
	Required    bool              `json:"required,omitempty"`
	Description *string           `json:"description,omitempty"`
	Minimum     *float32          `json:"minimum,omitempty"`
	Maximum     *float32          `json:"maximum,omitempty"`
	MinLength   *int64            `json:"minLength,omitempty"`
	MaxLength   *int64            `json:"maxLength,omitempty"`
}

Parameter holds configuration for an API Parameter

func (Parameter) Validate 

func (p Parameter) Validate() error

Validate validates Parameter

type ParameterLocation 

type ParameterLocation string

ParameterLocation location of the parameter

func (ParameterLocation) Validate 

func (t ParameterLocation) Validate() error

Validate validates ParameterLocation

type ParameterPathCondition 

type ParameterPathCondition struct {
	Path          []string `json:"path,omitempty"`
	Location      *string  `json:"location,omitempty"`
	PositiveMatch *bool    `json:"positiveMatch,omitempty"`
	Values        []string `json:"values,omitempty"`
}

ParameterPathCondition represents condition for parameter path

type ParameterType 

type ParameterType string

ParameterType type of the parameter

func (ParameterType) Validate 

func (t ParameterType) Validate() error

Validate validates ParameterType

type Property 

type Property struct {
	Name        string       `json:"name"`
	Type        PropertyType `json:"type"`
	Required    bool         `json:"required,omitempty"`
	Description *string      `json:"description,omitempty"`
	Minimum     *float32     `json:"minimum,omitempty"`
	Maximum     *float32     `json:"maximum,omitempty"`
	MinLength   *int64       `json:"minLength,omitempty"`
	MaxLength   *int64       `json:"maxLength,omitempty"`
	MinItems    *int64       `json:"minItems,omitempty"`
	MaxItems    *int64       `json:"maxItems,omitempty"`
	MaxBodySize *MaxBodySize `json:"maxBodySize,omitempty"`
	Properties  []Property   `json:"properties,omitempty"`
	Items       *Items       `json:"items,omitempty"`
	XML         *XML         `json:"xml,omitempty"`
}

Property holds configuration for an API Property

func (Property) Validate 

func (p Property) Validate() error

Validate validates Property

type PropertyType 

type PropertyType ParameterType

PropertyType type of the property

func (PropertyType) Validate 

func (t PropertyType) Validate() error

Validate validates PropertyType

type RegisterAPIRequest 

type RegisterAPIRequest struct {
	APIAttributes
	ContractID string `json:"contractId"`
	GroupID    int64  `json:"groupId"`
}

RegisterAPIRequest contains body for RegisterAPI operation

func (RegisterAPIRequest) Validate 

func (r RegisterAPIRequest) Validate() error

Validate validates RegisterAPIRequest

type RegisterAPIResponse 

type RegisterAPIResponse API

RegisterAPIResponse holds the response from RegisterAPI operation

type Resource 

type Resource struct {
	Name        string  `json:"name"`
	Description *string `json:"description,omitempty"`
	Get         *Method `json:"get,omitempty"`
	Post        *Method `json:"post,omitempty"`
	Put         *Method `json:"put,omitempty"`
	Delete      *Method `json:"delete,omitempty"`
	Options     *Method `json:"options,omitempty"`
	Head        *Method `json:"head,omitempty"`
	Patch       *Method `json:"patch,omitempty"`
}

Resource holds configuration for an API Resource

func (Resource) Validate 

func (r Resource) Validate() error

Validate validates Resource

type ResourceOperationResponse 

type ResourceOperationResponse struct {
	ResourceOperations *orderedmap.OrderedMap[string, *orderedmap.OrderedMap[string, Operation]] `json:"operations"`
}

ResourceOperationResponse holds the response for all Operation methods

type ResourceOperationsRequestBody 

type ResourceOperationsRequestBody ResourceOperationResponse

ResourceOperationsRequestBody holds request body parameter for UpdateResourceOperationRequest method

type ResponseContent 

type ResponseContent struct {
	StatusCodes []int64   `json:"statusCodes,omitempty"`
	JSON        *Property `json:"json,omitempty"`
	GraphQL     *Property `json:"graphql,omitempty"`
	XML         *Property `json:"xml,omitempty"`
	URLEncoded  *Property `json:"urlencoded,omitempty"`
	JSONXML     *Property `json:"json/xml,omitempty"`
	Any         *Property `json:"any,omitempty"`
	None        *Property `json:"none,omitempty"`
}

ResponseContent holds configuration for an API Response

func (ResponseContent) Validate 

func (p ResponseContent) Validate() error

Validate validates ResponseContent

type Responses 

type Responses struct {
	Headers  []Parameter       `json:"headers,omitempty"`
	Contents []ResponseContent `json:"contents,omitempty"`
}

Responses holds configuration for an API Responses

func (Responses) Validate 

func (p Responses) Validate() error

Validate validates Responses

type SecurityScheme 

type SecurityScheme struct {
	In   *SecuritySchemeLocation `json:"in,omitempty"`
	Name *string                 `json:"name,omitempty"`
}

SecurityScheme holds configuration for Security Scheme

func (SecurityScheme) Validate 

func (v SecurityScheme) Validate() error

Validate validates SecurityScheme

type SecuritySchemeLocation 

type SecuritySchemeLocation string

SecuritySchemeLocation holds location of the SecurityScheme

func (SecuritySchemeLocation) Validate 

func (s SecuritySchemeLocation) Validate() error

Validate validates SecuritySchemeLocation

type SecuritySchemes 

type SecuritySchemes struct {
	APIKey *SecurityScheme `json:"apiKey,omitempty"`
}

SecuritySchemes holds configuration for Security Schemes

func (SecuritySchemes) Validate 

func (v SecuritySchemes) Validate() error

Validate validates SecuritySchemes

type ToOpenAPIFileRequest 

type ToOpenAPIFileRequest GetAPIVersionRequest

ToOpenAPIFileRequest contains parameters for ToOpenAPIFile method

type ToOpenAPIFileResponse 

type ToOpenAPIFileResponse string

ToOpenAPIFileResponse holds the response from ToOpenAPIFile operation

type UndefinedMethods 

type UndefinedMethods struct {
	Get     bool `json:"get,omitempty"`
	Post    bool `json:"post,omitempty"`
	Put     bool `json:"put,omitempty"`
	Head    bool `json:"head,omitempty"`
	Options bool `json:"options,omitempty"`
	Delete  bool `json:"delete,omitempty"`
	Patch   bool `json:"patch,omitempty"`
}

UndefinedMethods hold configuration for undefined method Constraints enforcement

type UndefinedParameters 

type UndefinedParameters struct {
	RequestCookie  bool `json:"requestCookie,omitempty"`
	RequestHeader  bool `json:"requestHeader,omitempty"`
	RequestQuery   bool `json:"requestQuery,omitempty"`
	RequestBody    bool `json:"requestBody,omitempty"`
	ResponseHeader bool `json:"responseHeader,omitempty"`
	ResponseBody   bool `json:"responseBody,omitempty"`
}

UndefinedParameters hold configuration for undefined parameters Constraints enforcement

type UpdateAPIVersionRequest 

type UpdateAPIVersionRequest struct {
	ID      int64
	Version int64
	Body    UpdateAPIVersionRequestBody
}

UpdateAPIVersionRequest contains parameters for UpdateEndpointVersion method

func (UpdateAPIVersionRequest) Validate 

func (r UpdateAPIVersionRequest) Validate() interface{}

Validate validates UpdateAPIVersionRequest

type UpdateAPIVersionRequestBody 

type UpdateAPIVersionRequestBody API

UpdateAPIVersionRequestBody contains body for UpdateAPIVersion operation

type UpdateAPIVersionResponse 

type UpdateAPIVersionResponse API

UpdateAPIVersionResponse holds the response from UpdateAPIVersion operation

type UpdateResourceOperationRequest 

type UpdateResourceOperationRequest struct {
	VersionNumber int64
	APIID         int64
	Body          ResourceOperationsRequestBody
}

UpdateResourceOperationRequest contains parameters for UpdateResourceOperation method

func (UpdateResourceOperationRequest) Validate 

func (u UpdateResourceOperationRequest) Validate() error

Validate validates UpdateResourceOperationRequest

type UpdateResourceOperationResponse 

type UpdateResourceOperationResponse ResourceOperationResponse

UpdateResourceOperationResponse holds response parameter for UpdateResourceOperation method

type Versioning 

type Versioning struct {
	In    *VersioningLocation `json:"in,omitempty"`
	Name  *string             `json:"name,omitempty"`
	Value *string             `json:"value,omitempty"`
}

Versioning holds configuration for Versioning configuration

func (Versioning) Validate 

func (v Versioning) Validate() error

Validate validates Versioning

type VersioningLocation 

type VersioningLocation string

VersioningLocation holds location of the version

func (VersioningLocation) Validate 

func (s VersioningLocation) Validate() error

Validate validates ConsumeType

type XML 

type XML struct {
	Name      *string `json:"name,omitempty"`
	Namespace *string `json:"namespace,omitempty"`
	Prefix    *string `json:"prefix,omitempty"`
	Attribute *bool   `json:"attribute,omitempty"`
	Wrapped   *bool   `json:"wrapped,omitempty"`
}

XML holds configuration about an XML representation of property

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.