 |
Qore Swagger Module Reference
1.1.0
|
|
Qore Swagger Module Reference
1.1.0
|
Allows the definition of a security scheme that can be used by the operations. More...
Public Member Methods | |
| constructor (hash oh) | |
| Constructor. More... | |
 Public Member Methods inherited from Swagger::ObjectBase | |
| constructor () | |
| Constructor. | |
| constructor (hash oh) | |
| Constructor. More... | |
| constructor (ObjectBase other) | |
| copy constructor | |
| initialize (hash oh) | |
| Initialize. More... | |
Public Attributes | |
| *string | authorizationUrl |
| The authorization URL to be used for this flow. This SHOULD be in the form of a URL. More... | |
| *string | desc |
| A short description for security scheme. | |
| *string | flow |
| The flow used by the OAuth2 security scheme. More... | |
| *string | inLoc |
The location of the API key. Valid values are "query" or "header". More... | |
| *string | name |
| The name of the header or query parameter to be used. More... | |
| *ScopesObject | scopes |
| The available scopes for the OAuth2 security scheme. More... | |
| *string | tokenUrl |
| The token URL to be used for this flow. This SHOULD be in the form of a URL. More... | |
| string | type |
Required. The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2". | |
| Public Attributes inherited from Swagger::ObjectBase | |
| hash | vendorExtensions |
| Allows extensions to the Swagger Schema. More... | |
Allows the definition of a security scheme that can be used by the operations.
Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).
| Swagger::SecuritySchemeObject::constructor | ( | hash | oh | ) |
Constructor.
| oh | deserialized hash from the source schema description describing a security schema that can be used by REST API operations |
| INVALID-FIELD-TYPE | field has invalid type |
| INVALID-FLOW | invalid OAuth2 flow value |
| INVALID-APIKEY-LOCATION | invalid 'in' (location) value |
| INVALID-SCHEME-TYPE | invalid security scheme type; see type |
| REQUIRED-FIELD-MISSING | required field is missing |
| *string Swagger::SecuritySchemeObject::authorizationUrl |
The authorization URL to be used for this flow. This SHOULD be in the form of a URL.
Required when type is "oauth2" and flow is "implicit" or "accessCode".
| *string Swagger::SecuritySchemeObject::flow |
The flow used by the OAuth2 security scheme.
Required when type is "oauth2".
Valid values are "implicit", "password", "application" or "accessCode".
| *string Swagger::SecuritySchemeObject::inLoc |
The location of the API key. Valid values are "query" or "header".
Required when type is "apiKey".
| *string Swagger::SecuritySchemeObject::name |
The name of the header or query parameter to be used.
Required when type is "apiKey".
| *ScopesObject Swagger::SecuritySchemeObject::scopes |
The available scopes for the OAuth2 security scheme.
Required when type is "oauth2".
A hash in the form of Scopes Object mapping scope names to short descriptions of them. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#scopesObject Keys are scope names. Values are short string descriptions.
| *string Swagger::SecuritySchemeObject::tokenUrl |
The token URL to be used for this flow. This SHOULD be in the form of a URL.
Required when type is "oauth2" and flow is one of "password", "application" or "accessCode".