-
-
Notifications
You must be signed in to change notification settings - Fork 412
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs.sh: fix narrow docs checks spectrum (#877)
- Loading branch information
Showing
10 changed files
with
2,474 additions
and
170 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,185 @@ | ||
| type Header struct{ ... } | ||
| type Operation struct{ ... } | ||
| type Parameter struct{ ... } | ||
| package openapi2 // import "github.com/getkin/kin-openapi/openapi2" | ||
|
|
||
| Package openapi2 parses and writes OpenAPIv2 specification documents. | ||
|
|
||
| Does not cover all elements of OpenAPIv2. When OpenAPI version 3 is | ||
| backwards-compatible with version 2, version 3 elements have been used. | ||
|
|
||
| See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md | ||
|
|
||
| TYPES | ||
|
|
||
| type Header struct { | ||
| Parameter | ||
| } | ||
|
|
||
| func (header Header) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of Header. | ||
|
|
||
| func (header *Header) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets Header to a copy of data. | ||
|
|
||
| type Operation struct { | ||
| Extensions map[string]interface{} `json:"-" yaml:"-"` | ||
|
|
||
| Summary string `json:"summary,omitempty" yaml:"summary,omitempty"` | ||
| Description string `json:"description,omitempty" yaml:"description,omitempty"` | ||
| Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"` | ||
| ExternalDocs *openapi3.ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` | ||
| Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"` | ||
| OperationID string `json:"operationId,omitempty" yaml:"operationId,omitempty"` | ||
| Parameters Parameters `json:"parameters,omitempty" yaml:"parameters,omitempty"` | ||
| Responses map[string]*Response `json:"responses" yaml:"responses"` | ||
| Consumes []string `json:"consumes,omitempty" yaml:"consumes,omitempty"` | ||
| Produces []string `json:"produces,omitempty" yaml:"produces,omitempty"` | ||
| Schemes []string `json:"schemes,omitempty" yaml:"schemes,omitempty"` | ||
| Security *SecurityRequirements `json:"security,omitempty" yaml:"security,omitempty"` | ||
| } | ||
|
|
||
| func (operation Operation) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of Operation. | ||
|
|
||
| func (operation *Operation) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets Operation to a copy of data. | ||
|
|
||
| type Parameter struct { | ||
| Extensions map[string]interface{} `json:"-" yaml:"-"` | ||
|
|
||
| Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"` | ||
|
|
||
| In string `json:"in,omitempty" yaml:"in,omitempty"` | ||
| Name string `json:"name,omitempty" yaml:"name,omitempty"` | ||
| Description string `json:"description,omitempty" yaml:"description,omitempty"` | ||
| CollectionFormat string `json:"collectionFormat,omitempty" yaml:"collectionFormat,omitempty"` | ||
| Type string `json:"type,omitempty" yaml:"type,omitempty"` | ||
| Format string `json:"format,omitempty" yaml:"format,omitempty"` | ||
| Pattern string `json:"pattern,omitempty" yaml:"pattern,omitempty"` | ||
| AllowEmptyValue bool `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"` | ||
| Required bool `json:"required,omitempty" yaml:"required,omitempty"` | ||
| UniqueItems bool `json:"uniqueItems,omitempty" yaml:"uniqueItems,omitempty"` | ||
| ExclusiveMin bool `json:"exclusiveMinimum,omitempty" yaml:"exclusiveMinimum,omitempty"` | ||
| ExclusiveMax bool `json:"exclusiveMaximum,omitempty" yaml:"exclusiveMaximum,omitempty"` | ||
| Schema *openapi3.SchemaRef `json:"schema,omitempty" yaml:"schema,omitempty"` | ||
| Items *openapi3.SchemaRef `json:"items,omitempty" yaml:"items,omitempty"` | ||
| Enum []interface{} `json:"enum,omitempty" yaml:"enum,omitempty"` | ||
| MultipleOf *float64 `json:"multipleOf,omitempty" yaml:"multipleOf,omitempty"` | ||
| Minimum *float64 `json:"minimum,omitempty" yaml:"minimum,omitempty"` | ||
| Maximum *float64 `json:"maximum,omitempty" yaml:"maximum,omitempty"` | ||
| MaxLength *uint64 `json:"maxLength,omitempty" yaml:"maxLength,omitempty"` | ||
| MaxItems *uint64 `json:"maxItems,omitempty" yaml:"maxItems,omitempty"` | ||
| MinLength uint64 `json:"minLength,omitempty" yaml:"minLength,omitempty"` | ||
| MinItems uint64 `json:"minItems,omitempty" yaml:"minItems,omitempty"` | ||
| Default interface{} `json:"default,omitempty" yaml:"default,omitempty"` | ||
| } | ||
|
|
||
| func (parameter Parameter) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of Parameter. | ||
|
|
||
| func (parameter *Parameter) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets Parameter to a copy of data. | ||
|
|
||
| type Parameters []*Parameter | ||
| type PathItem struct{ ... } | ||
| type Response struct{ ... } | ||
|
|
||
| func (ps Parameters) Len() int | ||
|
|
||
| func (ps Parameters) Less(i, j int) bool | ||
|
|
||
| func (ps Parameters) Swap(i, j int) | ||
|
|
||
| type PathItem struct { | ||
| Extensions map[string]interface{} `json:"-" yaml:"-"` | ||
|
|
||
| Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"` | ||
|
|
||
| Delete *Operation `json:"delete,omitempty" yaml:"delete,omitempty"` | ||
| Get *Operation `json:"get,omitempty" yaml:"get,omitempty"` | ||
| Head *Operation `json:"head,omitempty" yaml:"head,omitempty"` | ||
| Options *Operation `json:"options,omitempty" yaml:"options,omitempty"` | ||
| Patch *Operation `json:"patch,omitempty" yaml:"patch,omitempty"` | ||
| Post *Operation `json:"post,omitempty" yaml:"post,omitempty"` | ||
| Put *Operation `json:"put,omitempty" yaml:"put,omitempty"` | ||
| Parameters Parameters `json:"parameters,omitempty" yaml:"parameters,omitempty"` | ||
| } | ||
|
|
||
| func (pathItem *PathItem) GetOperation(method string) *Operation | ||
|
|
||
| func (pathItem PathItem) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of PathItem. | ||
|
|
||
| func (pathItem *PathItem) Operations() map[string]*Operation | ||
|
|
||
| func (pathItem *PathItem) SetOperation(method string, operation *Operation) | ||
|
|
||
| func (pathItem *PathItem) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets PathItem to a copy of data. | ||
|
|
||
| type Response struct { | ||
| Extensions map[string]interface{} `json:"-" yaml:"-"` | ||
|
|
||
| Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"` | ||
|
|
||
| Description string `json:"description,omitempty" yaml:"description,omitempty"` | ||
| Schema *openapi3.SchemaRef `json:"schema,omitempty" yaml:"schema,omitempty"` | ||
| Headers map[string]*Header `json:"headers,omitempty" yaml:"headers,omitempty"` | ||
| Examples map[string]interface{} `json:"examples,omitempty" yaml:"examples,omitempty"` | ||
| } | ||
|
|
||
| func (response Response) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of Response. | ||
|
|
||
| func (response *Response) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets Response to a copy of data. | ||
|
|
||
| type SecurityRequirements []map[string][]string | ||
| type SecurityScheme struct{ ... } | ||
| type T struct{ ... } | ||
|
|
||
| type SecurityScheme struct { | ||
| Extensions map[string]interface{} `json:"-" yaml:"-"` | ||
|
|
||
| Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"` | ||
|
|
||
| Description string `json:"description,omitempty" yaml:"description,omitempty"` | ||
| Type string `json:"type,omitempty" yaml:"type,omitempty"` | ||
| In string `json:"in,omitempty" yaml:"in,omitempty"` | ||
| Name string `json:"name,omitempty" yaml:"name,omitempty"` | ||
| Flow string `json:"flow,omitempty" yaml:"flow,omitempty"` | ||
| AuthorizationURL string `json:"authorizationUrl,omitempty" yaml:"authorizationUrl,omitempty"` | ||
| TokenURL string `json:"tokenUrl,omitempty" yaml:"tokenUrl,omitempty"` | ||
| Scopes map[string]string `json:"scopes,omitempty" yaml:"scopes,omitempty"` | ||
| Tags openapi3.Tags `json:"tags,omitempty" yaml:"tags,omitempty"` | ||
| } | ||
|
|
||
| func (securityScheme SecurityScheme) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of SecurityScheme. | ||
|
|
||
| func (securityScheme *SecurityScheme) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets SecurityScheme to a copy of data. | ||
|
|
||
| type T struct { | ||
| Extensions map[string]interface{} `json:"-" yaml:"-"` | ||
|
|
||
| Swagger string `json:"swagger" yaml:"swagger"` // required | ||
| Info openapi3.Info `json:"info" yaml:"info"` // required | ||
| ExternalDocs *openapi3.ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"` | ||
| Schemes []string `json:"schemes,omitempty" yaml:"schemes,omitempty"` | ||
| Consumes []string `json:"consumes,omitempty" yaml:"consumes,omitempty"` | ||
| Produces []string `json:"produces,omitempty" yaml:"produces,omitempty"` | ||
| Host string `json:"host,omitempty" yaml:"host,omitempty"` | ||
| BasePath string `json:"basePath,omitempty" yaml:"basePath,omitempty"` | ||
| Paths map[string]*PathItem `json:"paths,omitempty" yaml:"paths,omitempty"` | ||
| Definitions map[string]*openapi3.SchemaRef `json:"definitions,omitempty" yaml:"definitions,omitempty"` | ||
| Parameters map[string]*Parameter `json:"parameters,omitempty" yaml:"parameters,omitempty"` | ||
| Responses map[string]*Response `json:"responses,omitempty" yaml:"responses,omitempty"` | ||
| SecurityDefinitions map[string]*SecurityScheme `json:"securityDefinitions,omitempty" yaml:"securityDefinitions,omitempty"` | ||
| Security SecurityRequirements `json:"security,omitempty" yaml:"security,omitempty"` | ||
| Tags openapi3.Tags `json:"tags,omitempty" yaml:"tags,omitempty"` | ||
| } | ||
| T is the root of an OpenAPI v2 document | ||
|
|
||
| func (doc *T) AddOperation(path string, method string, operation *Operation) | ||
|
|
||
| func (doc T) MarshalJSON() ([]byte, error) | ||
| MarshalJSON returns the JSON encoding of T. | ||
|
|
||
| func (doc *T) UnmarshalJSON(data []byte) error | ||
| UnmarshalJSON sets T to a copy of data. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.