openapi

package
v0.0.11 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2024 License: GPL-3.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemaDataType_name = map[int32]string{
		0: "UNKNOWN",
		1: "ARRAY",
		2: "BOOLEAN",
		3: "INTEGER",
		4: "NULL",
		5: "NUMBER",
		6: "OBJECT",
		7: "STRING",
	}
	SchemaDataType_value = map[string]int32{
		"UNKNOWN": 0,
		"ARRAY":   1,
		"BOOLEAN": 2,
		"INTEGER": 3,
		"NULL":    4,
		"NUMBER":  5,
		"OBJECT":  6,
		"STRING":  7,
	}
)

Enum value maps for SchemaDataType.

View Source 
var File_meshapi_gateway_openapi_openapi_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Components 

type Components struct {
	Schemas         map[string]*Schema         `` /* 155-byte string literal not displayed */
	Responses       map[string]*Response       `` /* 159-byte string literal not displayed */
	Parameters      map[string]*Parameter      `` /* 161-byte string literal not displayed */
	Examples        map[string]*Example        `` /* 157-byte string literal not displayed */
	RequestBodies   map[string]*RequestBody    `` /* 188-byte string literal not displayed */
	Headers         map[string]*Header         `` /* 155-byte string literal not displayed */
	SecuritySchemes map[string]*SecurityScheme `` /* 194-byte string literal not displayed */
	Links           map[string]*Link           `` /* 151-byte string literal not displayed */
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.

See: https://spec.openapis.org/oas/latest.html#components-object

func (*Components) Descriptor deprecated 

func (*Components) Descriptor() ([]byte, []int)

Deprecated: Use Components.ProtoReflect.Descriptor instead.

func (*Components) GetExamples 

func (x *Components) GetExamples() map[string]*Example

func (*Components) GetExtensions 

func (x *Components) GetExtensions() map[string]*structpb.Value

func (*Components) GetHeaders 

func (x *Components) GetHeaders() map[string]*Header
func (x *Components) GetLinks() map[string]*Link

func (*Components) GetParameters 

func (x *Components) GetParameters() map[string]*Parameter

func (*Components) GetRequestBodies 

func (x *Components) GetRequestBodies() map[string]*RequestBody

func (*Components) GetResponses 

func (x *Components) GetResponses() map[string]*Response

func (*Components) GetSchemas 

func (x *Components) GetSchemas() map[string]*Schema

func (*Components) GetSecuritySchemes 

func (x *Components) GetSecuritySchemes() map[string]*SecurityScheme

func (*Components) ProtoMessage 

func (*Components) ProtoMessage()

func (*Components) ProtoReflect 

func (x *Components) ProtoReflect() protoreflect.Message

func (*Components) Reset 

func (x *Components) Reset()

func (*Components) String 

func (x *Components) String() string

type Contact 

type Contact struct {

	// The identifying name of the contact person/organization.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The URL pointing to the contact information. This MUST be in the form of a URL.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// The email address of the contact person/organization. This MUST be in the form of an email address.
	Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Contact information for the exposed API.

See: https://spec.openapis.org/oas/v3.1.0#contact-object

func (*Contact) Descriptor deprecated 

func (*Contact) Descriptor() ([]byte, []int)

Deprecated: Use Contact.ProtoReflect.Descriptor instead.

func (*Contact) GetEmail 

func (x *Contact) GetEmail() string

func (*Contact) GetExtensions 

func (x *Contact) GetExtensions() map[string]*structpb.Value

func (*Contact) GetName 

func (x *Contact) GetName() string

func (*Contact) GetUrl 

func (x *Contact) GetUrl() string

func (*Contact) ProtoMessage 

func (*Contact) ProtoMessage()

func (*Contact) ProtoReflect 

func (x *Contact) ProtoReflect() protoreflect.Message

func (*Contact) Reset 

func (x *Contact) Reset()

func (*Contact) String 

func (x *Contact) String() string

type Discriminator 

type Discriminator struct {

	// REQUIRED. The name of the property in the payload that will hold the discriminator value.
	PropertyName string `protobuf:"bytes,1,opt,name=property_name,json=propertyName,proto3" json:"property_name,omitempty"`
	// An object to hold mappings between payload values and schema names or references.
	Mapping map[string]string `` /* 155-byte string literal not displayed */
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

See: https://spec.openapis.org/oas/latest.html#discriminator-object

func (*Discriminator) Descriptor deprecated 

func (*Discriminator) Descriptor() ([]byte, []int)

Deprecated: Use Discriminator.ProtoReflect.Descriptor instead.

func (*Discriminator) GetExtensions 

func (x *Discriminator) GetExtensions() map[string]*structpb.Value

func (*Discriminator) GetMapping 

func (x *Discriminator) GetMapping() map[string]string

func (*Discriminator) GetPropertyName 

func (x *Discriminator) GetPropertyName() string

func (*Discriminator) ProtoMessage 

func (*Discriminator) ProtoMessage()

func (*Discriminator) ProtoReflect 

func (x *Discriminator) ProtoReflect() protoreflect.Message

func (*Discriminator) Reset 

func (x *Discriminator) Reset()

func (*Discriminator) String 

func (x *Discriminator) String() string

type Document 

type Document struct {

	// REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
	// NOTE: A generated value will be used for the required fields if they are left empty.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#info-object
	Info *Info `protobuf:"bytes,1,opt,name=info,proto3" json:"info,omitempty"`
	// An array of Server Objects, which provide connectivity information to a target server.
	// If the servers property is not provided, or is an empty array,
	// the default value would be a Server Object with a url value of /.
	//
	// See: https://spec.openapis.org/oas/latest.html#server-object
	Servers []*Server `protobuf:"bytes,2,rep,name=servers,proto3" json:"servers,omitempty"`
	// Holds a set of reusable objects for different aspects of the OAS. All objects defined within the
	// components object will have no effect on the API unless they are explicitly referenced from properties
	// outside the components object.
	//
	// See: https://spec.openapis.org/oas/latest.html#components-object
	Components *Components `protobuf:"bytes,5,opt,name=components,proto3" json:"components,omitempty"`
	// A declaration of which security mechanisms can be used across the API. The list of values includes
	// alternative security requirement objects that can be used. Only one of the security requirement objects
	// need to be satisfied to authorize a request. Individual operations can override this definition. To make
	// security optional, an empty security requirement ({}) can be included in the array.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#security-requirement-object
	Security []*SecurityRequirement `protobuf:"bytes,6,rep,name=security,proto3" json:"security,omitempty"`
	// A list of tags used by the document with additional metadata. The order of the tags can be used to
	// reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must
	// be declared. The tags that are not declared MAY be organized randomly or based on the tools’ logic.
	// Each tag name in the list MUST be unique.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#tag-object
	Tags []*Tag `protobuf:"bytes,7,rep,name=tags,proto3" json:"tags,omitempty"`
	// Additional external documentation.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
	ExternalDocs *ExternalDocumentation `protobuf:"bytes,8,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// DocumentConfiguration is used to change the behavior of documentation generation such as default responses.
	Config *DocumentConfiguration `protobuf:"bytes,10,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

This is the root object of the OpenAPI document. See: https://spec.openapis.org/oas/v3.1.0#openapi-object

func (*Document) Descriptor deprecated 

func (*Document) Descriptor() ([]byte, []int)

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetComponents 

func (x *Document) GetComponents() *Components

func (*Document) GetConfig 

func (x *Document) GetConfig() *DocumentConfiguration

func (*Document) GetExtensions 

func (x *Document) GetExtensions() map[string]*structpb.Value

func (*Document) GetExternalDocs 

func (x *Document) GetExternalDocs() *ExternalDocumentation

func (*Document) GetInfo 

func (x *Document) GetInfo() *Info

func (*Document) GetSecurity 

func (x *Document) GetSecurity() []*SecurityRequirement

func (*Document) GetServers 

func (x *Document) GetServers() []*Server

func (*Document) GetTags 

func (x *Document) GetTags() []*Tag

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

func (x *Document) ProtoReflect() protoreflect.Message

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type DocumentConfiguration 

type DocumentConfiguration struct {

	// default_responses is used to control the default responses generated in this OpenAPI document.
	DefaultResponses map[string]*Response `` /* 197-byte string literal not displayed */
	// contains filtered or unexported fields
}

DocumentConfiguration allows for controlling the default responses

func (*DocumentConfiguration) Descriptor deprecated 

func (*DocumentConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use DocumentConfiguration.ProtoReflect.Descriptor instead.

func (*DocumentConfiguration) GetDefaultResponses 

func (x *DocumentConfiguration) GetDefaultResponses() map[string]*Response

func (*DocumentConfiguration) ProtoMessage 

func (*DocumentConfiguration) ProtoMessage()

func (*DocumentConfiguration) ProtoReflect 

func (x *DocumentConfiguration) ProtoReflect() protoreflect.Message

func (*DocumentConfiguration) Reset 

func (x *DocumentConfiguration) Reset()

func (*DocumentConfiguration) String 

func (x *DocumentConfiguration) String() string

type Encoding 

type Encoding struct {

	// The Content-Type for encoding a specific property. Default value depends on the property type:
	// for object - application/json;
	// for array – the default is defined based on the inner type;
	// for all other cases the default is application/octet-stream.
	// The value can be a specific media type (e.g. application/json),
	// a wildcard media type (e.g. image/*), or a comma-separated list of the two types.
	ContentType string `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// A map allowing additional information to be provided as headers, for example Content-Disposition.
	// Content-Type is described separately and SHALL be ignored in this section.
	// This property SHALL be ignored if the request body media type is not a multipart.
	Headers map[string]*Header `` /* 155-byte string literal not displayed */
	// Describes how a specific property value will be serialized depending on its type.
	// See Parameter Object for details on the style property. The behavior follows the same values as query parameters,
	// including default values. This property SHALL be ignored if the request body media type is not
	// application/x-www-form-urlencoded or multipart/form-data.
	// If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.
	Style string `protobuf:"bytes,3,opt,name=style,proto3" json:"style,omitempty"`
	// When this is true, property values of type array or object generate separate parameters for each value of
	// the array, or key-value-pair of the map. For other types of properties this property has no effect.
	// When style is form, the default value is true. For all other styles, the default value is false.
	// This property SHALL be ignored if the request body media type is not
	// application/x-www-form-urlencoded or multipart/form-data.
	// If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.
	Explode bool `protobuf:"varint,4,opt,name=explode,proto3" json:"explode,omitempty"`
	// Determines whether the parameter value SHOULD allow reserved characters,
	// as defined by [RFC3986] :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.
	// This property SHALL be ignored if the request body media type is not
	// application/x-www-form-urlencoded or multipart/form-data.
	// If a value is explicitly defined, then the value of contentType (implicit or explicit) SHALL be ignored.
	AllowReserved bool `protobuf:"varint,5,opt,name=allow_reserved,json=allowReserved,proto3" json:"allow_reserved,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

A single encoding definition applied to a single schema property.

See: https://spec.openapis.org/oas/latest.html#encoding-object

func (*Encoding) Descriptor deprecated 

func (*Encoding) Descriptor() ([]byte, []int)

Deprecated: Use Encoding.ProtoReflect.Descriptor instead.

func (*Encoding) GetAllowReserved 

func (x *Encoding) GetAllowReserved() bool

func (*Encoding) GetContentType 

func (x *Encoding) GetContentType() string

func (*Encoding) GetExplode 

func (x *Encoding) GetExplode() bool

func (*Encoding) GetExtensions 

func (x *Encoding) GetExtensions() map[string]*structpb.Value

func (*Encoding) GetHeaders 

func (x *Encoding) GetHeaders() map[string]*Header

func (*Encoding) GetStyle 

func (x *Encoding) GetStyle() string

func (*Encoding) ProtoMessage 

func (*Encoding) ProtoMessage()

func (*Encoding) ProtoReflect 

func (x *Encoding) ProtoReflect() protoreflect.Message

func (*Encoding) Reset 

func (x *Encoding) Reset()

func (*Encoding) String 

func (x *Encoding) String() string

type Example 

type Example struct {

	// ref is a reference to an existing example object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// Short description for the example.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// Long description for the example. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Embedded literal example. The value field and externalValue field are mutually exclusive.
	// To represent examples of media types that cannot naturally represented in JSON or YAML,
	// use a string value to contain the example, escaping where necessary.
	Value *structpb.Value `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// A URI that points to the literal example. This provides the capability to reference examples that cannot easily
	// be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.
	// See the rules for resolving Relative References.
	ExternalValue string `protobuf:"bytes,5,opt,name=external_value,json=externalValue,proto3" json:"external_value,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

See: https://spec.openapis.org/oas/latest.html#example-object

func (*Example) Descriptor deprecated 

func (*Example) Descriptor() ([]byte, []int)

Deprecated: Use Example.ProtoReflect.Descriptor instead.

func (*Example) GetDescription 

func (x *Example) GetDescription() string

func (*Example) GetExtensions 

func (x *Example) GetExtensions() map[string]*structpb.Value

func (*Example) GetExternalValue 

func (x *Example) GetExternalValue() string

func (*Example) GetRef 

func (x *Example) GetRef() *Reference

func (*Example) GetSummary 

func (x *Example) GetSummary() string

func (*Example) GetValue 

func (x *Example) GetValue() *structpb.Value

func (*Example) ProtoMessage 

func (*Example) ProtoMessage()

func (*Example) ProtoReflect 

func (x *Example) ProtoReflect() protoreflect.Message

func (*Example) Reset 

func (x *Example) Reset()

func (*Example) String 

func (x *Example) String() string

type ExternalDocumentation 

type ExternalDocumentation struct {

	// A description of the target documentation. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED. The URL for the target documentation. This MUST be in the form of a URL.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Allows referencing an external resource for extended documentation.

See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object

func (*ExternalDocumentation) Descriptor deprecated 

func (*ExternalDocumentation) Descriptor() ([]byte, []int)

Deprecated: Use ExternalDocumentation.ProtoReflect.Descriptor instead.

func (*ExternalDocumentation) GetDescription 

func (x *ExternalDocumentation) GetDescription() string

func (*ExternalDocumentation) GetExtensions 

func (x *ExternalDocumentation) GetExtensions() map[string]*structpb.Value

func (*ExternalDocumentation) GetUrl 

func (x *ExternalDocumentation) GetUrl() string

func (*ExternalDocumentation) ProtoMessage 

func (*ExternalDocumentation) ProtoMessage()

func (*ExternalDocumentation) ProtoReflect 

func (x *ExternalDocumentation) ProtoReflect() protoreflect.Message

func (*ExternalDocumentation) Reset 

func (x *ExternalDocumentation) Reset()

func (*ExternalDocumentation) String 

func (x *ExternalDocumentation) String() string

type FieldConfiguration 

type FieldConfiguration struct {

	// Alternative parameter name when used as path parameter. If set, this will
	// be used as the complete parameter name when this field is used as a path
	// parameter. Use this to avoid having auto-generated path parameter names
	// for overlapping paths.
	PathParamName string `protobuf:"bytes,1,opt,name=path_param_name,json=pathParamName,proto3" json:"path_param_name,omitempty"`
	// Marks this field as required.
	Required bool `protobuf:"varint,2,opt,name=required,proto3" json:"required,omitempty"`
	// contains filtered or unexported fields
}

FieldConfiguration provides additional field level properties used when generating the OpenAPI v3.1 file. These properties are not defined by OpenAPIv3, but they are used to control the generation.

func (*FieldConfiguration) Descriptor deprecated 

func (*FieldConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use FieldConfiguration.ProtoReflect.Descriptor instead.

func (*FieldConfiguration) GetPathParamName 

func (x *FieldConfiguration) GetPathParamName() string

func (*FieldConfiguration) GetRequired 

func (x *FieldConfiguration) GetRequired() bool

func (*FieldConfiguration) ProtoMessage 

func (*FieldConfiguration) ProtoMessage()

func (*FieldConfiguration) ProtoReflect 

func (x *FieldConfiguration) ProtoReflect() protoreflect.Message

func (*FieldConfiguration) Reset 

func (x *FieldConfiguration) Reset()

func (*FieldConfiguration) String 

func (x *FieldConfiguration) String() string
type Header struct {

	// ref is a reference to an existing header object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// A description of the link. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Determines whether this parameter is mandatory.
	// If the parameter location is "path", this property is REQUIRED and its value MUST be true.
	// Otherwise, the property MAY be included and its default value is false.
	Required bool `protobuf:"varint,3,opt,name=required,proto3" json:"required,omitempty"`
	// Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
	Deprecated bool `protobuf:"varint,4,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// Sets the ability to pass empty-valued parameters.
	// This is valid only for query parameters and allows sending a parameter with an empty value.
	// Default value is false. If style is used, and if behavior is n/a (cannot be serialized),
	// the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED,
	// as it is likely to be removed in a later revision.
	AllowEmptyValue bool `protobuf:"varint,5,opt,name=allow_empty_value,json=allowEmptyValue,proto3" json:"allow_empty_value,omitempty"`
	// Describes how the parameter value will be serialized depending on the type of the parameter value.
	// Default value for header parameters is "simple".
	Style string `protobuf:"bytes,6,opt,name=style,proto3" json:"style,omitempty"`
	// When this is true, parameter values of type array or object generate separate parameters for each value of
	// the array or key-value pair of the map. For other types of parameters this property has no effect.
	// When style is form, the default value is true. For all other styles, the default value is false.
	Explode bool `protobuf:"varint,7,opt,name=explode,proto3" json:"explode,omitempty"`
	// The schema defining the type used for the parameter.
	Schema *Schema `protobuf:"bytes,8,opt,name=schema,proto3" json:"schema,omitempty"`
	// Example of the parameter’s potential value.
	// The example SHOULD match the specified schema and encoding properties if present.
	// The example field is mutually exclusive of the examples field. Furthermore,
	// if referencing a schema that contains an example, the example value SHALL override the
	// example provided by the schema. To represent examples of media types that cannot naturally be
	// represented in JSON or YAML, a string value can contain the example with escaping where necessary.
	Example *structpb.Value `protobuf:"bytes,9,opt,name=example,proto3" json:"example,omitempty"`
	// Examples of the parameter’s potential value. Each example SHOULD contain a value in the correct format
	// as specified in the parameter encoding. The examples field is mutually exclusive of the example field.
	// Furthermore, if referencing a schema that contains an example, the examples value SHALL override
	// the example provided by the schema.
	Examples map[string]*Example `` /* 158-byte string literal not displayed */
	// A map containing the representations for the parameter.
	// The key is the media type and the value describes it. The map MUST only contain one entry.
	Content map[string]*MediaType `` /* 156-byte string literal not displayed */
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

Header object follows the structure of the Parameter object with the following changes: 1. name MUST NOT be specified, it is given in the corresponding headers map. 2. in MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).

See: https://spec.openapis.org/oas/v3.1.0#header-object

func (*Header) Descriptor deprecated 

func (*Header) Descriptor() ([]byte, []int)

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetAllowEmptyValue 

func (x *Header) GetAllowEmptyValue() bool

func (*Header) GetContent 

func (x *Header) GetContent() map[string]*MediaType

func (*Header) GetDeprecated 

func (x *Header) GetDeprecated() bool

func (*Header) GetDescription 

func (x *Header) GetDescription() string

func (*Header) GetExample 

func (x *Header) GetExample() *structpb.Value

func (*Header) GetExamples 

func (x *Header) GetExamples() map[string]*Example

func (*Header) GetExplode 

func (x *Header) GetExplode() bool

func (*Header) GetExtensions 

func (x *Header) GetExtensions() map[string]*structpb.Value

func (*Header) GetRef 

func (x *Header) GetRef() *Reference

func (*Header) GetRequired 

func (x *Header) GetRequired() bool

func (*Header) GetSchema 

func (x *Header) GetSchema() *Schema

func (*Header) GetStyle 

func (x *Header) GetStyle() string

func (*Header) ProtoMessage 

func (*Header) ProtoMessage()

func (*Header) ProtoReflect 

func (x *Header) ProtoReflect() protoreflect.Message

func (*Header) Reset 

func (x *Header) Reset()

func (*Header) String 

func (x *Header) String() string

type Info 

type Info struct {

	// REQUIRED. The title of the API.
	Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`
	// A short summary of the API.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// A description of the API. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// A URL to the Terms of Service for the API. This MUST be in the form of a URL.
	TermsOfService string `protobuf:"bytes,4,opt,name=terms_of_service,json=termsOfService,proto3" json:"terms_of_service,omitempty"`
	// The contact information for the exposed API.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#contact-object
	Contact *Contact `protobuf:"bytes,5,opt,name=contact,proto3" json:"contact,omitempty"`
	// The license information for the exposed API.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#license-object
	License *License `protobuf:"bytes,6,opt,name=license,proto3" json:"license,omitempty"`
	// REQUIRED. The version of the OpenAPI document.
	Version string `protobuf:"bytes,7,opt,name=version,proto3" json:"version,omitempty"`
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Info captures OpenAPI Info object. NOTE: A generated value will be used for the required fields if they are left empty.

See: https://spec.openapis.org/oas/v3.1.0#info-object

func (*Info) Descriptor deprecated 

func (*Info) Descriptor() ([]byte, []int)

Deprecated: Use Info.ProtoReflect.Descriptor instead.

func (*Info) GetContact 

func (x *Info) GetContact() *Contact

func (*Info) GetDescription 

func (x *Info) GetDescription() string

func (*Info) GetExtensions 

func (x *Info) GetExtensions() map[string]*structpb.Value

func (*Info) GetLicense 

func (x *Info) GetLicense() *License

func (*Info) GetSummary 

func (x *Info) GetSummary() string

func (*Info) GetTermsOfService 

func (x *Info) GetTermsOfService() string

func (*Info) GetTitle 

func (x *Info) GetTitle() string

func (*Info) GetVersion 

func (x *Info) GetVersion() string

func (*Info) ProtoMessage 

func (*Info) ProtoMessage()

func (*Info) ProtoReflect 

func (x *Info) ProtoReflect() protoreflect.Message

func (*Info) Reset 

func (x *Info) Reset()

func (*Info) String 

func (x *Info) String() string

type License 

type License struct {

	// REQUIRED. The license name used for the API.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.
	Identifier string `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"`
	// A URL to the license used for the API. This MUST be in the form of a URL.
	// The url field is mutually exclusive of the identifier field.
	Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

License information for the exposed API.

See: https://spec.openapis.org/oas/v3.1.0#license-object

func (*License) Descriptor deprecated 

func (*License) Descriptor() ([]byte, []int)

Deprecated: Use License.ProtoReflect.Descriptor instead.

func (*License) GetExtensions 

func (x *License) GetExtensions() map[string]*structpb.Value

func (*License) GetIdentifier 

func (x *License) GetIdentifier() string

func (*License) GetName 

func (x *License) GetName() string

func (*License) GetUrl 

func (x *License) GetUrl() string

func (*License) ProtoMessage 

func (*License) ProtoMessage()

func (*License) ProtoReflect 

func (x *License) ProtoReflect() protoreflect.Message

func (*License) Reset 

func (x *License) Reset()

func (*License) String 

func (x *License) String() string
type Link struct {

	// ref is a reference to an existing link object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// Types that are assignable to Operation:
	//
	//	*Link_OperationRef
	//	*Link_OperationId
	Operation isLink_Operation `protobuf_oneof:"operation"`
	// A map representing parameters to pass to an operation as specified with
	// operationId or identified via operationRef. The key is the parameter name to be used,
	// whereas the value can be a constant or an expression to be evaluated and passed to the linked operation.
	// The parameter name can be qualified using the parameter location [{in}.]{name} for operations that use the
	// same parameter name in different locations (e.g. path.id).
	Parameters map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// A literal value or {expression} to use as a request body when calling the target operation.
	RequestBody *structpb.Value `protobuf:"bytes,5,opt,name=request_body,json=requestBody,proto3" json:"request_body,omitempty"`
	// A description of the link. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// A server object to be used by the target operation.
	Server *Server `protobuf:"bytes,7,opt,name=server,proto3" json:"server,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller’s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.

See: https://spec.openapis.org/oas/v3.1.0#link-object

func (*Link) Descriptor deprecated 

func (*Link) Descriptor() ([]byte, []int)

Deprecated: Use Link.ProtoReflect.Descriptor instead.

func (*Link) GetDescription 

func (x *Link) GetDescription() string

func (*Link) GetExtensions 

func (x *Link) GetExtensions() map[string]*structpb.Value

func (*Link) GetOperation 

func (m *Link) GetOperation() isLink_Operation

func (*Link) GetOperationId 

func (x *Link) GetOperationId() string

func (*Link) GetOperationRef 

func (x *Link) GetOperationRef() string

func (*Link) GetParameters 

func (x *Link) GetParameters() map[string]*structpb.Value

func (*Link) GetRef 

func (x *Link) GetRef() *Reference

func (*Link) GetRequestBody 

func (x *Link) GetRequestBody() *structpb.Value

func (*Link) GetServer 

func (x *Link) GetServer() *Server

func (*Link) ProtoMessage 

func (*Link) ProtoMessage()

func (*Link) ProtoReflect 

func (x *Link) ProtoReflect() protoreflect.Message

func (*Link) Reset 

func (x *Link) Reset()

func (*Link) String 

func (x *Link) String() string
type Link_OperationId struct {
	// The name of an existing, resolvable OAS operation, as defined with a unique operationId.
	// This field is mutually exclusive of the operationRef field.
	//
	// NOTE: If a path (relative or absolute) to another service method is used, that operation ID will be substituted.
	//
	//	Example: ".google.protobuf.Timestamp"
	OperationId string `protobuf:"bytes,3,opt,name=operation_id,json=operationId,proto3,oneof"`
}
type Link_OperationRef struct {
	// A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the
	// operationId field, and MUST point to an Operation Object.
	// Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.
	OperationRef string `protobuf:"bytes,2,opt,name=operation_ref,json=operationRef,proto3,oneof"`
}

type MediaType 

type MediaType struct {

	// The schema defining the content of the request, response, or parameter.
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"`
	// Example of the parameter’s potential value.
	// The example SHOULD match the specified schema and encoding properties if present.
	// The example field is mutually exclusive of the examples field. Furthermore,
	// if referencing a schema that contains an example, the example value SHALL override the
	// example provided by the schema. To represent examples of media types that cannot naturally be
	// represented in JSON or YAML, a string value can contain the example with escaping where necessary.
	Example *structpb.Value `protobuf:"bytes,2,opt,name=example,proto3" json:"example,omitempty"`
	// Examples of the parameter’s potential value. Each example SHOULD contain a value in the correct format
	// as specified in the parameter encoding. The examples field is mutually exclusive of the example field.
	// Furthermore, if referencing a schema that contains an example, the examples value SHALL override
	// the example provided by the schema.
	Examples map[string]*Example `` /* 157-byte string literal not displayed */
	// A map between a property name and its encoding information. The key, being the property name,
	// MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when
	// the media type is multipart or application/x-www-form-urlencoded.
	Encoding map[string]*Encoding `` /* 157-byte string literal not displayed */
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Each Media Type Object provides schema and examples for the media type identified by its key.

See: https://spec.openapis.org/oas/latest.html#media-type-object

func (*MediaType) Descriptor deprecated 

func (*MediaType) Descriptor() ([]byte, []int)

Deprecated: Use MediaType.ProtoReflect.Descriptor instead.

func (*MediaType) GetEncoding 

func (x *MediaType) GetEncoding() map[string]*Encoding

func (*MediaType) GetExample 

func (x *MediaType) GetExample() *structpb.Value

func (*MediaType) GetExamples 

func (x *MediaType) GetExamples() map[string]*Example

func (*MediaType) GetExtensions 

func (x *MediaType) GetExtensions() map[string]*structpb.Value

func (*MediaType) GetSchema 

func (x *MediaType) GetSchema() *Schema

func (*MediaType) ProtoMessage 

func (*MediaType) ProtoMessage()

func (*MediaType) ProtoReflect 

func (x *MediaType) ProtoReflect() protoreflect.Message

func (*MediaType) Reset 

func (x *MediaType) Reset()

func (*MediaType) String 

func (x *MediaType) String() string

type Operation 

type Operation struct {

	// A list of tags for API documentation control.
	// Tags can be used for logical grouping of operations by resources or any other qualifier.
	Tags []string `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"`
	// A short summary of what the operation does.
	//
	// Default is the proto docstring for this method.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Additional external documentation for this operation.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
	ExternalDocs *ExternalDocumentation `protobuf:"bytes,4,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	// Override the operation ID, if left unset, a default value will be provided.
	OperationId string `protobuf:"bytes,5,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	// A list of parameters that are applicable for this operation. Note that path and query parameters
	// get populated by the generator and will override any overlapping keys.
	//
	// You might use this to define headers and values that are not defined on the request payload.
	Parameters []*Parameter `protobuf:"bytes,6,rep,name=parameters,proto3" json:"parameters,omitempty"`
	// The list of possible responses returned from executing this operation.
	//
	// NOTE: This list is additive meaning that it will override any generated response from the
	// proto files.
	Responses map[string]*Response `` /* 159-byte string literal not displayed */
	// Declares this operation to be deprecated.
	// Consumers SHOULD refrain from usage of the declared operation. Default value is false.
	Deprecated bool `protobuf:"varint,11,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// A declaration of which security mechanisms can be used for this operation.
	// The list of values includes alternative security requirement objects that can be used.
	// Only one of the security requirement objects need to be satisfied to authorize a request.
	// To make security optional, an empty security requirement ({}) can be included in the array.
	// This definition overrides any declared top-level security.
	// To remove a top-level security declaration, an empty array can be used.
	Security []*SecurityRequirement `protobuf:"bytes,12,rep,name=security,proto3" json:"security,omitempty"`
	// An alternative server array to service this operation.
	// If an alternative server object is specified at the Path Item Object or Root level,
	// it will be overridden by this value.
	Servers []*Server `protobuf:"bytes,13,rep,name=servers,proto3" json:"servers,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single API operation on a path.

NOTE: this operation object is a partial implementation of the OpenAPI Operation object. Fields overridden here will only impact this method but will be used for all different HTTP bindings of the same method.

See: https://spec.openapis.org/oas/v3.1.0#operation-object

func (*Operation) Descriptor deprecated 

func (*Operation) Descriptor() ([]byte, []int)

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetDeprecated 

func (x *Operation) GetDeprecated() bool

func (*Operation) GetDescription 

func (x *Operation) GetDescription() string

func (*Operation) GetExtensions 

func (x *Operation) GetExtensions() map[string]*structpb.Value

func (*Operation) GetExternalDocs 

func (x *Operation) GetExternalDocs() *ExternalDocumentation

func (*Operation) GetOperationId 

func (x *Operation) GetOperationId() string

func (*Operation) GetParameters 

func (x *Operation) GetParameters() []*Parameter

func (*Operation) GetResponses 

func (x *Operation) GetResponses() map[string]*Response

func (*Operation) GetSecurity 

func (x *Operation) GetSecurity() []*SecurityRequirement

func (*Operation) GetServers 

func (x *Operation) GetServers() []*Server

func (*Operation) GetSummary 

func (x *Operation) GetSummary() string

func (*Operation) GetTags 

func (x *Operation) GetTags() []string

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect 

func (x *Operation) ProtoReflect() protoreflect.Message

func (*Operation) Reset 

func (x *Operation) Reset()

func (*Operation) String 

func (x *Operation) String() string

type Parameter 

type Parameter struct {

	// ref is a reference to an existing parameter object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// REQUIRED. The name of the parameter. Parameter names are case sensitive.
	// If in is "path", the name field MUST correspond to a template expression occurring within the
	// path field in the Paths Object. See Path Templating for further information.
	// If in is "header" and the name field is
	// "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
	// For all other cases, the name corresponds to the parameter name used by the in property.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
	In string `protobuf:"bytes,3,opt,name=in,proto3" json:"in,omitempty"`
	// A description of the link. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Determines whether this parameter is mandatory.
	// If the parameter location is "path", this property is REQUIRED and its value MUST be true.
	// Otherwise, the property MAY be included and its default value is false.
	Required bool `protobuf:"varint,5,opt,name=required,proto3" json:"required,omitempty"`
	// Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
	Deprecated bool `protobuf:"varint,6,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// Sets the ability to pass empty-valued parameters.
	// This is valid only for query parameters and allows sending a parameter with an empty value.
	// Default value is false. If style is used, and if behavior is n/a (cannot be serialized),
	// the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED,
	// as it is likely to be removed in a later revision.
	AllowEmptyValue bool `protobuf:"varint,7,opt,name=allow_empty_value,json=allowEmptyValue,proto3" json:"allow_empty_value,omitempty"`
	// Describes how the parameter value will be serialized depending on the type of the parameter value.
	// Default value for header parameters is "simple".
	Style string `protobuf:"bytes,8,opt,name=style,proto3" json:"style,omitempty"`
	// When this is true, parameter values of type array or object generate separate parameters for each value of
	// the array or key-value pair of the map. For other types of parameters this property has no effect.
	// When style is form, the default value is true. For all other styles, the default value is false.
	Explode bool `protobuf:"varint,9,opt,name=explode,proto3" json:"explode,omitempty"`
	// Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986]
	// :/?#[]@!$&'()*+,;= to be included without percent-encoding.
	// This property only applies to parameters with an in value of query. The default value is false.
	AllowReserved bool `protobuf:"varint,10,opt,name=allow_reserved,json=allowReserved,proto3" json:"allow_reserved,omitempty"`
	// The schema defining the type used for the parameter.
	Schema *Schema `protobuf:"bytes,11,opt,name=schema,proto3" json:"schema,omitempty"`
	// Example of the parameter’s potential value.
	// The example SHOULD match the specified schema and encoding properties if present.
	// The example field is mutually exclusive of the examples field. Furthermore,
	// if referencing a schema that contains an example, the example value SHALL override the
	// example provided by the schema. To represent examples of media types that cannot naturally be
	// represented in JSON or YAML, a string value can contain the example with escaping where necessary.
	Example *structpb.Value `protobuf:"bytes,12,opt,name=example,proto3" json:"example,omitempty"`
	// Examples of the parameter’s potential value. Each example SHOULD contain a value in the correct format
	// as specified in the parameter encoding. The examples field is mutually exclusive of the example field.
	// Furthermore, if referencing a schema that contains an example, the examples value SHALL override
	// the example provided by the schema.
	Examples map[string]*Example `` /* 158-byte string literal not displayed */
	// A map containing the representations for the parameter.
	// The key is the media type and the value describes it. The map MUST only contain one entry.
	Content map[string]*MediaType `` /* 156-byte string literal not displayed */
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single operation parameter. A unique parameter is defined by a combination of a name and location.

See: https://spec.openapis.org/oas/latest.html#parameter-object

func (*Parameter) Descriptor deprecated 

func (*Parameter) Descriptor() ([]byte, []int)

Deprecated: Use Parameter.ProtoReflect.Descriptor instead.

func (*Parameter) GetAllowEmptyValue 

func (x *Parameter) GetAllowEmptyValue() bool

func (*Parameter) GetAllowReserved 

func (x *Parameter) GetAllowReserved() bool

func (*Parameter) GetContent 

func (x *Parameter) GetContent() map[string]*MediaType

func (*Parameter) GetDeprecated 

func (x *Parameter) GetDeprecated() bool

func (*Parameter) GetDescription 

func (x *Parameter) GetDescription() string

func (*Parameter) GetExample 

func (x *Parameter) GetExample() *structpb.Value

func (*Parameter) GetExamples 

func (x *Parameter) GetExamples() map[string]*Example

func (*Parameter) GetExplode 

func (x *Parameter) GetExplode() bool

func (*Parameter) GetExtensions 

func (x *Parameter) GetExtensions() map[string]*structpb.Value

func (*Parameter) GetIn 

func (x *Parameter) GetIn() string

func (*Parameter) GetName 

func (x *Parameter) GetName() string

func (*Parameter) GetRef 

func (x *Parameter) GetRef() *Reference

func (*Parameter) GetRequired 

func (x *Parameter) GetRequired() bool

func (*Parameter) GetSchema 

func (x *Parameter) GetSchema() *Schema

func (*Parameter) GetStyle 

func (x *Parameter) GetStyle() string

func (*Parameter) ProtoMessage 

func (*Parameter) ProtoMessage()

func (*Parameter) ProtoReflect 

func (x *Parameter) ProtoReflect() protoreflect.Message

func (*Parameter) Reset 

func (x *Parameter) Reset()

func (*Parameter) String 

func (x *Parameter) String() string

type Reference 

type Reference struct {

	// REQUIRED. The reference identifier. This MUST be in the form of a URI.
	// For proto messages, a fully qualified message name can be used (relative links are allowed where proto file is deduced).
	//
	// Example: ".google.protobuf.Timestamp"
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// A short summary that, by default, SHOULD override that of the referenced component.
	// If the referenced object-type does not allow a summary field, then this field has no effect.
	Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// A description that, by default, SHOULD override that of the referenced component.
	// CommonMark syntax MAY be used for rich text representation.
	// If the referenced object-type does not allow a description field, then this field has no effect.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

Reference allows referencing other components in the OpenAPI document, both internally and externally. For detailed information on the Reference object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/latest.html#reference-object

func (*Reference) Descriptor deprecated 

func (*Reference) Descriptor() ([]byte, []int)

Deprecated: Use Reference.ProtoReflect.Descriptor instead.

func (*Reference) GetDescription 

func (x *Reference) GetDescription() string

func (*Reference) GetSummary 

func (x *Reference) GetSummary() string

func (*Reference) GetUri 

func (x *Reference) GetUri() string

func (*Reference) ProtoMessage 

func (*Reference) ProtoMessage()

func (*Reference) ProtoReflect 

func (x *Reference) ProtoReflect() protoreflect.Message

func (*Reference) Reset 

func (x *Reference) Reset()

func (*Reference) String 

func (x *Reference) String() string

type RequestBody 

type RequestBody struct {

	// ref is a reference to an existing request body object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// A brief description of the request body. This could contain examples of use.
	// CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it.
	// For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
	Content map[string]*MediaType `` /* 155-byte string literal not displayed */
	// Determines if the request body is required in the request. Defaults to false.
	Required bool `protobuf:"varint,4,opt,name=required,proto3" json:"required,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes a single request body.

See: https://spec.openapis.org/oas/latest.html#request-body-object

func (*RequestBody) Descriptor deprecated 

func (*RequestBody) Descriptor() ([]byte, []int)

Deprecated: Use RequestBody.ProtoReflect.Descriptor instead.

func (*RequestBody) GetContent 

func (x *RequestBody) GetContent() map[string]*MediaType

func (*RequestBody) GetDescription 

func (x *RequestBody) GetDescription() string

func (*RequestBody) GetExtensions 

func (x *RequestBody) GetExtensions() map[string]*structpb.Value

func (*RequestBody) GetRef 

func (x *RequestBody) GetRef() *Reference

func (*RequestBody) GetRequired 

func (x *RequestBody) GetRequired() bool

func (*RequestBody) ProtoMessage 

func (*RequestBody) ProtoMessage()

func (*RequestBody) ProtoReflect 

func (x *RequestBody) ProtoReflect() protoreflect.Message

func (*RequestBody) Reset 

func (x *RequestBody) Reset()

func (*RequestBody) String 

func (x *RequestBody) String() string

type Response 

type Response struct {

	// ref is a reference to an existing response object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// A description which by default SHOULD override that of the referenced component.
	// CommonMark syntax MAY be used for rich text representation.
	// If the referenced object-type does not allow a description field, then this field has no effect.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Maps a header name to its definition. [RFC7230] states header names are case insensitive.
	// If a response header is defined with the name "Content-Type", it SHALL be ignored.
	Headers map[string]*Header `` /* 155-byte string literal not displayed */
	// A map containing descriptions of potential response payloads.
	// The key is a media type or media type range and the value describes it.
	// For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
	Content map[string]*MediaType `` /* 155-byte string literal not displayed */
	// A map of operations links that can be followed from the response. The key of the map is a short name for the link,
	// following the naming constraints of the names for Component Objects.
	Links map[string]*Link `` /* 151-byte string literal not displayed */
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Response) Descriptor deprecated 

func (*Response) Descriptor() ([]byte, []int)

Deprecated: Use Response.ProtoReflect.Descriptor instead.

func (*Response) GetContent 

func (x *Response) GetContent() map[string]*MediaType

func (*Response) GetDescription 

func (x *Response) GetDescription() string

func (*Response) GetExtensions 

func (x *Response) GetExtensions() map[string]*structpb.Value

func (*Response) GetHeaders 

func (x *Response) GetHeaders() map[string]*Header
func (x *Response) GetLinks() map[string]*Link

func (*Response) GetRef 

func (x *Response) GetRef() *Reference

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) ProtoReflect 

func (x *Response) ProtoReflect() protoreflect.Message

func (*Response) Reset 

func (x *Response) Reset()

func (*Response) String 

func (x *Response) String() string

type Schema 

type Schema struct {

	// Adds support for polymorphism by specifying a discriminator object name that differentiates between schemas.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#discriminator-object
	Discriminator *Discriminator `protobuf:"bytes,1,opt,name=discriminator,proto3" json:"discriminator,omitempty"`
	// Additional external documentation related to this schema.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
	ExternalDocs *ExternalDocumentation `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	// Extra can be used to add any other field in the schema. Since OpenAPI v3.1 arbitrary fields can be
	// used in the schema objects. This field can be utilized to add those extra fields. Some of the JSON schema
	// validation properties or core properties that are not captured as part of the gRPC REST Gateway OpenAPI
	// objects.
	Extra map[string]*structpb.Value `` /* 151-byte string literal not displayed */
	// Ref is used to define an external reference to include in the message.
	// This could be a fully qualified proto message reference and start with a '.',
	// and that type must be available in the proto files or their dependencies.
	// If no message is identified, the Ref will be used verbatim in the output.
	//
	// For example:
	//
	//	`ref: ".google.protobuf.Timestamp"`.
	//
	// NOTE: This reference will only be honored when used in top-level schemas in responses only.
	Ref string `protobuf:"bytes,5,opt,name=ref,proto3" json:"ref,omitempty"`
	// Configuration related to schema generation for OpenAPI documentation.
	Config *FieldConfiguration `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
	// The "$schema" keyword is used to identify the schema dialect and its associated URI for validation.
	//
	// See: https://json-schema.org/draft/2020-12/json-schema-core#name-the-schema-keyword
	Schema string `protobuf:"bytes,10,opt,name=schema,proto3" json:"schema,omitempty"`
	// The title of the schema.
	Title string `protobuf:"bytes,11,opt,name=title,proto3" json:"title,omitempty"`
	// A regular expression pattern that the schema value should match.
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.3
	Pattern string `protobuf:"bytes,12,opt,name=pattern,proto3" json:"pattern,omitempty"`
	// A list of property names that are required in this schema.
	Required []string `protobuf:"bytes,13,rep,name=required,proto3" json:"required,omitempty"`
	// An array of unique values for enum validation.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.1.2
	Enum []string `protobuf:"bytes,14,rep,name=enum,proto3" json:"enum,omitempty"`
	// The value of "multipleOf" MUST be a number, strictly greater than 0.
	// A numeric instance is valid only if division by this keyword's value results in an integer.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.1
	MultipleOf float64 `protobuf:"fixed64,15,opt,name=multiple_of,json=multipleOf,proto3" json:"multiple_of,omitempty"`
	// Maximum represents an inclusive upper limit for a numeric instance. The
	// value of MUST be a number, representing an inclusive upper limit for a numeric instance.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.2
	Maximum float64 `protobuf:"fixed64,16,opt,name=maximum,proto3" json:"maximum,omitempty"`
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.3
	ExclusiveMaximum float64 `protobuf:"fixed64,17,opt,name=exclusive_maximum,json=exclusiveMaximum,proto3" json:"exclusive_maximum,omitempty"`
	// minimum represents an inclusive lower limit for a numeric instance. The
	// value of MUST be a number, representing an inclusive lower limit for a numeric instance.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.4
	Minimum float64 `protobuf:"fixed64,18,opt,name=minimum,proto3" json:"minimum,omitempty"`
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.2.5
	ExclusiveMinimum float64 `protobuf:"fixed64,19,opt,name=exclusive_minimum,json=exclusiveMinimum,proto3" json:"exclusive_minimum,omitempty"`
	// A string instance is valid against this keyword if its length is
	// less than, or equal to, the value of this keyword.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.1
	MaxLength uint64 `protobuf:"varint,20,opt,name=max_length,json=maxLength,proto3" json:"max_length,omitempty"`
	// A string instance is valid against this keyword if its length is
	// greater than, or equal to, the value of this keyword.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.3.2
	MinLength uint64 `protobuf:"varint,21,opt,name=min_length,json=minLength,proto3" json:"min_length,omitempty"`
	// An array instance is valid against "maxItems" if its size is
	// less than, or equal to, the value of this keyword.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.1
	MaxItems uint64 `protobuf:"varint,22,opt,name=max_items,json=maxItems,proto3" json:"max_items,omitempty"`
	// An array instance is valid against "minItems" if its size is
	// greater than, or equal to, the value of this keyword.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6.4.2
	MinItems uint64 `protobuf:"varint,23,opt,name=min_items,json=minItems,proto3" json:"min_items,omitempty"`
	// If set to true, all items must be unique.
	UniqueItems   bool   `protobuf:"varint,24,opt,name=unique_items,json=uniqueItems,proto3" json:"unique_items,omitempty"`
	MaxProperties uint64 `protobuf:"varint,25,opt,name=max_properties,json=maxProperties,proto3" json:"max_properties,omitempty"`
	MinProperties uint64 `protobuf:"varint,26,opt,name=min_properties,json=minProperties,proto3" json:"min_properties,omitempty"`
	// Indicates what type this schema holds. In JSON schema draft 2020, this can be a singular value or
	// a list of values. For simplicity of structure, types is always a list but if it contains only one
	// item, in the generated file, it will be a single string and not a list.
	Types []SchemaDataType `protobuf:"varint,27,rep,packed,name=types,proto3,enum=meshapi.gateway.openapi.SchemaDataType" json:"types,omitempty"`
	// A description of the schema using CommonMark syntax.
	Description string `protobuf:"bytes,28,opt,name=description,proto3" json:"description,omitempty"`
	// The items keyword specifies the schema for items in an array.
	Items *Schema_Item `protobuf:"bytes,29,opt,name=items,proto3" json:"items,omitempty"`
	// The properties keyword specifies the schema for properties in an object.
	//
	// Defining any property here for proto messages merges them with the automatically generated ones.
	Properties map[string]*Schema `` /* 162-byte string literal not displayed */
	// The additionalProperties keyword specifies the schema for additional properties in an object.
	AdditionalProperties *Schema `protobuf:"bytes,31,opt,name=additional_properties,json=additionalProperties,proto3" json:"additional_properties,omitempty"`
	// The default keyword provides a default JSON value associated with the schema.
	Default *structpb.Value `protobuf:"bytes,32,opt,name=default,proto3" json:"default,omitempty"`
	// The allOf keyword specifies that an instance must validate against all the schemas defined in the array.
	//
	// See: https://json-schema.org/draft/2020-12/json-schema-core#name-allof
	AllOf []*Schema `protobuf:"bytes,33,rep,name=all_of,json=allOf,proto3" json:"all_of,omitempty"`
	// The anyOf keyword specifies that an instance must validate against at least one of the schemas defined in the array.
	//
	// See: https://json-schema.org/draft/2020-12/json-schema-core#name-anyof
	AnyOf []*Schema `protobuf:"bytes,34,rep,name=any_of,json=anyOf,proto3" json:"any_of,omitempty"`
	// The oneOf keyword specifies that an instance must validate against exactly one of the schemas defined in the array.
	//
	// See: https://json-schema.org/draft/2020-12/json-schema-core#name-oneof
	OneOf []*Schema `protobuf:"bytes,35,rep,name=one_of,json=oneOf,proto3" json:"one_of,omitempty"`
	// The not keyword specifies that an instance must not validate against the schema defined.
	//
	// See: https://json-schema.org/draft/2020-12/json-schema-core#name-not
	Not *Schema `protobuf:"bytes,36,opt,name=not,proto3" json:"not,omitempty"`
	// The readOnly keyword specifies that a property is read-only.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
	ReadOnly bool `protobuf:"varint,37,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	// The writeOnly keyword specifies that a property is write-only.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.4
	WriteOnly bool `protobuf:"varint,38,opt,name=write_only,json=writeOnly,proto3" json:"write_only,omitempty"`
	// Examples of valid instances for the schema.
	//
	// See: https://json-schema.org/draft/2020-12/json-schema-validation#section-9.5
	Examples []*structpb.Value `protobuf:"bytes,39,rep,name=examples,proto3" json:"examples,omitempty"`
	// The format keyword specifies a predefined format for the schema value.
	//
	// See: https://json-schema.org/draft-06/json-schema-validation#rfc.section.8
	Format string `protobuf:"bytes,40,opt,name=format,proto3" json:"format,omitempty"`
	// The deprecated keyword specifies that the schema is deprecated.
	//
	// See: https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-9.3
	Deprecated bool `protobuf:"varint,41,opt,name=deprecated,proto3" json:"deprecated,omitempty"`
	// contains filtered or unexported fields
}

Schema represents an OpenAPI v3.1 Schema object, providing a structured definition for data types used in the API.

For detailed information on the Schema object, refer to the OpenAPI Specification: https://spec.openapis.org/oas/v3.1.0#schema-object

func (*Schema) Descriptor deprecated 

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetAdditionalProperties 

func (x *Schema) GetAdditionalProperties() *Schema

func (*Schema) GetAllOf 

func (x *Schema) GetAllOf() []*Schema

func (*Schema) GetAnyOf 

func (x *Schema) GetAnyOf() []*Schema

func (*Schema) GetConfig 

func (x *Schema) GetConfig() *FieldConfiguration

func (*Schema) GetDefault 

func (x *Schema) GetDefault() *structpb.Value

func (*Schema) GetDeprecated 

func (x *Schema) GetDeprecated() bool

func (*Schema) GetDescription 

func (x *Schema) GetDescription() string

func (*Schema) GetDiscriminator 

func (x *Schema) GetDiscriminator() *Discriminator

func (*Schema) GetEnum 

func (x *Schema) GetEnum() []string

func (*Schema) GetExamples 

func (x *Schema) GetExamples() []*structpb.Value

func (*Schema) GetExclusiveMaximum 

func (x *Schema) GetExclusiveMaximum() float64

func (*Schema) GetExclusiveMinimum 

func (x *Schema) GetExclusiveMinimum() float64

func (*Schema) GetExternalDocs 

func (x *Schema) GetExternalDocs() *ExternalDocumentation

func (*Schema) GetExtra 

func (x *Schema) GetExtra() map[string]*structpb.Value

func (*Schema) GetFormat 

func (x *Schema) GetFormat() string

func (*Schema) GetItems 

func (x *Schema) GetItems() *Schema_Item

func (*Schema) GetMaxItems 

func (x *Schema) GetMaxItems() uint64

func (*Schema) GetMaxLength 

func (x *Schema) GetMaxLength() uint64

func (*Schema) GetMaxProperties 

func (x *Schema) GetMaxProperties() uint64

func (*Schema) GetMaximum 

func (x *Schema) GetMaximum() float64

func (*Schema) GetMinItems 

func (x *Schema) GetMinItems() uint64

func (*Schema) GetMinLength 

func (x *Schema) GetMinLength() uint64

func (*Schema) GetMinProperties 

func (x *Schema) GetMinProperties() uint64

func (*Schema) GetMinimum 

func (x *Schema) GetMinimum() float64

func (*Schema) GetMultipleOf 

func (x *Schema) GetMultipleOf() float64

func (*Schema) GetNot 

func (x *Schema) GetNot() *Schema

func (*Schema) GetOneOf 

func (x *Schema) GetOneOf() []*Schema

func (*Schema) GetPattern 

func (x *Schema) GetPattern() string

func (*Schema) GetProperties 

func (x *Schema) GetProperties() map[string]*Schema

func (*Schema) GetReadOnly 

func (x *Schema) GetReadOnly() bool

func (*Schema) GetRef 

func (x *Schema) GetRef() string

func (*Schema) GetRequired 

func (x *Schema) GetRequired() []string

func (*Schema) GetSchema 

func (x *Schema) GetSchema() string

func (*Schema) GetTitle 

func (x *Schema) GetTitle() string

func (*Schema) GetTypes 

func (x *Schema) GetTypes() []SchemaDataType

func (*Schema) GetUniqueItems 

func (x *Schema) GetUniqueItems() bool

func (*Schema) GetWriteOnly 

func (x *Schema) GetWriteOnly() bool

func (*Schema) ProtoMessage 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect 

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset 

func (x *Schema) Reset()

func (*Schema) String 

func (x *Schema) String() string

type SchemaDataType 

type SchemaDataType int32

Enum for the data type of a schema. 

const (
	SchemaDataType_UNKNOWN SchemaDataType = 0
	SchemaDataType_ARRAY   SchemaDataType = 1
	SchemaDataType_BOOLEAN SchemaDataType = 2
	SchemaDataType_INTEGER SchemaDataType = 3
	SchemaDataType_NULL    SchemaDataType = 4
	SchemaDataType_NUMBER  SchemaDataType = 5
	SchemaDataType_OBJECT  SchemaDataType = 6
	SchemaDataType_STRING  SchemaDataType = 7
)

func (SchemaDataType) Descriptor 

func (SchemaDataType) Descriptor() protoreflect.EnumDescriptor

func (SchemaDataType) Enum 

func (x SchemaDataType) Enum() *SchemaDataType

func (SchemaDataType) EnumDescriptor deprecated 

func (SchemaDataType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SchemaDataType.Descriptor instead.

func (SchemaDataType) Number 

func (x SchemaDataType) Number() protoreflect.EnumNumber

func (SchemaDataType) String 

func (x SchemaDataType) String() string

func (SchemaDataType) Type 

func (SchemaDataType) Type() protoreflect.EnumType

type Schema_Item 

type Schema_Item struct {

	// Types that are assignable to Value:
	//
	//	*Schema_Item_Schema
	//	*Schema_Item_List
	Value isSchema_Item_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

Represents an item in a SchemaList, which can be a schema or another SchemaList.

func (*Schema_Item) Descriptor deprecated 

func (*Schema_Item) Descriptor() ([]byte, []int)

Deprecated: Use Schema_Item.ProtoReflect.Descriptor instead.

func (*Schema_Item) GetList 

func (x *Schema_Item) GetList() *Schema_SchemaList

func (*Schema_Item) GetSchema 

func (x *Schema_Item) GetSchema() *Schema

func (*Schema_Item) GetValue 

func (m *Schema_Item) GetValue() isSchema_Item_Value

func (*Schema_Item) ProtoMessage 

func (*Schema_Item) ProtoMessage()

func (*Schema_Item) ProtoReflect 

func (x *Schema_Item) ProtoReflect() protoreflect.Message

func (*Schema_Item) Reset 

func (x *Schema_Item) Reset()

func (*Schema_Item) String 

func (x *Schema_Item) String() string

type Schema_Item_List 

type Schema_Item_List struct {
	List *Schema_SchemaList `protobuf:"bytes,2,opt,name=list,proto3,oneof"`
}

type Schema_Item_Schema 

type Schema_Item_Schema struct {
	Schema *Schema `protobuf:"bytes,1,opt,name=schema,proto3,oneof"`
}

type Schema_SchemaList 

type Schema_SchemaList struct {
	Items []*Schema `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

Represents a list of schemas for array validation or for object properties.

func (*Schema_SchemaList) Descriptor deprecated 

func (*Schema_SchemaList) Descriptor() ([]byte, []int)

Deprecated: Use Schema_SchemaList.ProtoReflect.Descriptor instead.

func (*Schema_SchemaList) GetItems 

func (x *Schema_SchemaList) GetItems() []*Schema

func (*Schema_SchemaList) ProtoMessage 

func (*Schema_SchemaList) ProtoMessage()

func (*Schema_SchemaList) ProtoReflect 

func (x *Schema_SchemaList) ProtoReflect() protoreflect.Message

func (*Schema_SchemaList) Reset 

func (x *Schema_SchemaList) Reset()

func (*Schema_SchemaList) String 

func (x *Schema_SchemaList) String() string

type SecurityRequirement 

type SecurityRequirement struct {

	// Each name MUST correspond to a security scheme which is declared in the Security Schemes under
	// the Components Object. If the security scheme is of type "oauth2" or "openIdConnect", then the
	// value is a list of scope names required for the execution, and the list MAY be empty if authorization
	// does not require a specified scope. For other security scheme types, the array MAY contain a list of role
	// names which are required for the execution, but are not otherwise defined or exchanged in-band.
	Name   string   `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// contains filtered or unexported fields
}

Lists the required security schemes to execute this operation.

See: https://spec.openapis.org/oas/v3.1.0#security-requirement-object

func (*SecurityRequirement) Descriptor deprecated 

func (*SecurityRequirement) Descriptor() ([]byte, []int)

Deprecated: Use SecurityRequirement.ProtoReflect.Descriptor instead.

func (*SecurityRequirement) GetName 

func (x *SecurityRequirement) GetName() string

func (*SecurityRequirement) GetScopes 

func (x *SecurityRequirement) GetScopes() []string

func (*SecurityRequirement) ProtoMessage 

func (*SecurityRequirement) ProtoMessage()

func (*SecurityRequirement) ProtoReflect 

func (x *SecurityRequirement) ProtoReflect() protoreflect.Message

func (*SecurityRequirement) Reset 

func (x *SecurityRequirement) Reset()

func (*SecurityRequirement) String 

func (x *SecurityRequirement) String() string

type SecurityScheme 

type SecurityScheme struct {

	// ref is a reference to an existing response object. If used, all other fields in this object get ignored.
	Ref *Reference `protobuf:"bytes,1,opt,name=ref,proto3" json:"ref,omitempty"`
	// REQUIRED. The type of the security scheme.
	// Valid values are "apiKey", "http", "mutualTLS", "oauth2", "openIdConnect".
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// A brief description of the request body. This could contain examples of use.
	// CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// REQUIRED. The name of the header, query or cookie parameter to be used.
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
	In string `protobuf:"bytes,5,opt,name=in,proto3" json:"in,omitempty"`
	// REQUIRED. The name of the HTTP Authorization scheme to be used in the
	// Authorization header as defined in [RFC7235].
	// The values used SHOULD be registered in the IANA Authentication Scheme registry.
	Scheme string `protobuf:"bytes,6,opt,name=scheme,proto3" json:"scheme,omitempty"`
	// A hint to the client to identify how the bearer token is formatted.
	// Bearer tokens are usually generated by an authorization server,
	// so this information is primarily for documentation purposes.
	BearerFormat string `protobuf:"bytes,7,opt,name=bearer_format,json=bearerFormat,proto3" json:"bearer_format,omitempty"`
	// REQUIRED. An object containing configuration information for the flow types supported.
	Flows *SecurityScheme_OAuthFlows `protobuf:"bytes,8,opt,name=flows,proto3" json:"flows,omitempty"`
	// REQUIRED. OpenId Connect URL to discover OAuth2 configuration values.
	// This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS.
	OpenIdConnectUrl string `protobuf:"bytes,9,opt,name=open_id_connect_url,json=openIdConnectUrl,proto3" json:"open_id_connect_url,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 162-byte string literal not displayed */
	// contains filtered or unexported fields
}

Defines a security scheme that can be used by the operations.

See: https://spec.openapis.org/oas/latest.html#security-scheme-object

func (*SecurityScheme) Descriptor deprecated 

func (*SecurityScheme) Descriptor() ([]byte, []int)

Deprecated: Use SecurityScheme.ProtoReflect.Descriptor instead.

func (*SecurityScheme) GetBearerFormat 

func (x *SecurityScheme) GetBearerFormat() string

func (*SecurityScheme) GetDescription 

func (x *SecurityScheme) GetDescription() string

func (*SecurityScheme) GetExtensions 

func (x *SecurityScheme) GetExtensions() map[string]*structpb.Value

func (*SecurityScheme) GetFlows 

func (x *SecurityScheme) GetFlows() *SecurityScheme_OAuthFlows

func (*SecurityScheme) GetIn 

func (x *SecurityScheme) GetIn() string

func (*SecurityScheme) GetName 

func (x *SecurityScheme) GetName() string

func (*SecurityScheme) GetOpenIdConnectUrl 

func (x *SecurityScheme) GetOpenIdConnectUrl() string

func (*SecurityScheme) GetRef 

func (x *SecurityScheme) GetRef() *Reference

func (*SecurityScheme) GetScheme 

func (x *SecurityScheme) GetScheme() string

func (*SecurityScheme) GetType 

func (x *SecurityScheme) GetType() string

func (*SecurityScheme) ProtoMessage 

func (*SecurityScheme) ProtoMessage()

func (*SecurityScheme) ProtoReflect 

func (x *SecurityScheme) ProtoReflect() protoreflect.Message

func (*SecurityScheme) Reset 

func (x *SecurityScheme) Reset()

func (*SecurityScheme) String 

func (x *SecurityScheme) String() string

type SecurityScheme_OAuthFlow 

type SecurityScheme_OAuthFlow struct {
	AuthorizationUrl string            `protobuf:"bytes,1,opt,name=authorization_url,json=authorizationUrl,proto3" json:"authorization_url,omitempty"`
	TokenUrl         string            `protobuf:"bytes,2,opt,name=token_url,json=tokenUrl,proto3" json:"token_url,omitempty"`
	RefreshUrl       string            `protobuf:"bytes,3,opt,name=refresh_url,json=refreshUrl,proto3" json:"refresh_url,omitempty"`
	Scopes           map[string]string `` /* 153-byte string literal not displayed */
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration details for a supported OAuth Flow

See: https://spec.openapis.org/oas/latest.html#oauth-flow-object

func (*SecurityScheme_OAuthFlow) Descriptor deprecated 

func (*SecurityScheme_OAuthFlow) Descriptor() ([]byte, []int)

Deprecated: Use SecurityScheme_OAuthFlow.ProtoReflect.Descriptor instead.

func (*SecurityScheme_OAuthFlow) GetAuthorizationUrl 

func (x *SecurityScheme_OAuthFlow) GetAuthorizationUrl() string

func (*SecurityScheme_OAuthFlow) GetExtensions 

func (x *SecurityScheme_OAuthFlow) GetExtensions() map[string]*structpb.Value

func (*SecurityScheme_OAuthFlow) GetRefreshUrl 

func (x *SecurityScheme_OAuthFlow) GetRefreshUrl() string

func (*SecurityScheme_OAuthFlow) GetScopes 

func (x *SecurityScheme_OAuthFlow) GetScopes() map[string]string

func (*SecurityScheme_OAuthFlow) GetTokenUrl 

func (x *SecurityScheme_OAuthFlow) GetTokenUrl() string

func (*SecurityScheme_OAuthFlow) ProtoMessage 

func (*SecurityScheme_OAuthFlow) ProtoMessage()

func (*SecurityScheme_OAuthFlow) ProtoReflect 

func (x *SecurityScheme_OAuthFlow) ProtoReflect() protoreflect.Message

func (*SecurityScheme_OAuthFlow) Reset 

func (x *SecurityScheme_OAuthFlow) Reset()

func (*SecurityScheme_OAuthFlow) String 

func (x *SecurityScheme_OAuthFlow) String() string

type SecurityScheme_OAuthFlows 

type SecurityScheme_OAuthFlows struct {

	// Configuration for the OAuth Implicit flow
	Implicit *SecurityScheme_OAuthFlow `protobuf:"bytes,1,opt,name=implicit,proto3" json:"implicit,omitempty"`
	// Configuration for the OAuth Resource Owner Password flow
	Password *SecurityScheme_OAuthFlow `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.
	ClientCredentials *SecurityScheme_OAuthFlow `protobuf:"bytes,3,opt,name=client_credentials,json=clientCredentials,proto3" json:"client_credentials,omitempty"`
	// Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
	AuthorizationCode *SecurityScheme_OAuthFlow `protobuf:"bytes,4,opt,name=authorization_code,json=authorizationCode,proto3" json:"authorization_code,omitempty"`
	// extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

See: https://spec.openapis.org/oas/latest.html#oauth-flows-object

func (*SecurityScheme_OAuthFlows) Descriptor deprecated 

func (*SecurityScheme_OAuthFlows) Descriptor() ([]byte, []int)

Deprecated: Use SecurityScheme_OAuthFlows.ProtoReflect.Descriptor instead.

func (*SecurityScheme_OAuthFlows) GetAuthorizationCode 

func (x *SecurityScheme_OAuthFlows) GetAuthorizationCode() *SecurityScheme_OAuthFlow

func (*SecurityScheme_OAuthFlows) GetClientCredentials 

func (x *SecurityScheme_OAuthFlows) GetClientCredentials() *SecurityScheme_OAuthFlow

func (*SecurityScheme_OAuthFlows) GetExtensions 

func (x *SecurityScheme_OAuthFlows) GetExtensions() map[string]*structpb.Value

func (*SecurityScheme_OAuthFlows) GetImplicit 

func (x *SecurityScheme_OAuthFlows) GetImplicit() *SecurityScheme_OAuthFlow

func (*SecurityScheme_OAuthFlows) GetPassword 

func (x *SecurityScheme_OAuthFlows) GetPassword() *SecurityScheme_OAuthFlow

func (*SecurityScheme_OAuthFlows) ProtoMessage 

func (*SecurityScheme_OAuthFlows) ProtoMessage()

func (*SecurityScheme_OAuthFlows) ProtoReflect 

func (x *SecurityScheme_OAuthFlows) ProtoReflect() protoreflect.Message

func (*SecurityScheme_OAuthFlows) Reset 

func (x *SecurityScheme_OAuthFlows) Reset()

func (*SecurityScheme_OAuthFlows) String 

func (x *SecurityScheme_OAuthFlows) String() string

type Server 

type Server struct {

	// REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative,
	// to indicate that the host location is relative to the location where the OpenAPI document is
	// being served. Variable substitutions will be made when a variable is named in {brackets}.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// An optional string describing the host designated by the URL.
	// CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// A map between a variable name and its value. The value is used for substitution in the
	// server’s URL template.
	Variables map[string]*ServerVariable `` /* 159-byte string literal not displayed */
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

An object representing a Server.

See: https://spec.openapis.org/oas/v3.1.0#server-object

func (*Server) Descriptor deprecated 

func (*Server) Descriptor() ([]byte, []int)

Deprecated: Use Server.ProtoReflect.Descriptor instead.

func (*Server) GetDescription 

func (x *Server) GetDescription() string

func (*Server) GetExtensions 

func (x *Server) GetExtensions() map[string]*structpb.Value

func (*Server) GetUrl 

func (x *Server) GetUrl() string

func (*Server) GetVariables 

func (x *Server) GetVariables() map[string]*ServerVariable

func (*Server) ProtoMessage 

func (*Server) ProtoMessage()

func (*Server) ProtoReflect 

func (x *Server) ProtoReflect() protoreflect.Message

func (*Server) Reset 

func (x *Server) Reset()

func (*Server) String 

func (x *Server) String() string

type ServerVariable 

type ServerVariable struct {

	// An enumeration of string values to be used if the substitution options are from a limited set.
	// The array MUST NOT be empty.
	EnumValues []string `protobuf:"bytes,1,rep,name=enum_values,json=enumValues,proto3" json:"enum_values,omitempty"`
	// REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value
	// is not supplied. Note this behavior is different than the Schema Object’s treatment of default values,
	// because in those cases parameter values are optional. If the enum is defined, the value MUST exist in
	// the enum’s values.
	DefaultValue string `protobuf:"bytes,2,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
	// An optional description for the server variable.
	// CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

An object representing a Server Variable for server URL template substitution.

See: https://spec.openapis.org/oas/v3.1.0#server-variable-object

func (*ServerVariable) Descriptor deprecated 

func (*ServerVariable) Descriptor() ([]byte, []int)

Deprecated: Use ServerVariable.ProtoReflect.Descriptor instead.

func (*ServerVariable) GetDefaultValue 

func (x *ServerVariable) GetDefaultValue() string

func (*ServerVariable) GetDescription 

func (x *ServerVariable) GetDescription() string

func (*ServerVariable) GetEnumValues 

func (x *ServerVariable) GetEnumValues() []string

func (*ServerVariable) GetExtensions 

func (x *ServerVariable) GetExtensions() map[string]*structpb.Value

func (*ServerVariable) ProtoMessage 

func (*ServerVariable) ProtoMessage()

func (*ServerVariable) ProtoReflect 

func (x *ServerVariable) ProtoReflect() protoreflect.Message

func (*ServerVariable) Reset 

func (x *ServerVariable) Reset()

func (*ServerVariable) String 

func (x *ServerVariable) String() string

type Tag 

type Tag struct {

	// REQUIRED. The name of the tag.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A description for the tag. CommonMark syntax MAY be used for rich text representation.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Additional external documentation for this tag.
	//
	// See: https://spec.openapis.org/oas/v3.1.0#external-documentation-object
	ExternalDocs *ExternalDocumentation `protobuf:"bytes,3,opt,name=external_docs,json=externalDocs,proto3" json:"external_docs,omitempty"`
	// Extensions that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by
	// standard OpenAPI specification.
	//
	// See: https://spec.openapis.org/oas/latest.html#specification-extensions
	Extensions map[string]*structpb.Value `` /* 161-byte string literal not displayed */
	// contains filtered or unexported fields
}

Adds metadata to a single tag that is used by the Operation Object.

See: https://spec.openapis.org/oas/v3.1.0#tag-object

func (*Tag) Descriptor deprecated 

func (*Tag) Descriptor() ([]byte, []int)

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetDescription 

func (x *Tag) GetDescription() string

func (*Tag) GetExtensions 

func (x *Tag) GetExtensions() map[string]*structpb.Value

func (*Tag) GetExternalDocs 

func (x *Tag) GetExternalDocs() *ExternalDocumentation

func (*Tag) GetName 

func (x *Tag) GetName() string

func (*Tag) ProtoMessage 

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect 

func (x *Tag) ProtoReflect() protoreflect.Message

func (*Tag) Reset 

func (x *Tag) Reset()

func (*Tag) String 

func (x *Tag) String() string

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.