NSwag.Core

An implementation of an observable dictionary.

The type of the key. The type of the value.

Initializes a new instance of the class.

Initializes a new instance of the class.

The dictionary to initialize this dictionary.

Initializes a new instance of the class.

The comparer.

Initializes a new instance of the class.

The capacity.

Initializes a new instance of the class.

The dictionary to initialize this dictionary. The comparer.

Initializes a new instance of the class.

The capacity. The comparer.

Gets the underlying dictonary.

Adds multiple key-value pairs the the dictionary.

The key-value pairs.

Inserts a key-value pair into the dictionary.

The key. The value. If true and key already exists then an exception is thrown.

Called when the property has changed.

Name of the property.

Called when the collection has changed.

Called when the collection has changed.

The action. The changed item.

Called when the collection has changed.

The action. The new item. The old item.

Called when the collection has changed.

The action. The new items.

Adds the specified key.

The key. The value.

Determines whether the specified key contains key.

The key.

Gets an containing the keys of the .

Removes the specified key.

The key. key

Tries the get value.

The key. The value.

Gets an containing the values in the .

Gets or sets the TValue with the specified key.

The TValue. The key.

Adds the specified item.

The item.

Removes all items from the .

Initializes the specified key value pairs.

The key value pairs.

Initializes the specified key value pairs.

The key value pairs.

Determines whether [contains] [the specified key].

The key.

Removes the specified key.

The key.

Gets a value indicating whether the object has a fixed size.

Determines whether [contains] [the specified item].

The item.

Copies to.

The array. Index of the array.

Copies to.

The array. The index.

Gets the number of elements contained in the .

Gets a value indicating whether access to the is synchronized (thread safe).

Gets an object that can be used to synchronize access to the .

Gets a value indicating whether the is read-only.

Removes the specified item.

The item.

Returns an enumerator that iterates through the collection.

A that can be used to iterate through the collection.

Returns an enumerator that iterates through the collection.

A that can be used to iterate through the collection.

Occurs when the collection has changed.

Occurs when a property has changed.

Contains HTTP utilities.

Checks whether the given HTTP status code indicates success.

The HTTP status code. true if success.

Specifies a schema which is expected.

Gets or sets the description.

Gets or sets the schema.

Describes an OpenAPI callback.

Gets the actual callback, either this or the referenced example.

Container for reusable components (OpenAPI only).

Gets or sets the types.

Gets or sets the responses which can be used for all operations.

Gets or sets the parameters which can be used for all operations.

Gets or sets the headers.

Gets or sets the types.

Gets or sets the security definitions.

Gets or sets the security definitions.

Gets or sets the security definitions.

The web service contact description.

Gets or sets the name.

Gets or sets the contact URL.

Gets or sets the contact email.

Describes a JSON web service.

Initializes a new instance of the class.

Gets the NSwag toolchain version.

Gets or sets the preferred schema type.

Gets or sets the document path (URI or file path).

Gets or sets the Swagger generator information.

Gets or sets the Swagger specification version being used (Swagger only).

Gets or sets the OpenAPI specification version being used (OpenAPI only).

Gets or sets the metadata about the API.

Gets or sets the servers (OpenAPI only).

Gets or sets the operations.

Gets or sets the components.

Gets or sets a security description.

Gets or sets the description.

Gets the base URL of the web service.

Gets or sets the external documentation.

Converts the Swagger specification to JSON.

The JSON string.

Converts the description object to JSON.

The schema type. The JSON string.

Converts the description object to JSON.

The schema type. The formatting. The JSON string.

Creates a Swagger specification from a JSON string.

The JSON data. The cancellation token. The .

Creates a Swagger specification from a JSON string.

The JSON data. The document path (URL or file path) for resolving relative document references. The cancellation token. The .

Creates a Swagger specification from a JSON string.

The JSON data. The document path (URL or file path) for resolving relative document references. The expected schema type which is used when the type cannot be determined. The cancellation token. The .

Creates a Swagger specification from a JSON string.

The JSON data. The document path (URL or file path) for resolving relative document references. The expected schema type which is used when the type cannot be determined. The JSON reference resolver factory. The cancellation token. The .

Creates a Swagger specification from a JSON file.

The file path. The cancellation token. The .

Creates a Swagger specification from an URL.

The URL. The cancellation token. The .

Gets the operations.

Generates missing or non-unique operation IDs.

Creates the serializer contract resolver based on the .

The schema type. The settings.

Gets or sets the host (name or ip) serving the API (Swagger only).

Gets or sets the base path on which the API is served, which is relative to the .

Gets or sets the schemes.

Gets or sets a list of MIME types the operation can consume.

Gets or sets a list of MIME types the operation can produce.

Gets or sets the types (Swagger only).

Gets or sets the parameters which can be used for all operations (Swagger only).

Gets or sets the responses which can be used for all operations (Swagger only).

Gets or sets the security definitions (Swagger only).

Describes the OpenApi encoding.

Gets or sets the encoding type.

Gets or sets the headers.

Gets or sets the encoding type.

Gets or sets a value indicating whether values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map.

Gets or sets a value indicating whether the parameter value should allow reserved characters, as defined by RFC3986.

The Swagger example (OpenAPI only).

Gets or sets the example's description.

Gets or sets the example's description.

Gets or sets the example's value.

Gets or sets the example's external value.

Gets the actual example, either this or the referenced example.

The external documentation description.

Gets or sets the description.

Gets or sets the documentation URL.

A header.

A collection of headers.

The web service description.

Gets or sets the title.

Gets or sets the description.

Gets or sets the terms of service.

Gets or sets the contact information.

Gets or sets the license information.

Gets or sets the API version.

The license information.

Gets or sets the name.

Gets or sets the license URL.

The OpenApi link (OpenAPI only).

Gets or sets the example's description.

Gets or sets the example's description.

Gets or sets the example's value.

Gets or sets the example's external value.

Gets or sets the example's external value.

Gets or sets the server.

Gets the actual link, either this or the referenced example.

The Swagger media type (OpenAPI only).

Gets or sets the schema.

Gets or sets the example.

Gets or sets the headers (OpenAPI only).

Gets or sets the example's value.

Enumeration of the OAuth2 flows.

An undefined flow.

Use implicit flow.

Use password flow.

Use application flow.

Use access code flow.

Configuration for an OAuth flow.

Gets or sets the authorization URL to be used for this flow.

Gets or sets the token URL to be used for this flow.

Gets or sets the token URL to be used for this flow.

Gets the available scopes for the OAuth2 security scheme.

Configuration information for the supported flow types.

Gets or sets the configuration for the OAuth Implicit Code flow.

Gets or sets the configuration for the OAuth Resource Owner Password flow.

Gets or sets the configuration for the OAuth Client Credentials flow.

Gets or sets the configuration for the OAuth Authorization Code flow.

Describes a JSON web service operation.

Initializes a new instance of the class.

Gets the parent operations list.

Gets or sets the tags.

Gets or sets the summary of the operation.

Gets or sets the long description of the operation.

Gets or sets the external documentation.

Gets or sets the operation ID (unique name).

Gets or sets a list of MIME types the operation can consume.

Gets or sets a list of MIME types the operation can produce.

Gets or sets the parameters.

Gets or sets the request body (OpenAPI only).

Gets the actual parameters (a combination of all inherited and local parameters).

Gets or sets the HTTP Status Code/Response pairs.

Gets or sets the schemes.

Gets or sets the callbacks (OpenAPI only).

Gets or sets a value indicating whether the operation is deprecated.

Gets or sets a security description.

Gets or sets the servers (OpenAPI only).

Gets the list of MIME types the operation can consume, either from the operation or from the .

Gets the list of MIME types the operation can produce, either from the operation or from the .

Gets the actual schemes, either from the operation or from the .

Gets the responses from the operation and from the and dereferences them if necessary.

Gets the actual security description, either from the operation or from the .

Adds a consumes MIME type if it does not yet exists.

The MIME type.

Gets or sets the parameters.

Flattened information about an operation.

Gets or sets the relative URL path.

Gets or sets the HTTP method.

Gets or sets the operation.

Enumeration of the available HTTP methods.

An undefined method.

The HTTP GET method.

The HTTP POST method.

The HTTP PUT method.

The HTTP DELETE method.

The HTTP OPTIONS method.

The HTTP HEAD method.

The HTTP PATCH method.

The HTTP TRACE method (OpenAPI only).

Describes an operation parameter.

Gets or sets the name.

Gets or sets a original name property x-originalName which is often used in code generation (default: null).

Gets or sets the kind of the parameter.

Gets or sets the style of the parameter (OpenAPI only).

Gets or sets the explode setting for the parameter (OpenAPI only).

Gets or sets a value indicating whether the parameter is required (default: false).

Gets or sets a value indicating whether passing empty-valued parameters is allowed (default: false).

Gets or sets the description.

Gets the actual parameter.

Gets or sets the format of the array if type array is used.

Gets or sets the examples (OpenAPI only).

Gets or sets the schema which is only available when == body.

Gets or sets the custom schema which is used when != body.

Gets or sets the name.

Gets the actual schema, either the parameter schema itself (or its reference) or the property when == body.

The schema reference path is not resolved.

Gets a value indicating whether the validated data can be null.

The schema type. The result.

Gets a value indicating whether this is an XML body parameter.

Gets a value indicating whether this is a binary body parameter.

Gets a value indicating whether a binary body parameter allows multiple mime types.

Defines the collectionFormat of a parameter.

An undefined format.

Comma separated values "foo, bar".

Space separated values "foo bar".

Tab separated values "foo\tbar".

Pipe separated values "foo|bar".

Corresponds to multiple parameter instances instead of multiple values for a single instance "foo=bar&foo=baz".

Enumeration of the parameter kinds.

An undefined kind.

A JSON object as POST or PUT body (only one parameter of this type is allowed).

A query key-value pair.

An URL path placeholder.

A HTTP header parameter.

A form data parameter.

A model binding parameter (either form data, path or query; by default query; generated by Swashbuckle).

A cookie.

Enumeration of the parameter kinds.

An undefined kind.

Comma-separated values. For Path parameters. Corresponds to the {param_name} URI template

Dot-prefixed values, also known as label expansion. For Path parameters. Corresponds to the {.param_name} URI template

Semicolon-prefixed values, also known as path-style expansion. For path parameters. Corresponds to the {;param_name} URI template

Ampersand-separated values. Also known as form-style query expansion. Corresponds to the {?param_name} URI template.

Space-separated array values. Same as collectionFormat: ssv in OpenAPI 2.0. Has effect only for non-exploded arrays (explode: false), that is, the space separates the array values if the array is a single parameter, as in arr=a b c.

Pipeline-separated array values. Same as collectionFormat: pipes in OpenAPI 2.0. Has effect only for non-exploded arrays (explode: false), that is, the pipe separates the array values if the array is a single parameter, as in arr=a|b|c.

Simple way of rendering nested objects using form parameters (applies to objects only)

An OpenApi path, the key is usually a value of .

Initializes a new instance of the class.

Gets the parent .

Gets the actual response, either this or the referenced response.

Gets or sets the summary (OpenApi only).

Gets or sets the description (OpenApi only).

Gets or sets the servers (OpenAPI only).

Gets or sets the parameters.

Gets or sets the extension data (i.e. additional properties which are not directly defined by the JSON object).

Gets the document path (URI or file path) for resolving relative references.

Gets or sets the type reference path ($ref).

Gets or sets the referenced object.

Gets or sets the referenced object.

The OpenApi request body (OpenAPI only).

Initializes a new instance of the class.

Gets or sets the name.

Gets or sets the description.

Gets or sets the descriptions of potential response payloads (OpenApi only).

Gets or sets the example's external value.

Gets or sets the name.

Gets the actual name of the request body parameter.

The Swagger response.

Gets or sets the extension data (i.e. additional properties which are not directly defined by the JSON object).

Gets the parent .

Gets the actual response, either this or the referenced response.

Gets or sets the response's description.

Gets or sets the headers.

Sets a value indicating whether the response can be null (use IsNullable() to get a parameter's nullability).

The Swagger spec does not support null in schemas, see https://github.com/OAI/OpenAPI-Specification/issues/229

Gets or sets the expected child schemas of the base schema (can be used for generating enhanced typings/documentation).

Gets or sets the descriptions of potential response payloads (OpenApi only).

Gets or sets the links that can be followed from the response (OpenApi only).

Gets or sets the response schema (Swagger only).

Gets or sets the headers (Swagger only).

Determines whether the specified null handling is nullable (fallback value: false).

The schema type. The result.

Determines whether the specified null handling is nullable.

The schema type. The fallback value when 'x-nullable' is not defined. The result.

Checks whether this is a binary/file response.

The operation the response belongs to. The result.

Checks whether this is an empty response.

The operation the response belongs to. The result.

The enumeration of Swagger protocol schemes.

An undefined schema.

The HTTP schema.

The HTTPS schema.

The WS schema.

The WSS schema.

Appends a JSON Schema to the Definitions of a Swagger document.

Initializes a new instance of the class.

The Swagger document. The settings. is

Appends the schema to the root object.

The schema to append. The type name hint.

Specifies the location of the API Key.

The API key kind is not defined.

In a query parameter.

In the HTTP header.

In the HTTP cookie (OpenAPI only).

The operation security requirements.

The definition of a security scheme that can be used by the operations.

Gets or sets the type of the security scheme.

Changes the type to and the to "basic" set to .

Gets or sets the short description for security scheme.

Gets or sets the name of the header or query parameter to be used to transmit the API key.

Gets or sets the type of the API key.

Gets or sets name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235 (OpenAPI only).

Gets or sets a hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes (OpenAPI only).

Gets or sets the OpenId Connect URL to discover OAuth2 configuration values (OpenAPI only).

Gets or sets the configuration information for the supported flow types (OpenAPI only).

Gets or sets the used by the OAuth2 security scheme (Swagger only).

Gets or sets the authorization URL to be used for this flow (Swagger only).

Gets or sets the token URL to be used for this flow (Swagger only).

Gets the available scopes for the OAuth2 security scheme (Swagger only).

The security scheme is not defined.

Basic authentication.

API key authentication.

OAuth2 authentication.

HTTP authentication (OpenAPI only).

OpenIdConnect authentication (OpenAPI only).

Describes an OpenAPI server.

Gets or sets the URL of the server.

Gets or sets the description of the server.

Gets or sets the variables of the server.

Gets a value indicating whether the server description is valid.

Describes an OpenAPI server variable.

Gets or sets the enum of the server.

Gets or sets the variables of the server.

Gets or sets the description of the server.

Describes a Swagger tag.

Gets or sets the name.

Gets or sets the description.

Gets or sets the external documentation.