Package openapiv2 produces OpenAPI Specification 2.0 (https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) for the HTTP endpoints.

Package openapiv3 contains the algorithms and data structures used to generate OpenAPI v3 specifications from Goa designs.

APISchema produces the API JSON hyper schema.

AttributeTypeSchema produces the JSON schema corresponding to the given attribute.

AttributeTypeSchemaWithPrefix produces the JSON schema corresponding to the given attribute and adds the provided prefix to the type name.

DocsFromExpr builds a ExternalDocs from the Goa docs expression.

ExtensionsFromExpr generates swagger extensions from the given meta expression.

GenerateResultTypeDefinition produces the JSON schema corresponding to the given media type and given view.

GenerateServiceDefinition produces the JSON schema corresponding to the given service.

GenerateTypeDefinition produces the JSON schema corresponding to the given type.

GenerateTypeDefinitionWithName produces the JSON schema corresponding to the given type with provided type name.

MarshalJSON produces the JSON resulting from encoding an object composed of the fields in v (which must me a struct) and the keys in extensions.

MarshalYAML produces the JSON resulting from encoding an object composed of the fields in v (which must me a struct) and the keys in extensions.

NewSchema instantiates a new JSON schema.

ResultTypeRef produces the JSON reference to the media type definition with the given view.

ResultTypeRefWithPrefix produces the JSON reference to the media type definition with the given view and adds the provided prefix to the type name.

TagNamesFromExpr computes the names of the swagger tags specified in the given metadata expressions.

TagsFromExpr extracts the swagger related metadata from the given expression.

ToString returns the string representation of the given type.

ToStringMap converts map[interface{}]interface{} to a map[string]interface{} when possible.

TypeRef produces the JSON reference to the type definition.

TypeRefWithPrefix produces the JSON reference to the type definition and adds the provided prefix to the type name.

TypeSchema produces the JSON schema corresponding to the given data type.

TypeSchemaWithPrefix produces the JSON schema corresponding to the given data type and adds the provided prefix to the type name.

Array represents a JSON array.

Boolean represents a JSON boolean.

File is an extension used by Swagger to represent a file download.

Integer represents a JSON number without a fraction or exponent part.

Null represents the JSON null value.

Number represents any JSON number.

Object represents a JSON object.

SchemaRef is the JSON Hyper-schema standard href.

String represents a JSON string.

Definitions contains the generated JSON schema definitions.

ExternalDocs represents an OpenAPI External Documentation object as defined in https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#externalDocumentationObject.

Tag allows adding meta data to a single tag that is used by the Operation Object.