Data.OpenApi.Internal

Provides metadata about the API. The metadata can be used by the clients if needed.

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 /.

The available paths and operations for the API.

An element to hold various schemas for the specification.

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.

A list of tags used by the specification 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.

Additional external documentation.

The spec of OpenApi this spec adheres to. Must be between lowerOpenApiSpecVersion and upperOpenApiSpecVersion

The title of the API.

A short description of the API. CommonMark syntax MAY be used for rich text representation.

A URL to the Terms of Service for the API. MUST be in the format of a URL.

The contact information for the exposed API.

The license information for the exposed API.

The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).

The identifying name of the contact person/organization.

The URL pointing to the contact information.

The email address of the contact person/organization.

The license name used for the API.

A URL to the license used for the API.

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}.

An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.

A map between a variable name and its value. The value is used for substitution in the server's URL template.

An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.

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 _serverVariableEnum is defined, the value SHOULD exist in the enum's values.

An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.

An optional, string summary, intended to apply to all operations in this path.

An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.

A definition of a GET operation on this path.

A definition of a PUT operation on this path.

A definition of a POST operation on this path.

A definition of a DELETE operation on this path.

A definition of a OPTIONS operation on this path.

A definition of a HEAD operation on this path.

A definition of a PATCH operation on this path.

A definition of a TRACE operation on this path.

An alternative server array to service all operations in this path.

A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.

A verbose explanation of the operation behavior. CommonMark syntax can be used for rich text representation.

Additional external documentation for this operation.

Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

A list of parameters that are applicable for this operation. If a parameter is already defined at the PathItem, the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.

The list of possible responses as they are returned from executing this operation.

A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses.

Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is False.

A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level security. To remove a top-level security declaration, Just [] can be used.

An alternative server array to service this operation. If an alternative server object is specified at the PathItem Object or Root level, it will be overridden by this value.

A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

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/*

Determines if the request body is required in the request. Defaults to False.

Example of the media type. The example object SHOULD be in the correct format as specified by the media type.

Examples of the media type. Each example object SHOULD match the media type and specified schema if present.

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.

The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. 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.

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.

Describes how a specific property value will be serialized depending on its type. See Param 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.

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.

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@.

The name of the parameter. Parameter names are case sensitive.

A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.

Determines whether this parameter is mandatory. If the parameter is in "path", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is False.

Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.

The location of the parameter.

Sets the ability to pass empty-valued parameters. This is valid only for ParamQuery parameters and allows sending a parameter with an empty value. Default value is false.

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 _paramIn value of ParamQuery. The default value is False.

Parameter schema.

Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of _paramIn): for ParamQuery - StyleForm; for ParamPath - StyleSimple; for ParamHeader - StyleSimple; for ParamCookie - StyleForm.

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.

Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The _paramExample field is mutually exclusive of the _paramExamples 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.

Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The _paramExamples field is mutually exclusive of the _paramExample field. Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.

Short description for the example.

Long description for the example. CommonMark syntax MAY be used for rich text representation.

Embedded literal example. The _exampleValue field and _exampleExternalValue 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.

A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The _exampleValue field and _exampleExternalValue field are mutually exclusive.

A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the _linkOperationId field, and MUST point to an Operation Object. Relative _linkOperationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.

The name of an existing, resolvable OAS operation, as defined with a unique _operationOperationId. This field is mutually exclusive of the _linkOperationRef field.

A map representing parameters to pass to an operation as specified with _linkOperationId or identified via _linkOperationRef. 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).

A literal value or {expression} to use as a request body when calling the target operation.

A description of the link.

A server object to be used by the target operation.