mirror of
https://github.com/LukeHagar/libopenapi.git
synced 2025-12-09 20:47:44 +00:00
Added support for unevaluatedProperties as Schema and bool #118
Also ran `gofmt` across the entire project. Things need cleaning up. Signed-off-by: Dave Shanley <dave@quobix.com>
This commit is contained in:
@@ -16,29 +16,39 @@ import (
|
||||
// There are five possible parameter types.
|
||||
//
|
||||
// Path
|
||||
// Used together with Path Templating, where the parameter value is actually part of the operation's URL.
|
||||
// This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.
|
||||
//
|
||||
// Used together with Path Templating, where the parameter value is actually part of the operation's URL.
|
||||
// This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.
|
||||
//
|
||||
// Query
|
||||
// Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
|
||||
//
|
||||
// Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
|
||||
//
|
||||
// Header
|
||||
// Custom headers that are expected as part of the request.
|
||||
//
|
||||
// Custom headers that are expected as part of the request.
|
||||
//
|
||||
// Body
|
||||
// The payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter.
|
||||
// The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only.
|
||||
// Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation.
|
||||
//
|
||||
// The payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter.
|
||||
// The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only.
|
||||
// Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation.
|
||||
//
|
||||
// Form
|
||||
// Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded, multipart/form-data
|
||||
// or both are used as the content type of the request (in Swagger's definition, the consumes property of an operation).
|
||||
// This is the only parameter type that can be used to send files, thus supporting the file type. Since form parameters
|
||||
// are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form
|
||||
// parameters have a different format based on the content-type used (for further details,
|
||||
// consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):
|
||||
// application/x-www-form-urlencoded - Similar to the format of Query parameters but as a payload. For example,
|
||||
// foo=1&bar=swagger - both foo and bar are form parameters. This is normally used for simple parameters that are
|
||||
// being transferred.
|
||||
// multipart/form-data - each parameter takes a section in the payload with an internal header. For example, for
|
||||
// the header Content-Disposition: form-data; name="submit-name" the name of the parameter is
|
||||
// submit-name. This type of form parameters is more commonly used for file transfers
|
||||
//
|
||||
// Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded, multipart/form-data
|
||||
// or both are used as the content type of the request (in Swagger's definition, the consumes property of an operation).
|
||||
// This is the only parameter type that can be used to send files, thus supporting the file type. Since form parameters
|
||||
// are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form
|
||||
// parameters have a different format based on the content-type used (for further details,
|
||||
// consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4):
|
||||
// application/x-www-form-urlencoded - Similar to the format of Query parameters but as a payload. For example,
|
||||
// foo=1&bar=swagger - both foo and bar are form parameters. This is normally used for simple parameters that are
|
||||
// being transferred.
|
||||
// multipart/form-data - each parameter takes a section in the payload with an internal header. For example, for
|
||||
// the header Content-Disposition: form-data; name="submit-name" the name of the parameter is
|
||||
// submit-name. This type of form parameters is more commonly used for file transfers
|
||||
//
|
||||
// https://swagger.io/specification/v2/#parameterObject
|
||||
type Parameter struct {
|
||||
Name string
|
||||
|
||||
Reference in New Issue
Block a user