10030 lines
469 KiB
XML
10030 lines
469 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Microsoft.OpenApi</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Microsoft.OpenApi.DisplayAttribute">
|
|
<summary>
|
|
Represents the Open Api Data type metadata attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.DisplayAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.DisplayAttribute"/> class.
|
|
</summary>
|
|
<param name="name">The display name.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.DisplayAttribute.Name">
|
|
<summary>
|
|
The display Name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiException">
|
|
<summary>
|
|
Exception type representing exceptions in the Open API library.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiException.#ctor">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiException"/> class with default values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiException.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiException"/> class with an error message.
|
|
</summary>
|
|
<param name="message">The plain text error message for this exception.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiException"/> class with an error message and an inner exception.
|
|
</summary>
|
|
<param name="message">The plain text error message for this exception.</param>
|
|
<param name="innerException">The inner exception that is the cause of this exception to be thrown.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiException.Pointer">
|
|
<summary>
|
|
The reference pointer. This is a fragment identifier used to point to where the error occurred in the document.
|
|
If the document has been parsed as JSON/YAML then the identifier will be a
|
|
JSON Pointer as per https://tools.ietf.org/html/rfc6901
|
|
If the document fails to parse as JSON/YAML then the fragment will be based on
|
|
a text/plain pointer as defined in https://tools.ietf.org/html/rfc5147
|
|
Currently only line= is provided because using char= causes tests to break due to CR/LF and LF differences
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiReaderException">
|
|
<summary>
|
|
Defines an exception indicating OpenAPI Reader encountered an issue while reading.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReaderException.#ctor">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiReaderException"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReaderException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiReaderException"/> class with a custom message.
|
|
</summary>
|
|
<param name="message">Plain text error message for this exception.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReaderException.#ctor(System.String,Microsoft.OpenApi.Reader.ParsingContext)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiReaderException"/> class with a custom message.
|
|
</summary>
|
|
<param name="message">Plain text error message for this exception.</param>
|
|
<param name="context">Context of current parsing process.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReaderException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiReaderException"/> class with a custom message and inner exception.
|
|
</summary>
|
|
<param name="message">Plain text error message for this exception.</param>
|
|
<param name="innerException">Inner exception that caused this exception to be thrown.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiUnsupportedSpecVersionException">
|
|
<summary>
|
|
Defines an exception indicating OpenAPI Reader encountered an unsupported specification version while reading.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUnsupportedSpecVersionException.#ctor(System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiUnsupportedSpecVersionException"/> class with a specification version.
|
|
</summary>
|
|
<param name="specificationVersion">Version that caused this exception to be thrown.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUnsupportedSpecVersionException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiUnsupportedSpecVersionException"/> class with a specification version and
|
|
inner exception.
|
|
</summary>
|
|
<param name="specificationVersion">Version that caused this exception to be thrown.</param>
|
|
<param name="innerException">Inner exception that caused this exception to be thrown.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUnsupportedSpecVersionException.SpecificationVersion">
|
|
<summary>
|
|
The unsupported specification version.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWriterException">
|
|
<summary>
|
|
Exception type representing exceptions in the OpenAPI writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterException.#ctor">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiWriterException"/> class with default values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterException.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiWriterException"/> class with an error message.
|
|
</summary>
|
|
<param name="message">The plain text error message for this exception.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiWriterException"/> class with an error message and an inner exception.
|
|
</summary>
|
|
<param name="message">The plain text error message for this exception.</param>
|
|
<param name="innerException">The inner exception that is the cause of this exception to be thrown.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.BodyExpression">
|
|
<summary>
|
|
Body expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.BodyExpression.Body">
|
|
<summary>
|
|
body string
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.BodyExpression.PointerPrefix">
|
|
<summary>
|
|
Prefix for a pointer
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BodyExpression.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.BodyExpression"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BodyExpression.#ctor(Microsoft.OpenApi.JsonPointer)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.BodyExpression"/> class.
|
|
</summary>
|
|
<param name="pointer">a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901).</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BodyExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BodyExpression.Fragment">
|
|
<summary>
|
|
Gets the fragment string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.CompositeExpression">
|
|
<summary>
|
|
String literal with embedded expressions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CompositeExpression.ContainedExpressions">
|
|
<summary>
|
|
Expressions embedded into string literal
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.CompositeExpression.#ctor(System.String)">
|
|
<summary>
|
|
Create a composite expression from a string literal with an embedded expression
|
|
</summary>
|
|
<param name="expression"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CompositeExpression.Expression">
|
|
<summary>
|
|
Return original string literal with embedded expression
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.HeaderExpression">
|
|
<summary>
|
|
Header expression, The token identifier in header is case-insensitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.HeaderExpression.Header">
|
|
<summary>
|
|
header. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.HeaderExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.HeaderExpression"/> class.
|
|
</summary>
|
|
<param name="token">The token string, it's case-insensitive.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.HeaderExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.HeaderExpression.Token">
|
|
<summary>
|
|
Gets the token string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MethodExpression">
|
|
<summary>
|
|
Method expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.MethodExpression.Method">
|
|
<summary>
|
|
$method. string
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MethodExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MethodExpression.#ctor">
|
|
<summary>
|
|
Private constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.PathExpression">
|
|
<summary>
|
|
Path expression, the name in path is case-sensitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.PathExpression.Path">
|
|
<summary>
|
|
path. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.PathExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.PathExpression"/> class.
|
|
</summary>
|
|
<param name="name">The name string, it's case-insensitive.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.PathExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.PathExpression.Name">
|
|
<summary>
|
|
Gets the name string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.QueryExpression">
|
|
<summary>
|
|
Query expression, the name in query is case-sensitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.QueryExpression.Query">
|
|
<summary>
|
|
query. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.QueryExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.QueryExpression"/> class.
|
|
</summary>
|
|
<param name="name">The name string, it's case-insensitive.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.QueryExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.QueryExpression.Name">
|
|
<summary>
|
|
Gets the name string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.RequestExpression">
|
|
<summary>
|
|
$request. expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.RequestExpression.Request">
|
|
<summary>
|
|
$request. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RequestExpression.#ctor(Microsoft.OpenApi.SourceExpression)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.RequestExpression"/> class.
|
|
</summary>
|
|
<param name="source">The source of the request.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.RequestExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.RequestExpression.Source">
|
|
<summary>
|
|
The <see cref="T:Microsoft.OpenApi.SourceExpression"/> expression.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ResponseExpression">
|
|
<summary>
|
|
$response. expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ResponseExpression.Response">
|
|
<summary>
|
|
$response. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ResponseExpression.#ctor(Microsoft.OpenApi.SourceExpression)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.ResponseExpression"/> class.
|
|
</summary>
|
|
<param name="source">The source of the response.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.ResponseExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.ResponseExpression.Source">
|
|
<summary>
|
|
The <see cref="T:Microsoft.OpenApi.SourceExpression"/> expression.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.RuntimeExpression">
|
|
<summary>
|
|
Base class for the Open API runtime expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.RuntimeExpression.Prefix">
|
|
<summary>
|
|
The dollar sign prefix for a runtime expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.RuntimeExpression.Expression">
|
|
<summary>
|
|
The expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpression.Build(System.String)">
|
|
<summary>
|
|
Build the runtime expression from input string.
|
|
</summary>
|
|
<param name="expression">The runtime expression.</param>
|
|
<returns>The built runtime expression object.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpression.GetHashCode">
|
|
<summary>
|
|
GetHashCode implementation for IEquatable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpression.Equals(System.Object)">
|
|
<summary>
|
|
Equals implementation for IEquatable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpression.Equals(Microsoft.OpenApi.RuntimeExpression)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpression.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.SourceExpression">
|
|
<summary>
|
|
Source expression.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.SourceExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.QueryExpression"/> class.
|
|
</summary>
|
|
<param name="value">The value string.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SourceExpression.Value">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.SourceExpression.Build(System.String)">
|
|
<summary>
|
|
Build the source expression from input string.
|
|
</summary>
|
|
<param name="expression">The source expression.</param>
|
|
<returns>The built source expression.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.StatusCodeExpression">
|
|
<summary>
|
|
StatusCode expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.StatusCodeExpression.StatusCode">
|
|
<summary>
|
|
$statusCode string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.StatusCodeExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.StatusCodeExpression.#ctor">
|
|
<summary>
|
|
Private constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.UrlExpression">
|
|
<summary>
|
|
Url expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.UrlExpression.Url">
|
|
<summary>
|
|
$url string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.UrlExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.UrlExpression.#ctor">
|
|
<summary>
|
|
Private constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.EnumExtensions">
|
|
<summary>
|
|
Enumeration type extension methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.EnumExtensions.GetAttributeOfType``1(System.Enum)">
|
|
<summary>
|
|
Gets an attribute on an enum field value.
|
|
</summary>
|
|
<typeparam name="T">The type of the attribute to retrieve.</typeparam>
|
|
<param name="enumValue">The enum value.</param>
|
|
<returns>
|
|
The attribute of the specified type or null.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.EnumExtensions.GetDisplayName(System.Enum)">
|
|
<summary>
|
|
Gets the enum display name.
|
|
</summary>
|
|
<param name="enumValue">The enum value.</param>
|
|
<returns>
|
|
Use <see cref="T:Microsoft.OpenApi.DisplayAttribute"/> if it exists.
|
|
Otherwise, use the standard string representation.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.JsonNodeExtension">
|
|
<summary>
|
|
A wrapper class for JsonNode
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonNodeExtension.#ctor(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/> class.
|
|
</summary>
|
|
<param name="jsonNode"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonNodeExtension.Node">
|
|
<summary>
|
|
Gets the underlying JsonNode.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonNodeExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Writes out the JsonNodeExtension type.
|
|
</summary>
|
|
<param name="writer"></param>
|
|
<param name="specVersion"></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiElementExtensions">
|
|
<summary>
|
|
Extension methods that apply across all OpenAPIElements
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiElementExtensions.Validate(Microsoft.OpenApi.IOpenApiElement,Microsoft.OpenApi.ValidationRuleSet)">
|
|
<summary>
|
|
Validate element and all child elements
|
|
</summary>
|
|
<param name="element">Element to validate</param>
|
|
<param name="ruleSet">Optional set of rules to use for validation</param>
|
|
<returns>An IEnumerable of errors. This function will never return null.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExtensibleExtensions">
|
|
<summary>
|
|
Extension methods to verify validity and add an extension to Extensions property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleExtensions.AddExtension``1(``0,System.String,Microsoft.OpenApi.IOpenApiExtension)">
|
|
<summary>
|
|
Add extension into the Extensions
|
|
</summary>
|
|
<typeparam name="T"><see cref="T:Microsoft.OpenApi.IOpenApiExtensible"/>.</typeparam>
|
|
<param name="element">The extensible Open API element. </param>
|
|
<param name="name">The extension name.</param>
|
|
<param name="any">The extension value.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiReferenceableExtensions">
|
|
<summary>
|
|
Extension methods for resolving references on <see cref="T:Microsoft.OpenApi.IOpenApiReferenceable"/> elements.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceableExtensions.ResolveReference(Microsoft.OpenApi.IOpenApiReferenceable,Microsoft.OpenApi.JsonPointer)">
|
|
<summary>
|
|
Resolves a JSON Pointer with respect to an element, returning the referenced element.
|
|
</summary>
|
|
<param name="element">The referenceable Open API element on which to apply the JSON pointer</param>
|
|
<param name="pointer">a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901).</param>
|
|
<returns>The element pointed to by the JSON pointer.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSerializableExtensions">
|
|
<summary>
|
|
Extension methods for <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> serialization.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serialize the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document (JSON) using the given stream and specification version.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="stream">The output stream.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsYamlAsync``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document (YAML) using the given stream and specification version.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="stream">The output stream.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document using
|
|
the given stream, specification version and the format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="stream">The given stream.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="format">The output format (JSON or YAML).</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,System.String,Microsoft.OpenApi.OpenApiWriterSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document using
|
|
the given stream, specification version and the format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="stream">The given stream.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="format">The output format (JSON or YAML).</param>
|
|
<param name="settings">Provide configuration settings for controlling writing output</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync``1(``0,Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to Open API document using the given specification version and writer.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="writer">The output writer.</param>
|
|
<param name="specVersion">Version of the specification the output should conform to</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsJsonAsync``1(``0,Microsoft.OpenApi.OpenApiSpecVersion,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document as a string in JSON format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsYamlAsync``1(``0,Microsoft.OpenApi.OpenApiSpecVersion,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document as a string in YAML format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSerializableExtensions.SerializeAsync``1(``0,Microsoft.OpenApi.OpenApiSpecVersion,System.String,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/> to the Open API document as a string in the given format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
<param name="format">Open API document format.</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiServerExtensions">
|
|
<summary>
|
|
Extension methods for <see cref="T:Microsoft.OpenApi.OpenApiServer"/> serialization.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerExtensions.ReplaceServerUrlVariables(Microsoft.OpenApi.OpenApiServer,System.Collections.Generic.Dictionary{System.String,System.String})">
|
|
<summary>
|
|
Replaces URL variables in a server's URL
|
|
</summary>
|
|
<param name="server">The OpenAPI server object</param>
|
|
<param name="values">The server variable values that will be used to replace the default values.</param>
|
|
<returns>A URL with the provided variables substituted.</returns>
|
|
<exception cref="T:System.ArgumentException">
|
|
Thrown when:
|
|
1. A substitution has no valid value in both the supplied dictionary and the default
|
|
2. A substitution's value is not available in the enum provided
|
|
</exception>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiTypeMapper">
|
|
<summary>
|
|
Extension methods for <see cref="T:System.Type"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.ToIdentifiers(System.Nullable{Microsoft.OpenApi.JsonSchemaType})">
|
|
<summary>
|
|
Maps a JsonSchema data type to an identifier.
|
|
</summary>
|
|
<param name="schemaType"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.ToIdentifiers(Microsoft.OpenApi.JsonSchemaType)">
|
|
<summary>
|
|
Maps a JsonSchema data type to an identifier.
|
|
</summary>
|
|
<param name="schemaType"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.ToFirstIdentifier(Microsoft.OpenApi.JsonSchemaType)">
|
|
<summary>
|
|
Returns the first identifier from a string array.
|
|
</summary>
|
|
<param name="schemaType"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.ToSingleIdentifier(Microsoft.OpenApi.JsonSchemaType)">
|
|
<summary>
|
|
Returns a single identifier from an array with only one item.
|
|
</summary>
|
|
<param name="schemaType"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.ToJsonSchemaType(System.String)">
|
|
<summary>
|
|
Converts a schema type's identifier into the enum equivalent
|
|
</summary>
|
|
<param name="identifier"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.ToJsonSchemaType(System.String[])">
|
|
<summary>
|
|
Converts a schema type's identifier into the enum equivalent
|
|
</summary>
|
|
<param name="identifier"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.MapTypeToOpenApiPrimitiveType(System.Type)">
|
|
<summary>
|
|
Maps a simple type to an OpenAPI data type and format.
|
|
</summary>
|
|
<param name="type">Simple type.</param>
|
|
<remarks>
|
|
All the following types from http://swagger.io/specification/#data-types-12 are supported.
|
|
Other types including nullables and URL are also supported.
|
|
Common Name type format Comments
|
|
=========== ======= ====== =========================================
|
|
integer number int32 signed 32 bits
|
|
long number int64 signed 64 bits
|
|
float number float
|
|
double number double
|
|
string string [empty]
|
|
byte string byte base64 encoded characters
|
|
binary string binary any sequence of octets
|
|
boolean boolean [empty]
|
|
date string date As defined by full-date - RFC3339
|
|
dateTime string date-time As defined by date-time - RFC3339
|
|
password string password Used to hint UIs the input needs to be obscured.
|
|
If the type is not recognized as "simple", System.String will be returned.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTypeMapper.MapOpenApiPrimitiveTypeToSimpleType(Microsoft.OpenApi.OpenApiSchema)">
|
|
<summary>
|
|
Maps a JsonSchema data type and format to a simple type.
|
|
</summary>
|
|
<param name="schema">The OpenApi data type</param>
|
|
<returns>The simple type</returns>
|
|
<exception cref="T:System.ArgumentNullException"></exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenAPIWriterExtensions.GetSettings(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Temporary extension method until we add Settings property to IOpenApiWriter in next major version
|
|
</summary>
|
|
<param name="openApiWriter"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.StringExtensions">
|
|
<summary>
|
|
String extension methods.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IMetadataContainer">
|
|
<summary>
|
|
Represents an Open API element that can be annotated with
|
|
non-serializable properties in a property bag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IMetadataContainer.Metadata">
|
|
<summary>
|
|
A collection of properties associated with the current OpenAPI element to be used by the application.
|
|
Metadata are NOT (de)serialized with the schema and can be used for custom properties.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiElement">
|
|
<summary>
|
|
Represents an Open API element.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiExtensible">
|
|
<summary>
|
|
Represents an Extensible Open API element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiExtensible.Extensions">
|
|
<summary>
|
|
Specification extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiExtension">
|
|
<summary>
|
|
Interface required for implementing any custom extension
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Write out contents of custom extension
|
|
</summary>
|
|
<param name="writer"></param>
|
|
<param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReader">
|
|
<summary>
|
|
Interface for Open API readers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiReader.ReadAsync(System.IO.Stream,System.Uri,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Async method to reads the stream and parse it into an Open API document.
|
|
</summary>
|
|
<param name="input">The stream input.</param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<param name="settings"> The OpenApi reader settings.</param>
|
|
<param name="cancellationToken">Propagates notification that an operation should be cancelled.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiReader.Read(System.IO.MemoryStream,System.Uri,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Provides a synchronous method to read the input memory stream and parse it into an Open API document.
|
|
</summary>
|
|
<param name="input"></param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<param name="settings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiReader.ReadFragment``1(System.IO.MemoryStream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.Reader.OpenApiDiagnostic@,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Reads the MemoryStream and parses the fragment of an OpenAPI description into an Open API Element.
|
|
</summary>
|
|
<param name="input">Memory stream containing OpenAPI description to parse.</param>
|
|
<param name="version">Version of the OpenAPI specification that the fragment conforms to.</param>
|
|
<param name="openApiDocument">The OpenApiDocument object to which the fragment belongs, used to lookup references.</param>
|
|
<param name="diagnostic">Returns diagnostic object containing errors detected during parsing.</param>
|
|
<param name="settings">The OpenApiReader settings.</param>
|
|
<returns>Instance of newly created IOpenApiElement.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReadOnlyExtensible">
|
|
<summary>
|
|
Represents an Extensible Open API element elements can be rad from.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiReadOnlyExtensible.Extensions">
|
|
<summary>
|
|
Specification extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReferenceable">
|
|
<summary>
|
|
Represents an Open API element is referenceable.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReferenceHolder`3">
|
|
<summary>
|
|
A generic interface for OpenApiReferenceable objects that have a target.
|
|
</summary>
|
|
<typeparam name="T">The type of the target being referenced</typeparam>
|
|
<typeparam name="U">The type of the interface implemented by both the target and the reference type</typeparam>
|
|
<typeparam name="V">The type for the reference holding the additional fields and annotations</typeparam>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiReferenceHolder`3.Target">
|
|
<summary>
|
|
Gets the resolved target object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiReferenceHolder`3.RecursiveTarget">
|
|
<summary>
|
|
Gets the recursively resolved target object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiReferenceHolder`3.CopyReferenceAsTargetElementWithOverrides(`1)">
|
|
<summary>
|
|
Copy the reference as a target element with overrides.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReferenceHolder`1">
|
|
<summary>
|
|
A generic interface for OpenApiReferenceable objects that have a target.
|
|
</summary>
|
|
<typeparam name="V">The type for the reference holding the additional fields and annotations</typeparam>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiReferenceHolder`1.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReferenceHolder">
|
|
<summary>
|
|
A generic interface for OpenApiReferenceable objects that have a target.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiReferenceHolder.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiSerializable">
|
|
<summary>
|
|
Represents an Open API element that comes with serialization functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiSerializable.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize OpenAPI element into v3.1
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiSerializable.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize Open API element to v3.0.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiSerializable.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize Open API element to v2.0.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiVersionService">
|
|
<summary>
|
|
Interface to a version specific parsing implementations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiVersionService.LoadElement``1(Microsoft.OpenApi.Reader.ParseNode,Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Loads an OpenAPI Element from a document fragment
|
|
</summary>
|
|
<typeparam name="T">Type of element to load</typeparam>
|
|
<param name="node">document fragment node</param>
|
|
<param name="doc">A host document instance.</param>
|
|
<returns>Instance of OpenAPIElement</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiVersionService.LoadDocument(Microsoft.OpenApi.Reader.RootNode,System.Uri)">
|
|
<summary>
|
|
Converts a generic RootNode instance into a strongly typed OpenApiDocument
|
|
</summary>
|
|
<param name="rootNode">RootNode containing the information to be converted into an OpenAPI Document</param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<returns>Instance of OpenApiDocument populated with data from rootNode</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiVersionService.GetReferenceScalarValues(Microsoft.OpenApi.Reader.MapNode,System.String)">
|
|
<summary>
|
|
Gets the description and summary scalar values in a reference object for V3.1 support
|
|
</summary>
|
|
<param name="mapNode">A YamlMappingNode.</param>
|
|
<param name="scalarValue">The scalar value we're parsing.</param>
|
|
<returns>The resulting node value.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IShallowCopyable`1">
|
|
<summary>
|
|
Interface for shallow copyable objects.
|
|
</summary>
|
|
<typeparam name="T">The type of the resulting object</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IShallowCopyable`1.CreateShallowCopy">
|
|
<summary>
|
|
Create a shallow copy of the current instance.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IStreamLoader">
|
|
<summary>
|
|
Interface for service that translates a URI into a stream that can be loaded by a Reader
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IStreamLoader.LoadAsync(System.Uri,System.Uri,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Use Uri to locate data and convert into an input object.
|
|
</summary>
|
|
<param name="baseUrl">Base URL of parent to which a relative reference could be loaded.
|
|
If the <paramref name="uri"/> is an absolute parameter the value of this parameter will be ignored</param>
|
|
<param name="uri">Identifier of some source of an OpenAPI Description</param>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
<returns>A data object that can be processed by a reader to generate an <see cref="T:Microsoft.OpenApi.OpenApiDocument"/></returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.JsonPointer">
|
|
<summary>
|
|
JSON pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonPointer.#ctor(System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.JsonPointer"/> class.
|
|
</summary>
|
|
<param name="pointer">Pointer as string.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonPointer.#ctor(System.String[])">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.JsonPointer"/> class.
|
|
</summary>
|
|
<param name="tokens">Pointer as tokenized string.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonPointer.Tokens">
|
|
<summary>
|
|
Tokens.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonPointer.ParentPointer">
|
|
<summary>
|
|
Gets the parent pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonPointer.Decode(System.String)">
|
|
<summary>
|
|
Decode the string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonPointer.ToString">
|
|
<summary>
|
|
Gets the string representation of this JSON pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension">
|
|
<summary>
|
|
Extension element for OpenAPI to add deprecation information. x-ms-deprecation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Name">
|
|
<summary>
|
|
Name of the extension as used in the description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.RemovalDate">
|
|
<summary>
|
|
The date at which the element has been/will be removed entirely from the service.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Date">
|
|
<summary>
|
|
The date at which the element has been/will be deprecated.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Version">
|
|
<summary>
|
|
The version this revision was introduced.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Description">
|
|
<summary>
|
|
The description of the revision.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Parse(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Parses the <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/> to <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension"/>.
|
|
</summary>
|
|
<param name="source">The source object.</param>
|
|
<returns>The <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension"/>.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">When the source element is not an object</exception>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension">
|
|
<summary>
|
|
Extension element for OpenAPI to add deprecation information. x-ms-enum-flags
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension.Name">
|
|
<summary>
|
|
Name of the extension as used in the description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension.IsFlags">
|
|
<summary>
|
|
Whether the enum is a flagged enum.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension.Parse(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Parse the extension from the raw OpenApiAny object.
|
|
</summary>
|
|
<param name="source">The source element to parse.</param>
|
|
<returns>The <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension"/>.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">When the source element is not an object</exception>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension">
|
|
<summary>
|
|
Extension element for OpenAPI to add enum values descriptions.
|
|
Based of the AutoRest specification https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-enum
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension.Name">
|
|
<summary>
|
|
Name of the extension as used in the description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension.EnumName">
|
|
<summary>
|
|
The of the enum.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension.ValuesDescriptions">
|
|
<summary>
|
|
Descriptions for the enum symbols, where the value MUST match the enum symbols in the main description
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension.Parse(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Parse the extension from the raw IOpenApiAny object.
|
|
</summary>
|
|
<param name="source">The source element to parse.</param>
|
|
<returns>The <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension"/>.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">When the source element is not an object</exception>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.EnumDescription">
|
|
<summary>
|
|
Description of an enum symbol
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.EnumDescription.#ctor">
|
|
<summary>
|
|
Default constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.EnumDescription.#ctor(System.Text.Json.Nodes.JsonObject)">
|
|
<summary>
|
|
Constructor from a raw OpenApiObject
|
|
</summary>
|
|
<param name="source">The source object</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.EnumDescription.Description">
|
|
<summary>
|
|
The description for the enum symbol
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.EnumDescription.Name">
|
|
<summary>
|
|
The symbol for the enum symbol to use for code-generation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.EnumDescription.Value">
|
|
<summary>
|
|
The symbol as described in the main enum schema.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension">
|
|
<summary>
|
|
Extension element for OpenAPI to add pageable information.
|
|
Based of the AutoRest specification https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-pageable
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.Name">
|
|
<summary>
|
|
Name of the extension as used in the description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.ItemName">
|
|
<summary>
|
|
The name of the property that provides the collection of pageable items.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.NextLinkName">
|
|
<summary>
|
|
The name of the property that provides the next link (common: nextLink)
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.OperationName">
|
|
<summary>
|
|
The name (operationId) of the operation for retrieving the next page.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.Parse(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Parse the extension from the raw IOpenApiAny object.
|
|
</summary>
|
|
<param name="source">The source element to parse.</param>
|
|
<returns>The <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension"/>.</returns>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">When the source element is not an object</exception>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension">
|
|
<summary>
|
|
Extension element for OpenAPI to add tag the primary error message to use on error types. x-ms-primary-error-message
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension.Name">
|
|
<summary>
|
|
Name of the extension as used in the description.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension.IsPrimaryErrorMessage">
|
|
<summary>
|
|
Whether this property is the primary error message to use on error types.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension.Parse(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Parses the <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/> to <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension"/>.
|
|
</summary>
|
|
<param name="source">The source object.</param>
|
|
<returns>The <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension">
|
|
<summary>
|
|
Extension element for OpenAPI to add reserved parameters. x-ms-reserved-parameters
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension.Name">
|
|
<summary>
|
|
Name of the extension as used in the description.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension.Write(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension.IsReserved">
|
|
<summary>
|
|
Whether the associated parameter is reserved or not.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension.Parse(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Parses the <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/> to <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension"/>.
|
|
</summary>
|
|
<param name="source">The source object.</param>
|
|
<returns>The <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension"/>.</returns>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.BaseOpenApiReference">
|
|
<summary>
|
|
A simple object to allow referencing other components in the specification, internally and externally.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.ExternalResource">
|
|
<summary>
|
|
External resource in the reference.
|
|
It maybe:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.Type">
|
|
<summary>
|
|
The element type referenced.
|
|
</summary>
|
|
<remarks>This must be present if <see cref="P:Microsoft.OpenApi.BaseOpenApiReference.ExternalResource"/> is not present.</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.Id">
|
|
<summary>
|
|
The identifier of the reusable component of one particular ReferenceType.
|
|
If ExternalResource is present, this is the path to the component after the '#/'.
|
|
For example, if the reference is 'example.json#/path/to/component', the Id is 'path/to/component'.
|
|
If ExternalResource is not present, this is the name of the component without the reference type name.
|
|
For example, if the reference is '#/components/schemas/componentName', the Id is 'componentName'.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.IsExternal">
|
|
<summary>
|
|
Gets a flag indicating whether this reference is an external reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.IsLocal">
|
|
<summary>
|
|
Gets a flag indicating whether this reference is a local reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.IsFragment">
|
|
<summary>
|
|
Gets a flag indicating whether a file is a valid OpenAPI document or a fragment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.HostDocument">
|
|
<summary>
|
|
The OpenApiDocument that is hosting the OpenApiReference instance. This is used to enable dereferencing the reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.ReferenceV3">
|
|
<summary>
|
|
Gets the full reference string for v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReference.ReferenceV2">
|
|
<summary>
|
|
Gets the full reference string for V2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.#ctor(Microsoft.OpenApi.BaseOpenApiReference)">
|
|
<summary>
|
|
Initializes a copy instance of the <see cref="T:Microsoft.OpenApi.BaseOpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.SerializeAdditionalV31Properties(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize additional properties for Open Api v3.1.
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,System.Action{Microsoft.OpenApi.IOpenApiWriter})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.BaseOpenApiReference"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.EnsureHostDocumentIsSet(Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Sets the host document after deserialization or before serialization.
|
|
This method is internal on purpose to avoid consumers mutating the host document.
|
|
</summary>
|
|
<param name="currentDocument">Host document to set if none is present</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.GetPropertyValueFromNode(System.Text.Json.Nodes.JsonObject,System.String)">
|
|
<summary>
|
|
Gets the property value from a JsonObject node.
|
|
</summary>
|
|
<param name="jsonObject">The object to get the value from</param>
|
|
<param name="key">The key of the property</param>
|
|
<returns>The property value</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReference.SetAdditional31MetadataFromMapNode(System.Text.Json.Nodes.JsonObject)">
|
|
<summary>
|
|
Sets additional metadata from the map node.
|
|
</summary>
|
|
<param name="jsonObject">The object to get the data from</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiCallback">
|
|
<summary>
|
|
Defines the base properties for the callback object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiCallback.PathItems">
|
|
<summary>
|
|
A Path Item Object used to define a callback request and expected responses.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiDescribedElement">
|
|
<summary>
|
|
Describes an element that has a description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiDescribedElement.Description">
|
|
<summary>
|
|
Long description for the example.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiReadOnlyDescribedElement">
|
|
<summary>
|
|
Describes an element that has a description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiReadOnlyDescribedElement.Description">
|
|
<summary>
|
|
Long description for the example.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiExample">
|
|
<summary>
|
|
Defines the base properties for the example object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiExample.Value">
|
|
<summary>
|
|
Embedded literal example. The value field and externalValue 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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiExample.ExternalValue">
|
|
<summary>
|
|
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 value field and externalValue field are mutually exclusive.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiHeader">
|
|
<summary>
|
|
Defines the base properties for the headers object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Required">
|
|
<summary>
|
|
Determines whether this header is mandatory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Deprecated">
|
|
<summary>
|
|
Specifies that a header is deprecated and SHOULD be transitioned out of usage.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.AllowEmptyValue">
|
|
<summary>
|
|
Sets the ability to pass empty-valued headers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Style">
|
|
<summary>
|
|
Describes how the header value will be serialized depending on the type of the header value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Explode">
|
|
<summary>
|
|
When this is true, header values of type array or object generate separate parameters
|
|
for each value of the array or key-value pair of the map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.AllowReserved">
|
|
<summary>
|
|
Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Schema">
|
|
<summary>
|
|
The schema defining the type used for the request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Example">
|
|
<summary>
|
|
Example of the media type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Examples">
|
|
<summary>
|
|
Examples of the media type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiHeader.Content">
|
|
<summary>
|
|
A map containing the representations for the header.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiLink">
|
|
<summary>
|
|
Defines the base properties for the link object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiLink.OperationRef">
|
|
<summary>
|
|
A relative or absolute reference to an OAS operation.
|
|
This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiLink.OperationId">
|
|
<summary>
|
|
The name of an existing, resolvable OAS operation, as defined with a unique operationId.
|
|
This field is mutually exclusive of the operationRef field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiLink.Parameters">
|
|
<summary>
|
|
A map representing parameters to pass to an operation as specified with operationId or identified via operationRef.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiLink.RequestBody">
|
|
<summary>
|
|
A literal value or {expression} to use as a request body when calling the target operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiLink.Server">
|
|
<summary>
|
|
A server object to be used by the target operation.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiParameter">
|
|
<summary>
|
|
Defines the base properties for the parameter object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Name">
|
|
<summary>
|
|
REQUIRED. The name of the parameter. Parameter names are case sensitive.
|
|
If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object.
|
|
If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
|
|
For all other cases, the name corresponds to the parameter name used by the in property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.In">
|
|
<summary>
|
|
REQUIRED. The location of the parameter.
|
|
Possible values are "query", "header", "path" or "cookie".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Required">
|
|
<summary>
|
|
Determines whether this parameter is mandatory.
|
|
If the parameter location is "path", this property is REQUIRED and its value MUST be true.
|
|
Otherwise, the property MAY be included and its default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Deprecated">
|
|
<summary>
|
|
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.AllowEmptyValue">
|
|
<summary>
|
|
Sets the ability to pass empty-valued parameters.
|
|
This is valid only for query parameters and allows sending a parameter with an empty value.
|
|
Default value is false.
|
|
If style is used, and if behavior is n/a (cannot be serialized),
|
|
the value of allowEmptyValue SHALL be ignored.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Style">
|
|
<summary>
|
|
Describes how the parameter value will be serialized depending on the type of the parameter value.
|
|
Default values (based on value of in): for query - form; for path - simple; for header - simple;
|
|
for cookie - form.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Explode">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.AllowReserved">
|
|
<summary>
|
|
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 in value of query.
|
|
The default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Schema">
|
|
<summary>
|
|
The schema defining the type used for the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Examples">
|
|
<summary>
|
|
Examples of the media type. Each example SHOULD contain a value
|
|
in the correct format as specified in the parameter encoding.
|
|
The examples object is mutually exclusive of the example object.
|
|
Furthermore, if referencing a schema which contains an example,
|
|
the examples value SHALL override the example provided by the schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Example">
|
|
<summary>
|
|
Example of the media type. The example SHOULD match the specified schema and encoding properties
|
|
if present. The example object is mutually exclusive of the examples object.
|
|
Furthermore, if referencing a schema which 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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiParameter.Content">
|
|
<summary>
|
|
A map containing the representations for the parameter.
|
|
The key is the media type and the value describes it.
|
|
The map MUST only contain one entry.
|
|
For more complex scenarios, the content property can define the media type and schema of the parameter.
|
|
A parameter MUST contain either a schema property, or a content property, but not both.
|
|
When example or examples are provided in conjunction with the schema object,
|
|
the example MUST follow the prescribed serialization strategy for the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiPathItem">
|
|
<summary>
|
|
Defines the base properties for the path item object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiPathItem.Operations">
|
|
<summary>
|
|
Gets the definition of operations on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiPathItem.Servers">
|
|
<summary>
|
|
An alternative server array to service all operations in this path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiPathItem.Parameters">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiRequestBody">
|
|
<summary>
|
|
Defines the base properties for the request body object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiRequestBody.Required">
|
|
<summary>
|
|
Determines if the request body is required in the request. Defaults to false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiRequestBody.Content">
|
|
<summary>
|
|
REQUIRED. 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/*
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiRequestBody.ConvertToBodyParameter(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Converts the request body to a body parameter in preparation for a v2 serialization.
|
|
</summary>
|
|
<param name="writer">The writer to use to read settings from.</param>
|
|
<returns>The converted OpenAPI parameter</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiRequestBody.ConvertToFormDataParameters(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Converts the request body to a set of form data parameters in preparation for a v2 serialization.
|
|
</summary>
|
|
<param name="writer">The writer to use to read settings from</param>
|
|
<returns>The converted OpenAPI parameters</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiResponse">
|
|
<summary>
|
|
Defines the base properties for the response object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiResponse.Headers">
|
|
<summary>
|
|
Maps a header name to its definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiResponse.Content">
|
|
<summary>
|
|
A map containing descriptions of potential response payloads.
|
|
The key is a media type or media type range and the value describes it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiResponse.Links">
|
|
<summary>
|
|
A map of operations links that can be followed from the response.
|
|
The key of the map is a short name for the link,
|
|
following the naming constraints of the names for Component Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiSchema">
|
|
<summary>
|
|
Defines the base properties for the schema object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Title">
|
|
<summary>
|
|
Follow JSON Schema definition. Short text providing information about the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Schema">
|
|
<summary>
|
|
$schema, a JSON Schema dialect identifier. Value must be a URI
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Id">
|
|
<summary>
|
|
$id - Identifies a schema resource with its canonical URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Comment">
|
|
<summary>
|
|
$comment - reserves a location for comments from schema authors to readers or maintainers of the schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Vocabulary">
|
|
<summary>
|
|
$vocabulary- used in meta-schemas to identify the vocabularies available for use in schemas described by that meta-schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.DynamicRef">
|
|
<summary>
|
|
$dynamicRef - an applicator that allows for deferring the full resolution until runtime, at which point it is resolved each time it is encountered while evaluating an instance
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.DynamicAnchor">
|
|
<summary>
|
|
$dynamicAnchor - used to create plain name fragments that are not tied to any particular structural location for referencing purposes, which are taken into consideration for dynamic referencing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Definitions">
|
|
<summary>
|
|
$defs - reserves a location for schema authors to inline re-usable JSON Schemas into a more general schema.
|
|
The keyword does not directly affect the validation result
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.ExclusiveMaximum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.ExclusiveMinimum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Type">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Value MUST be a string in V2 and V3.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Const">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Format">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
While relying on JSON Schema's defined formats,
|
|
the OAS offers a few additional predefined formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Maximum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Minimum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MaxLength">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MinLength">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Pattern">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MultipleOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Default">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided.
|
|
Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level.
|
|
For example, if type is string, then default can be "foo" but cannot be 1.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.ReadOnly">
|
|
<summary>
|
|
Relevant only for Schema "properties" definitions. Declares the property as "read only".
|
|
This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request.
|
|
If the property is marked as readOnly being true and is in the required list,
|
|
the required will take effect on the response only.
|
|
A property MUST NOT be marked as both readOnly and writeOnly being true.
|
|
Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.WriteOnly">
|
|
<summary>
|
|
Relevant only for Schema "properties" definitions. Declares the property as "write only".
|
|
Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response.
|
|
If the property is marked as writeOnly being true and is in the required list,
|
|
the required will take effect on the request only.
|
|
A property MUST NOT be marked as both readOnly and writeOnly being true.
|
|
Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.AllOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.OneOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.AnyOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Not">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Required">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Items">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Value MUST be an object and not an array. Inline or referenced schema MUST be of a Schema Object
|
|
and not a standard JSON Schema. items MUST be present if the type is array.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MaxItems">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MinItems">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.UniqueItems">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Properties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.PatternProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
PatternProperty definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced)
|
|
Each property name of this object SHOULD be a valid regular expression according to the ECMA 262 r
|
|
egular expression dialect. Each property value of this object MUST be an object, and each object MUST
|
|
be a valid Schema Object not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MaxProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.MinProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.AdditionalPropertiesAllowed">
|
|
<summary>
|
|
Indicates if the schema can contain properties other than those defined by the properties map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.AdditionalProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
Value can be boolean or object. Inline or referenced schema
|
|
MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Discriminator">
|
|
<summary>
|
|
Adds support for polymorphism. The discriminator is an object name that is used to differentiate
|
|
between other schemas which may satisfy the payload description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Example">
|
|
<summary>
|
|
A free-form property to include an example of an instance for this schema.
|
|
To represent examples that cannot be naturally represented in JSON or YAML,
|
|
a string value can be used to contain the example with escaping where necessary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Examples">
|
|
<summary>
|
|
A free-form property to include examples of an instance for this schema.
|
|
To represent examples that cannot be naturally represented in JSON or YAML,
|
|
a list of values can be used to contain the examples with escaping where necessary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Enum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.UnevaluatedProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://json-schema.org/draft/2020-12/json-schema-validation
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation for this schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Deprecated">
|
|
<summary>
|
|
Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
|
|
Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.Xml">
|
|
<summary>
|
|
This MAY be used only on properties schemas. It has no effect on root schemas.
|
|
Adds additional metadata to describe the XML representation of this property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.UnrecognizedKeywords">
|
|
<summary>
|
|
This object stores any unrecognized keywords found in the schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSchema.DependentRequired">
|
|
<summary>
|
|
Follow JSON Schema definition:https://json-schema.org/draft/2020-12/json-schema-validation#section-6.5.4
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiSecurityScheme">
|
|
<summary>
|
|
Defines the base properties for the security scheme object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.Type">
|
|
<summary>
|
|
REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.Name">
|
|
<summary>
|
|
REQUIRED. The name of the header, query or cookie parameter to be used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.In">
|
|
<summary>
|
|
REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.Scheme">
|
|
<summary>
|
|
REQUIRED. The name of the HTTP Authorization scheme to be used
|
|
in the Authorization header as defined in RFC7235.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.BearerFormat">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.Flows">
|
|
<summary>
|
|
REQUIRED. An object containing configuration information for the flow types supported.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSecurityScheme.OpenIdConnectUrl">
|
|
<summary>
|
|
REQUIRED. OpenId Connect URL to discover OAuth2 configuration values.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiSummarizedElement">
|
|
<summary>
|
|
Describes an element that has a summary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiSummarizedElement.Summary">
|
|
<summary>
|
|
Short description for the example.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiTag">
|
|
<summary>
|
|
Defines the base properties for the path item object.
|
|
This interface is provided for type assertions but should not be implemented by package consumers beyond automatic mocking.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiTag.Name">
|
|
<summary>
|
|
The name of the tag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IOpenApiTag.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation for this tag.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.JsonSchemaReference">
|
|
<summary>
|
|
Schema reference information that includes metadata annotations from JSON Schema 2020-12.
|
|
This class extends OpenApiReference to provide schema-specific metadata override capabilities.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonSchemaReference.Default">
|
|
<summary>
|
|
A default value which by default SHOULD override that of the referenced component.
|
|
If the referenced object-type does not allow a default field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonSchemaReference.Title">
|
|
<summary>
|
|
A title which by default SHOULD override that of the referenced component.
|
|
If the referenced object-type does not allow a title field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonSchemaReference.Deprecated">
|
|
<summary>
|
|
Indicates whether the referenced component is deprecated.
|
|
If the referenced object-type does not allow a deprecated field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonSchemaReference.ReadOnly">
|
|
<summary>
|
|
Indicates whether the referenced component is read-only.
|
|
If the referenced object-type does not allow a readOnly field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonSchemaReference.WriteOnly">
|
|
<summary>
|
|
Indicates whether the referenced component is write-only.
|
|
If the referenced object-type does not allow a writeOnly field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.JsonSchemaReference.Examples">
|
|
<summary>
|
|
Example values which by default SHOULD override those of the referenced component.
|
|
If the referenced object-type does not allow examples, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonSchemaReference.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonSchemaReference.#ctor(Microsoft.OpenApi.JsonSchemaReference)">
|
|
<summary>
|
|
Initializes a copy instance of the <see cref="T:Microsoft.OpenApi.JsonSchemaReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonSchemaReference.SerializeAdditionalV31Properties(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.JsonSchemaReference.SetAdditional31MetadataFromMapNode(System.Text.Json.Nodes.JsonObject)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.JsonSchemaType">
|
|
<summary>
|
|
Represents the type of a JSON schema.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.Null">
|
|
<summary>
|
|
Represents a null type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.Boolean">
|
|
<summary>
|
|
Represents a boolean type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.Integer">
|
|
<summary>
|
|
Represents an integer type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.Number">
|
|
<summary>
|
|
Represents a number type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.String">
|
|
<summary>
|
|
Represents a string type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.Object">
|
|
<summary>
|
|
Represents an object type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.JsonSchemaType.Array">
|
|
<summary>
|
|
Represents an array type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiCallback">
|
|
<summary>
|
|
Callback Object: A map of possible out-of band callbacks related to the parent operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiCallback.PathItems">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiCallback.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.#ctor(Microsoft.OpenApi.IOpenApiCallback)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiCallback"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.AddPathItem(Microsoft.OpenApi.RuntimeExpression,Microsoft.OpenApi.IOpenApiPathItem)">
|
|
<summary>
|
|
Add a <see cref="T:Microsoft.OpenApi.IOpenApiPathItem"/> into the <see cref="P:Microsoft.OpenApi.OpenApiCallback.PathItems"/>.
|
|
</summary>
|
|
<param name="expression">The runtime expression.</param>
|
|
<param name="pathItem">The path item.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiCallback"/> to Open Api v3.1
|
|
</summary>
|
|
<param name="writer"></param>
|
|
<exception cref="T:System.NotImplementedException"></exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiCallback"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiCallback"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallback.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiComponents">
|
|
<summary>
|
|
Components Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Schemas">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiSchema"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Responses">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiResponse"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Parameters">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiParameter"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Examples">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.OpenApiExample"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.RequestBodies">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiRequestBody"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Headers">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiHeader"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.SecuritySchemes">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiSecurityScheme"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Links">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiLink"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Callbacks">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.OpenApiCallback"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.PathItems">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.IOpenApiPathItem"/> Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponents.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiComponents.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiComponents.#ctor(Microsoft.OpenApi.OpenApiComponents)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiComponents"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiComponents.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiComponents"/> to Open API v3.1.
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiComponents.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiComponents"/> to v3.0
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiComponents.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable},System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiReferenceHolder})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiComponents"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiComponents.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiComponents"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiConstants">
|
|
<summary>
|
|
Constants used in the Open API document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.OpenApi">
|
|
<summary>
|
|
Field: OpenApi
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Json">
|
|
<summary>
|
|
Field: Json
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Yaml">
|
|
<summary>
|
|
Field: Yaml
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Yml">
|
|
<summary>
|
|
Field: Yml
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Info">
|
|
<summary>
|
|
Field: Info
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.JsonSchemaDialect">
|
|
<summary>
|
|
Field: JsonSchemaDialect
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Webhooks">
|
|
<summary>
|
|
Field: Webhooks
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Title">
|
|
<summary>
|
|
Field: Title
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Const">
|
|
<summary>
|
|
Field: Const
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Type">
|
|
<summary>
|
|
Field: Type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Format">
|
|
<summary>
|
|
Field: Format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DollarSchema">
|
|
<summary>
|
|
Field: Schema
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Id">
|
|
<summary>
|
|
Field: Id
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Comment">
|
|
<summary>
|
|
Field: Comment
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Vocabulary">
|
|
<summary>
|
|
Field: Vocabulary
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DynamicRef">
|
|
<summary>
|
|
Field: DynamicRef
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DynamicAnchor">
|
|
<summary>
|
|
Field: DynamicAnchor
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.RecursiveRef">
|
|
<summary>
|
|
Field: RecursiveRef
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.RecursiveAnchor">
|
|
<summary>
|
|
Field: RecursiveAnchor
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Defs">
|
|
<summary>
|
|
Field: Definitions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.V31ExclusiveMaximum">
|
|
<summary>
|
|
Field: V31ExclusiveMaximum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.V31ExclusiveMinimum">
|
|
<summary>
|
|
Field: V31ExclusiveMinimum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.UnevaluatedProperties">
|
|
<summary>
|
|
Field: UnevaluatedProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Version">
|
|
<summary>
|
|
Field: Version
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Contact">
|
|
<summary>
|
|
Field: Contact
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.License">
|
|
<summary>
|
|
Field: License
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.TermsOfService">
|
|
<summary>
|
|
Field: TermsOfService
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Servers">
|
|
<summary>
|
|
Field: Servers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Server">
|
|
<summary>
|
|
Field: Server
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Paths">
|
|
<summary>
|
|
Field: Paths
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Components">
|
|
<summary>
|
|
Field: Components
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.PathItems">
|
|
<summary>
|
|
Field: PathItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Security">
|
|
<summary>
|
|
Field: Security
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Tags">
|
|
<summary>
|
|
Field: Tags
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ExternalDocs">
|
|
<summary>
|
|
Field: ExternalDocs
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.OperationRef">
|
|
<summary>
|
|
Field: OperationRef
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.OperationId">
|
|
<summary>
|
|
Field: OperationId
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Parameters">
|
|
<summary>
|
|
Field: Parameters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.RequestBody">
|
|
<summary>
|
|
Field: RequestBody
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ExtensionFieldNamePrefix">
|
|
<summary>
|
|
Field: ExtensionFieldNamePrefix
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Name">
|
|
<summary>
|
|
Field: Name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Identifier">
|
|
<summary>
|
|
Field: Identifier
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Namespace">
|
|
<summary>
|
|
Field: Namespace
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Prefix">
|
|
<summary>
|
|
Field: Prefix
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Attribute">
|
|
<summary>
|
|
Field: Attribute
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Wrapped">
|
|
<summary>
|
|
Field: Wrapped
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.In">
|
|
<summary>
|
|
Field: In
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Summary">
|
|
<summary>
|
|
Field: Summary
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Variables">
|
|
<summary>
|
|
Field: Variables
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Description">
|
|
<summary>
|
|
Field: Description
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Required">
|
|
<summary>
|
|
Field: Required
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Deprecated">
|
|
<summary>
|
|
Field: Deprecated
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Style">
|
|
<summary>
|
|
Field: Style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Explode">
|
|
<summary>
|
|
Field: Explode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AllowReserved">
|
|
<summary>
|
|
Field: AllowReserved
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Schema">
|
|
<summary>
|
|
Field: Schema
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Schemas">
|
|
<summary>
|
|
Field: Schemas
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Responses">
|
|
<summary>
|
|
Field: Responses
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Example">
|
|
<summary>
|
|
Field: Example
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Examples">
|
|
<summary>
|
|
Field: Examples
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Encoding">
|
|
<summary>
|
|
Field: Encoding
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.RequestBodies">
|
|
<summary>
|
|
Field: RequestBodies
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AllowEmptyValue">
|
|
<summary>
|
|
Field: AllowEmptyValue
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Value">
|
|
<summary>
|
|
Field: Value
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ExternalValue">
|
|
<summary>
|
|
Field: ExternalValue
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DollarRef">
|
|
<summary>
|
|
Field: DollarRef
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Headers">
|
|
<summary>
|
|
Field: Headers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.SecuritySchemes">
|
|
<summary>
|
|
Field: SecuritySchemes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Content">
|
|
<summary>
|
|
Field: Content
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Links">
|
|
<summary>
|
|
Field: Links
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Callbacks">
|
|
<summary>
|
|
Field: Callbacks
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Url">
|
|
<summary>
|
|
Field: Url
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Email">
|
|
<summary>
|
|
Field: Email
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Default">
|
|
<summary>
|
|
Field: Default
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Enum">
|
|
<summary>
|
|
Field: Enum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MultipleOf">
|
|
<summary>
|
|
Field: MultipleOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Maximum">
|
|
<summary>
|
|
Field: Maximum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ExclusiveMaximum">
|
|
<summary>
|
|
Field: ExclusiveMaximum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Minimum">
|
|
<summary>
|
|
Field: Minimum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ExclusiveMinimum">
|
|
<summary>
|
|
Field: ExclusiveMinimum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MaxLength">
|
|
<summary>
|
|
Field: MaxLength
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MinLength">
|
|
<summary>
|
|
Field: MinLength
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Pattern">
|
|
<summary>
|
|
Field: Pattern
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MaxItems">
|
|
<summary>
|
|
Field: MaxItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MinItems">
|
|
<summary>
|
|
Field: MinItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.UniqueItems">
|
|
<summary>
|
|
Field: UniqueItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MaxProperties">
|
|
<summary>
|
|
Field: MaxProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.MinProperties">
|
|
<summary>
|
|
Field: MinProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AllOf">
|
|
<summary>
|
|
Field: AllOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.OneOf">
|
|
<summary>
|
|
Field: OneOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AnyOf">
|
|
<summary>
|
|
Field: AnyOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Not">
|
|
<summary>
|
|
Field: Not
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Items">
|
|
<summary>
|
|
Field: Items
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Properties">
|
|
<summary>
|
|
Field: Properties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.UnrecognizedKeywords">
|
|
<summary>
|
|
Field: UnrecognizedKeywords
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.PatternProperties">
|
|
<summary>
|
|
Field: Pattern Properties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AdditionalProperties">
|
|
<summary>
|
|
Field: AdditionalProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Nullable">
|
|
<summary>
|
|
Field: Nullable
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Discriminator">
|
|
<summary>
|
|
Field: Discriminator
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ReadOnly">
|
|
<summary>
|
|
Field: ReadOnly
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.WriteOnly">
|
|
<summary>
|
|
Field: WriteOnly
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Xml">
|
|
<summary>
|
|
Field: Xml
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Flow">
|
|
<summary>
|
|
Field: Flow
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Application">
|
|
<summary>
|
|
Field: Application
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AccessCode">
|
|
<summary>
|
|
Field: AccessCode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Implicit">
|
|
<summary>
|
|
Field: Implicit
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Password">
|
|
<summary>
|
|
Field: Password
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ClientCredentials">
|
|
<summary>
|
|
Field: ClientCredentials
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AuthorizationCode">
|
|
<summary>
|
|
Field: AuthorizationCode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.AuthorizationUrl">
|
|
<summary>
|
|
Field: AuthorizationUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.TokenUrl">
|
|
<summary>
|
|
Field: TokenUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.RefreshUrl">
|
|
<summary>
|
|
Field: RefreshUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Scopes">
|
|
<summary>
|
|
Field: Scopes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ContentType">
|
|
<summary>
|
|
Field: ContentType
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Get">
|
|
<summary>
|
|
Field: Get
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Put">
|
|
<summary>
|
|
Field: Put
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Post">
|
|
<summary>
|
|
Field: Post
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Delete">
|
|
<summary>
|
|
Field: Delete
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Options">
|
|
<summary>
|
|
Field: Options
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Head">
|
|
<summary>
|
|
Field: Head
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Patch">
|
|
<summary>
|
|
Field: Patch
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Trace">
|
|
<summary>
|
|
Field: Trace
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.PropertyName">
|
|
<summary>
|
|
Field: PropertyName
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Mapping">
|
|
<summary>
|
|
Field: Mapping
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Scheme">
|
|
<summary>
|
|
Field: Scheme
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.BearerFormat">
|
|
<summary>
|
|
Field: BearerFormat
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Flows">
|
|
<summary>
|
|
Field: Flows
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.OpenIdConnectUrl">
|
|
<summary>
|
|
Field: OpenIdConnectUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DefaultName">
|
|
<summary>
|
|
Field: DefaultName
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DefaultDefault">
|
|
<summary>
|
|
Field: DefaultDefault
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DefaultTitle">
|
|
<summary>
|
|
Field: DefaultTitle
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DefaultDescription">
|
|
<summary>
|
|
Field: DefaultDescription
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.BodyName">
|
|
<summary>
|
|
Field: BodyName extensions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ExamplesExtension">
|
|
<summary>
|
|
Field: Examples Extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.version3_0_0">
|
|
<summary>
|
|
Field: version3_0_0
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.defaultUrl">
|
|
<summary>
|
|
Field: defaultUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.V3ReferenceUri">
|
|
<summary>
|
|
Field: V3 JsonSchema Reference Uri
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.V2ReferenceUri">
|
|
<summary>
|
|
Field: V2 JsonSchema Reference Uri
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.BaseRegistryUri">
|
|
<summary>
|
|
The default registry uri for OpenApi documents and workspaces
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.ComponentsSegment">
|
|
<summary>
|
|
The components path segment in a $ref value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Null">
|
|
<summary>
|
|
Field: Null
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.NullableExtension">
|
|
<summary>
|
|
Field: Nullable extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.DependentRequired">
|
|
<summary>
|
|
Field: DependentRequired
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Host">
|
|
<summary>
|
|
Field: Host
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Swagger">
|
|
<summary>
|
|
Field: Swagger
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.version2_0">
|
|
<summary>
|
|
Field: version2_0
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.BasePath">
|
|
<summary>
|
|
Field: BasePath
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Schemes">
|
|
<summary>
|
|
Field: Schemes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.SecurityDefinitions">
|
|
<summary>
|
|
Field: SecurityDefinitions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Definitions">
|
|
<summary>
|
|
Field: Definitions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Basic">
|
|
<summary>
|
|
Field: Basic
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Bearer">
|
|
<summary>
|
|
Field: Bearer
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Jwt">
|
|
<summary>
|
|
Field: JWT
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Consumes">
|
|
<summary>
|
|
Field: Consumes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiConstants.Produces">
|
|
<summary>
|
|
Field: Produces
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiContact">
|
|
<summary>
|
|
Contact Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiContact.Name">
|
|
<summary>
|
|
The identifying name of the contact person/organization.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiContact.Url">
|
|
<summary>
|
|
The URL pointing to the contact information. MUST be in the format of a URL.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiContact.Email">
|
|
<summary>
|
|
The email address of the contact person/organization.
|
|
MUST be in the format of an email address.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiContact.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiContact.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiContact.#ctor(Microsoft.OpenApi.OpenApiContact)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiContact"/> instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiContact.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiContact"/> to Open Api v3.1
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiContact.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiContact"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiContact.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiContact"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiDiscriminator">
|
|
<summary>
|
|
Discriminator object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDiscriminator.PropertyName">
|
|
<summary>
|
|
REQUIRED. The name of the property in the payload that will hold the discriminator value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDiscriminator.Mapping">
|
|
<summary>
|
|
An object to hold mappings between payload values and schema names or references.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDiscriminator.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDiscriminator.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDiscriminator.#ctor(Microsoft.OpenApi.OpenApiDiscriminator)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiDiscriminator"/> instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDiscriminator.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDiscriminator"/> to Open Api v3.1
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDiscriminator.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDiscriminator"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDiscriminator.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDiscriminator"/> to Open Api v3.0
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDiscriminator.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDiscriminator"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiDocument">
|
|
<summary>
|
|
Describes an OpenAPI object (OpenAPI document). See: https://spec.openapis.org
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.RegisterComponents">
|
|
<summary>
|
|
Register components in the document to the workspace
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Workspace">
|
|
<summary>
|
|
Related workspace containing components that are referenced in a document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Info">
|
|
<summary>
|
|
REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.JsonSchemaDialect">
|
|
<summary>
|
|
The default value for the $schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Servers">
|
|
<summary>
|
|
An array of Server Objects, which provide connectivity information to a target server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Paths">
|
|
<summary>
|
|
REQUIRED. The available paths and operations for the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Webhooks">
|
|
<summary>
|
|
The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.
|
|
A map of requests initiated other than by an API call, for example by an out of band registration.
|
|
The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Components">
|
|
<summary>
|
|
An element to hold various schemas for the specification.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Security">
|
|
<summary>
|
|
A declaration of which security mechanisms can be used across the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Tags">
|
|
<summary>
|
|
A list of tags used by the specification with additional metadata.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.Metadata">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocument.BaseUri">
|
|
<summary>
|
|
Absolute location of the document or a generated placeholder if location is not given
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.#ctor(Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Initializes a copy of an an <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.SerializeAs(Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> to an Open API document using the specified version.
|
|
</summary>
|
|
<param name="version">The Open API specification version to serialize the document as.</param>
|
|
<param name="writer">The <see cref="T:Microsoft.OpenApi.IOpenApiWriter"/> to serialize the document to.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="version"/> is not a supported Open API specification version.
|
|
</exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> to Open API v3.1 document.
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> to the latest patch of OpenAPI object V3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDocument"/>
|
|
</summary>
|
|
<param name="writer"></param>
|
|
<param name="version"></param>
|
|
<param name="callback"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> to OpenAPI object V2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.SetReferenceHostDocument">
|
|
<summary>
|
|
Walks the OpenApiDocument and sets the host document for all IOpenApiReferenceable objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.ResolveReferenceTo``1(Microsoft.OpenApi.BaseOpenApiReference,Microsoft.OpenApi.IOpenApiSchema)">
|
|
<summary>
|
|
Load the referenced <see cref="T:Microsoft.OpenApi.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.BaseOpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.GetHashCodeAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Takes in an OpenApi document instance and generates its hash value
|
|
</summary>
|
|
<param name="cancellationToken">Propagates notification that operations should be canceled.</param>
|
|
<returns>The hash value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.ResolveReference(Microsoft.OpenApi.BaseOpenApiReference,System.Boolean,Microsoft.OpenApi.IOpenApiSchema)">
|
|
<summary>
|
|
Load the referenced <see cref="T:Microsoft.OpenApi.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.BaseOpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.Load(System.IO.MemoryStream,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Reads the stream input and parses it into an Open API document.
|
|
</summary>
|
|
<param name="stream">Stream containing OpenAPI description to parse.</param>
|
|
<param name="format">The OpenAPI format to use during parsing.</param>
|
|
<param name="settings">The OpenApi reader settings.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.LoadAsync(System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Parses a local file path or Url into an Open API document.
|
|
</summary>
|
|
<param name="url"> The path to the OpenAPI file.</param>
|
|
<param name="settings">The OpenApi reader settings.</param>
|
|
<param name="token">The cancellation token</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.LoadAsync(System.IO.Stream,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Reads the stream input and parses it into an Open API document.
|
|
</summary>
|
|
<param name="stream">Stream containing OpenAPI description to parse.</param>
|
|
<param name="format">The OpenAPI format to use during parsing.</param>
|
|
<param name="settings">The OpenApi reader settings.</param>
|
|
<param name="cancellationToken">Propagates information about operation cancelling.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.Parse(System.String,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Parses a string into a <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> object.
|
|
</summary>
|
|
<param name="input"> The string input.</param>
|
|
<param name="format"></param>
|
|
<param name="settings"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiDocument.AddComponent``1(System.String,``0)">
|
|
<summary>
|
|
Adds a component to the components object of the current document and registers it to the underlying workspace.
|
|
</summary>
|
|
<param name="componentToRegister">The component to add</param>
|
|
<param name="id">The id for the component</param>
|
|
<typeparam name="T">The type of the component</typeparam>
|
|
<returns>Whether the component was added to the components.</returns>
|
|
<exception cref="T:System.ArgumentNullException">Thrown when the component is null.</exception>
|
|
<exception cref="T:System.ArgumentException">Thrown when the id is null or empty.</exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.FindSchemaReferences.Visit(Microsoft.OpenApi.IOpenApiReferenceHolder)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiEncoding">
|
|
<summary>
|
|
ExternalDocs object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiEncoding.ContentType">
|
|
<summary>
|
|
The Content-Type for encoding a specific property.
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiEncoding.Headers">
|
|
<summary>
|
|
A map allowing additional information to be provided as headers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiEncoding.Style">
|
|
<summary>
|
|
Describes how a specific property value will be serialized depending on its type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiEncoding.Explode">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiEncoding.AllowReserved">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiEncoding.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiEncoding.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiEncoding.#ctor(Microsoft.OpenApi.OpenApiEncoding)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiEncoding"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiEncoding.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiEncoding"/> to Open Api v3.1
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiEncoding.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiEncoding"/> to Open Api v3.0
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiEncoding.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiEncoding.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiError">
|
|
<summary>
|
|
Error related to the Open API Document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiError.#ctor(Microsoft.OpenApi.OpenApiException)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiError"/> class using the message and pointer from the given exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiError.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiError"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiError.#ctor(Microsoft.OpenApi.OpenApiError)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiError"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiError.Message">
|
|
<summary>
|
|
Message explaining the error.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiError.Pointer">
|
|
<summary>
|
|
Pointer to the location of the error.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiError.ToString">
|
|
<summary>
|
|
Gets the string representation of <see cref="T:Microsoft.OpenApi.OpenApiError"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExample">
|
|
<summary>
|
|
Example Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExample.Summary">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExample.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExample.ExternalValue">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExample.Value">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExample.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExample.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExample.#ctor(Microsoft.OpenApi.IOpenApiExample)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.OpenApiExample"/> object
|
|
</summary>
|
|
<param name="example">The <see cref="T:Microsoft.OpenApi.IOpenApiExample"/> object</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExample.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExample.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExample.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExample.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExtensibleDictionary`1">
|
|
<summary>
|
|
Generic dictionary type for Open API dictionary element.
|
|
</summary>
|
|
<typeparam name="T">The Open API element, <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.#ctor(System.Collections.Generic.Dictionary{System.String,`0},System.Collections.Generic.Dictionary{System.String,Microsoft.OpenApi.IOpenApiExtension})">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.OpenApiExtensibleDictionary`1"/> class.
|
|
</summary>
|
|
<param name="dictionary">The generic dictionary.</param>
|
|
<param name="extensions">The dictionary of <see cref="T:Microsoft.OpenApi.IOpenApiExtension"/>.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to Open Api v3.1
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to Open Api v3.0
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExtensibleDictionary`1.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExternalDocs">
|
|
<summary>
|
|
ExternalDocs object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExternalDocs.Description">
|
|
<summary>
|
|
A short description of the target documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExternalDocs.Url">
|
|
<summary>
|
|
REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExternalDocs.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExternalDocs.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExternalDocs.#ctor(Microsoft.OpenApi.OpenApiExternalDocs)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExternalDocs.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> to Open Api v3.1.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExternalDocs.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExternalDocs.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiHeader">
|
|
<summary>
|
|
Header Object.
|
|
The Header Object follows the structure of the Parameter Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Required">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Deprecated">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.AllowEmptyValue">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Style">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Explode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.AllowReserved">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Schema">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Example">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Examples">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeader.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeader.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeader.#ctor(Microsoft.OpenApi.IOpenApiHeader)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiHeader"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeader.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiHeader"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeader.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiHeader"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeader.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeader.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiInfo">
|
|
<summary>
|
|
Open API Info Object, it provides the metadata about the Open API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.Title">
|
|
<summary>
|
|
REQUIRED. The title of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.Summary">
|
|
<summary>
|
|
A short summary of the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.Description">
|
|
<summary>
|
|
A short description of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.Version">
|
|
<summary>
|
|
REQUIRED. The version of the OpenAPI document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.TermsOfService">
|
|
<summary>
|
|
A URL to the Terms of Service for the API. MUST be in the format of a URL.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.Contact">
|
|
<summary>
|
|
The contact information for the exposed API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.License">
|
|
<summary>
|
|
The license information for the exposed API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfo.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiInfo.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiInfo.#ctor(Microsoft.OpenApi.OpenApiInfo)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiInfo"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiInfo.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiInfo"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiInfo.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiInfo"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiInfo.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiInfo"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiInfo.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiInfo"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiLicense">
|
|
<summary>
|
|
License Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLicense.Name">
|
|
<summary>
|
|
REQUIRED. The license name used for the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLicense.Identifier">
|
|
<summary>
|
|
An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLicense.Url">
|
|
<summary>
|
|
The URL pointing to the contact information. MUST be in the format of a URL.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLicense.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLicense.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLicense.#ctor(Microsoft.OpenApi.OpenApiLicense)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiLicense"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLicense.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiLicense"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLicense.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiLicense"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLicense.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiLicense"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiLink">
|
|
<summary>
|
|
Link Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.OperationRef">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.OperationId">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.Parameters">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.RequestBody">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.Server">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLink.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLink.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLink.#ctor(Microsoft.OpenApi.IOpenApiLink)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiLink"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLink.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLink.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLink.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLink.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiMediaType">
|
|
<summary>
|
|
Media Type Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiMediaType.Schema">
|
|
<summary>
|
|
The schema defining the type used for the request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiMediaType.Example">
|
|
<summary>
|
|
Example of the media type.
|
|
The example object SHOULD be in the correct format as specified by the media type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiMediaType.Examples">
|
|
<summary>
|
|
Examples of the media type.
|
|
Each example object SHOULD match the media type and specified schema if present.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiMediaType.Encoding">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiMediaType.Extensions">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiMediaType.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiMediaType.#ctor(Microsoft.OpenApi.OpenApiMediaType)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiMediaType.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/> to Open Api v3.1.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiMediaType.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiMediaType.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiMediaType.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiOAuthFlow">
|
|
<summary>
|
|
OAuth Flow Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlow.AuthorizationUrl">
|
|
<summary>
|
|
REQUIRED. The authorization URL to be used for this flow.
|
|
Applies to implicit and authorizationCode OAuthFlow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlow.TokenUrl">
|
|
<summary>
|
|
REQUIRED. The token URL to be used for this flow.
|
|
Applies to password, clientCredentials, and authorizationCode OAuthFlow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlow.RefreshUrl">
|
|
<summary>
|
|
The URL to be used for obtaining refresh tokens.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlow.Scopes">
|
|
<summary>
|
|
REQUIRED. A map between the scope name and a short description for it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlow.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlow.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlow.#ctor(Microsoft.OpenApi.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlow.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlow.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlow.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlow.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiOAuthFlows">
|
|
<summary>
|
|
OAuth Flows Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlows.Implicit">
|
|
<summary>
|
|
Configuration for the OAuth Implicit flow
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlows.Password">
|
|
<summary>
|
|
Configuration for the OAuth Resource Owner Password flow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlows.ClientCredentials">
|
|
<summary>
|
|
Configuration for the OAuth Client Credentials flow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlows.AuthorizationCode">
|
|
<summary>
|
|
Configuration for the OAuth Authorization Code flow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlows.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlows.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlows.#ctor(Microsoft.OpenApi.OpenApiOAuthFlows)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/> object
|
|
</summary>
|
|
<param name="oAuthFlows"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlows.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlows.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlows.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOAuthFlows.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiOperation">
|
|
<summary>
|
|
Operation Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Tags">
|
|
<summary>
|
|
A list of tags for API documentation control.
|
|
Tags can be used for logical grouping of operations by resources or any other qualifier.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Summary">
|
|
<summary>
|
|
A short summary of what the operation does.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Description">
|
|
<summary>
|
|
A verbose explanation of the operation behavior.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation for this operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.OperationId">
|
|
<summary>
|
|
Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
|
|
Tools and libraries MAY use the operationId to uniquely identify an operation, therefore,
|
|
it is RECOMMENDED to follow common programming naming conventions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Parameters">
|
|
<summary>
|
|
A list of parameters that are applicable for this operation.
|
|
If a parameter is already defined at the Path Item, 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 list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.RequestBody">
|
|
<summary>
|
|
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.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Responses">
|
|
<summary>
|
|
REQUIRED. The list of possible responses as they are returned from executing this operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Callbacks">
|
|
<summary>
|
|
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.
|
|
The key value used to identify the callback object is an expression, evaluated at runtime,
|
|
that identifies a URL to use for the callback operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Deprecated">
|
|
<summary>
|
|
Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Security">
|
|
<summary>
|
|
A declaration of which security mechanisms can be used for this operation.
|
|
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.
|
|
This definition overrides any declared top-level security.
|
|
To remove a top-level security declaration, an empty array can be used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Servers">
|
|
<summary>
|
|
An alternative server array to service this operation.
|
|
If an alternative server object is specified at the Path Item Object or Root level,
|
|
it will be overridden by this value.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOperation.Metadata">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOperation.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOperation.#ctor(Microsoft.OpenApi.OpenApiOperation)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiOperation"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOperation.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOperation"/> to Open Api v3.1.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOperation.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOperation"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOperation.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOperation"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiOperation.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiOperation"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiParameter">
|
|
<summary>
|
|
Parameter Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.In">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Required">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Deprecated">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.AllowEmptyValue">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Style">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Explode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.AllowReserved">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Schema">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Examples">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Example">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameter.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.#ctor">
|
|
<summary>
|
|
A parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.#ctor(Microsoft.OpenApi.IOpenApiParameter)">
|
|
<summary>
|
|
Initializes a clone instance of <see cref="T:Microsoft.OpenApi.OpenApiParameter"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.WriteInPropertyForV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Write the "in" property for V2 serialization.
|
|
</summary>
|
|
<param name="writer">Writer to use for the serialization</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.WriteRequestBodySchemaForV2(Microsoft.OpenApi.IOpenApiWriter,System.Collections.Generic.Dictionary{System.String,Microsoft.OpenApi.IOpenApiExtension})">
|
|
<summary>
|
|
Write the request body schema for V2 serialization.
|
|
</summary>
|
|
<param name="writer">Writer to use for the serialization</param>
|
|
<param name="extensionsClone">Extensions clone</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameter.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiBodyParameter">
|
|
<summary>
|
|
Body parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiFormDataParameter">
|
|
<summary>
|
|
Form parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiPathItem">
|
|
<summary>
|
|
Path Item Object: to describe the operations available on a single path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItem.Summary">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItem.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItem.Operations">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItem.Servers">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItem.Parameters">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItem.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.AddOperation(System.Net.Http.HttpMethod,Microsoft.OpenApi.OpenApiOperation)">
|
|
<summary>
|
|
Add one operation into this path item.
|
|
</summary>
|
|
<param name="operationType">The operation type kind.</param>
|
|
<param name="operation">The operation item.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.#ctor(Microsoft.OpenApi.IOpenApiPathItem)">
|
|
<summary>
|
|
Initializes a clone of an <see cref="T:Microsoft.OpenApi.OpenApiPathItem"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiPathItem"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiPathItem"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize inline PathItem in OpenAPI V2
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItem.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiPaths">
|
|
<summary>
|
|
Paths object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPaths.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPaths.#ctor(Microsoft.OpenApi.OpenApiPaths)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.OpenApiPaths"/> object
|
|
</summary>
|
|
<param name="paths">The <see cref="T:Microsoft.OpenApi.OpenApiPaths"/>.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiReferenceWithDescription">
|
|
<summary>
|
|
OpenApiReferenceWithSummary is a reference to an OpenAPI component that includes a description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiReferenceWithDescription.Description">
|
|
<summary>
|
|
A description which by default SHOULD override that of the referenced component.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
If the referenced object-type does not allow a description field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescription.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescription.#ctor(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<summary>
|
|
Initializes a copy instance of the <see cref="T:Microsoft.OpenApi.OpenApiReferenceWithDescription"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescription.SerializeAdditionalV31Properties(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescription.SetAdditional31MetadataFromMapNode(System.Text.Json.Nodes.JsonObject)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary">
|
|
<summary>
|
|
OpenApiReferenceWithSummary is a reference to an OpenAPI component that includes a summary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary.Summary">
|
|
<summary>
|
|
A short summary which by default SHOULD override that of the referenced component.
|
|
If the referenced object-type does not allow a summary field, then this field has no effect.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary.#ctor(Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary)">
|
|
<summary>
|
|
Initializes a copy instance of the <see cref="T:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary.SerializeAdditionalV31Properties(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary.SetAdditional31MetadataFromMapNode(System.Text.Json.Nodes.JsonObject)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiRequestBody">
|
|
<summary>
|
|
Request Body Object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBody.Description">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBody.Required">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBody.Content">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBody.Extensions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.#ctor(Microsoft.OpenApi.IOpenApiRequestBody)">
|
|
<summary>
|
|
Initializes a copy instance of an <see cref="T:Microsoft.OpenApi.IOpenApiRequestBody"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiRequestBody"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiRequestBody"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiRequestBody"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.ConvertToBodyParameter(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.ConvertToFormDataParameters(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBody.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiResponse">
|
|
<summary>
|
|
Response object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponse.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponse.Headers">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponse.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponse.Links">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponse.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponse.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponse.#ctor(Microsoft.OpenApi.IOpenApiResponse)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.IOpenApiResponse"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponse.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiResponse"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponse.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiResponse"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponse.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponse.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiResponses">
|
|
<summary>
|
|
Responses object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponses.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponses.#ctor(Microsoft.OpenApi.OpenApiResponses)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.OpenApiResponses"/> object
|
|
</summary>
|
|
<param name="openApiResponses">The <see cref="T:Microsoft.OpenApi.OpenApiResponses"/></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSchema">
|
|
<summary>
|
|
The Schema Object allows the definition of input and output data types.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Title">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Schema">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Id">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Comment">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Vocabulary">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.DynamicRef">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.DynamicAnchor">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Definitions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.ExclusiveMaximum">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.IsExclusiveMaximum">
|
|
<summary>
|
|
Compatibility property for OpenAPI 3.0 or earlier serialization of the exclusive maximum value.
|
|
</summary>
|
|
DO NOT CHANGE THE VISIBILITY OF THIS PROPERTY TO PUBLIC
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.ExclusiveMinimum">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.IsExclusiveMinimum">
|
|
<summary>
|
|
Compatibility property for OpenAPI 3.0 or earlier serialization of the exclusive minimum value.
|
|
</summary>
|
|
DO NOT CHANGE THE VISIBILITY OF THIS PROPERTY TO PUBLIC
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Type">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Const">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Format">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Description">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Maximum">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Minimum">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MaxLength">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MinLength">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Pattern">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MultipleOf">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Default">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.ReadOnly">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.WriteOnly">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.AllOf">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.OneOf">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.AnyOf">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Not">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Required">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Items">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MaxItems">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MinItems">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.UniqueItems">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Properties">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.PatternProperties">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MaxProperties">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.MinProperties">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.AdditionalPropertiesAllowed">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.AdditionalProperties">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Discriminator">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Example">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Examples">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Enum">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.UnevaluatedProperties">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.ExternalDocs">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Deprecated">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Xml">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Extensions">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.UnrecognizedKeywords">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.Metadata">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchema.DependentRequired">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.#ctor(Microsoft.OpenApi.IOpenApiSchema)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.IOpenApiSchema"/> object
|
|
</summary>
|
|
<param name="schema">The schema object to copy from.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSchema"/> to Open Api v2.0 and handles not marking the provided property
|
|
as readonly if its included in the provided list of required properties of parent schema.
|
|
</summary>
|
|
<param name="writer">The open api writer.</param>
|
|
<param name="parentRequiredProperties">The list of required properties in parent schema.</param>
|
|
<param name="propertyName">The property name that will be serialized.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchema.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSecurityRequirement">
|
|
<summary>
|
|
Security Requirement Object.
|
|
Each name MUST correspond to a security scheme which is declared in
|
|
the Security Schemes under the Components Object.
|
|
If the security scheme is of type "oauth2" or "openIdConnect",
|
|
then the value is a list of scope names required for the execution.
|
|
For other security scheme types, the array MUST be empty.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.#ctor">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/> class.
|
|
This constructor ensures that only Reference.Id is considered when two dictionary keys
|
|
of type <see cref="T:Microsoft.OpenApi.OpenApiSecurityScheme"/> are compared.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSecuritySchemeReference})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer">
|
|
<summary>
|
|
Comparer for OpenApiSecurityScheme that only considers the Id in the Reference
|
|
(i.e. the string that will actually be displayed in the written document)
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.Equals(Microsoft.OpenApi.OpenApiSecuritySchemeReference,Microsoft.OpenApi.OpenApiSecuritySchemeReference)">
|
|
<summary>
|
|
Determines whether the specified objects are equal.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.GetHashCode(Microsoft.OpenApi.OpenApiSecuritySchemeReference)">
|
|
<summary>
|
|
Returns a hash code for the specified object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSecurityScheme">
|
|
<summary>
|
|
Security Scheme Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.In">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.Scheme">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.BearerFormat">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.Flows">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.OpenIdConnectUrl">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecurityScheme.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.#ctor(Microsoft.OpenApi.IOpenApiSecurityScheme)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.IOpenApiSecurityScheme"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityScheme"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityScheme"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiSecurityScheme"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.WriteOAuthFlowForV2(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiOAuthFlows)">
|
|
<summary>
|
|
Arbitrarily chooses one <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> object from the <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/>
|
|
to populate in V2 security scheme.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecurityScheme.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiServer">
|
|
<summary>
|
|
Server Object: an object representing a Server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServer.Description">
|
|
<summary>
|
|
An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServer.Url">
|
|
<summary>
|
|
REQUIRED. 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}.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServer.Variables">
|
|
<summary>
|
|
A map between a variable name and its value. The value is used for substitution in the server's URL template.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServer.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServer.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServer.#ctor(Microsoft.OpenApi.OpenApiServer)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiServer"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServer.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServer"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServer.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServer"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServer.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion,System.Action{Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.IOpenApiSerializable})">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServer"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServer.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServer"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiServerVariable">
|
|
<summary>
|
|
Server Variable Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServerVariable.Description">
|
|
<summary>
|
|
An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServerVariable.Default">
|
|
<summary>
|
|
REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied.
|
|
Unlike the Schema Object's default, this value MUST be provided by the consumer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServerVariable.Enum">
|
|
<summary>
|
|
An enumeration of string values to be used if the substitution options are from a limited set.
|
|
</summary>
|
|
<remarks>
|
|
If the server variable in the OpenAPI document has no <code>enum</code> member, this property will be null.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServerVariable.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerVariable.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerVariable.#ctor(Microsoft.OpenApi.OpenApiServerVariable)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerVariable.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerVariable.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerVariable.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerVariable.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiTag">
|
|
<summary>
|
|
Tag Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTag.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTag.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTag.ExternalDocs">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTag.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTag.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTag.#ctor(Microsoft.OpenApi.IOpenApiTag)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.IOpenApiTag"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTag.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiTag"/> to Open Api v3.1
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTag.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiTag"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTag.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiTag"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTag.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiXml">
|
|
<summary>
|
|
XML Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiXml.Name">
|
|
<summary>
|
|
Replaces the name of the element/attribute used for the described schema property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiXml.Namespace">
|
|
<summary>
|
|
The URI of the namespace definition. Value MUST be in the form of an absolute URI.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiXml.Prefix">
|
|
<summary>
|
|
The prefix to be used for the name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiXml.Attribute">
|
|
<summary>
|
|
Declares whether the property definition translates to an attribute instead of an element.
|
|
Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiXml.Wrapped">
|
|
<summary>
|
|
Signifies whether the array is wrapped.
|
|
Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiXml.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiXml.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiXml.#ctor(Microsoft.OpenApi.OpenApiXml)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiXml"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiXml.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiXml"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiXml.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiXml"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiXml.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.OpenApiXml"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ParameterLocation">
|
|
<summary>
|
|
The location of the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterLocation.Query">
|
|
<summary>
|
|
Parameters that are appended to the URL.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterLocation.Header">
|
|
<summary>
|
|
Custom headers that are expected as part of the request.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterLocation.Path">
|
|
<summary>
|
|
Used together with Path Templating,
|
|
where the parameter value is actually part of the operation's URL
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterLocation.Cookie">
|
|
<summary>
|
|
Used to pass a specific cookie value to the API.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ParameterStyle">
|
|
<summary>
|
|
The style of the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.Matrix">
|
|
<summary>
|
|
Path-style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.Label">
|
|
<summary>
|
|
Label style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.Form">
|
|
<summary>
|
|
Form style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.Simple">
|
|
<summary>
|
|
Simple style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.SpaceDelimited">
|
|
<summary>
|
|
Space separated array values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.PipeDelimited">
|
|
<summary>
|
|
Pipe separated array values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ParameterStyle.DeepObject">
|
|
<summary>
|
|
Provides a simple way of rendering nested objects using form parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3">
|
|
<summary>
|
|
Base class for OpenApiReferenceHolder.
|
|
</summary>
|
|
<typeparam name="T">The concrete class implementation type for the model.</typeparam>
|
|
<typeparam name="U">The interface type for the model.</typeparam>
|
|
<typeparam name="V">The type for the reference holding the additional fields and annotations</typeparam>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.Target">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.RecursiveTarget">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.CopyReference(`2)">
|
|
<summary>
|
|
Copy the reference as a target element with overrides.
|
|
</summary>
|
|
<param name="sourceReference">The source reference to copy</param>
|
|
<returns>The copy of the reference</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.#ctor(Microsoft.OpenApi.BaseOpenApiReferenceHolder{`0,`1,`2})">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="source">The parameter reference to copy</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.ReferenceType,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="referenceType">The reference type.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.UnresolvedReference">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.Reference">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.CopyReferenceAsTargetElementWithOverrides(`1)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.BaseOpenApiReferenceHolder`3.SerializeInternal(Microsoft.OpenApi.IOpenApiWriter,System.Action{Microsoft.OpenApi.IOpenApiWriter,`1})">
|
|
<summary>
|
|
Serialize the reference as a reference or the target object.
|
|
This method is used to accelerate the serialization methods implementations.
|
|
</summary>
|
|
<param name="writer">The OpenApiWriter.</param>
|
|
<param name="action">The action to serialize the target object.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiCallbackReference">
|
|
<summary>
|
|
Callback Object Reference: A reference to a map of possible out-of band callbacks related to the parent operation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallbackReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. an absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallbackReference.#ctor(Microsoft.OpenApi.OpenApiCallbackReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="callback">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiCallbackReference.PathItems">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiCallbackReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallbackReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiCallback)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallbackReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallbackReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiCallbackReference.CopyReference(Microsoft.OpenApi.BaseOpenApiReference)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExampleReference">
|
|
<summary>
|
|
Example Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExampleReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExampleReference.#ctor(Microsoft.OpenApi.OpenApiExampleReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="example">The example reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExampleReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExampleReference.Summary">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExampleReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExampleReference.ExternalValue">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExampleReference.Value">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExampleReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiExample)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExampleReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExampleReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiExampleReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiHeaderReference">
|
|
<summary>
|
|
Header Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeaderReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeaderReference.#ctor(Microsoft.OpenApi.OpenApiHeaderReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="header">The <see cref="T:Microsoft.OpenApi.OpenApiHeaderReference"/> object to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Required">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Deprecated">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.AllowEmptyValue">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Schema">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Style">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Explode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.AllowReserved">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Example">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Examples">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiHeaderReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeaderReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiHeader)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeaderReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiHeaderReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiLinkReference">
|
|
<summary>
|
|
Link Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLinkReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLinkReference.#ctor(Microsoft.OpenApi.OpenApiLinkReference)">
|
|
<summary>
|
|
Copy constructor.
|
|
</summary>
|
|
<param name="reference">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.OperationRef">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.OperationId">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.Server">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.Parameters">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.RequestBody">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLinkReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLinkReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLinkReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiLink)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLinkReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiLinkReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiParameterReference">
|
|
<summary>
|
|
Parameter Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameterReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameterReference.#ctor(Microsoft.OpenApi.OpenApiParameterReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="parameter">The parameter reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Required">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Deprecated">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.AllowEmptyValue">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.AllowReserved">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Schema">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Examples">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Example">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.In">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Style">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Explode">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameterReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiParameter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameterReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiParameterReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiPathItemReference">
|
|
<summary>
|
|
Path Item Object Reference: to describe the operations available on a single path.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItemReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItemReference.#ctor(Microsoft.OpenApi.OpenApiPathItemReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="pathItem">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItemReference.Summary">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItemReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItemReference.Operations">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItemReference.Servers">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItemReference.Parameters">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathItemReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItemReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiPathItem)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItemReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItemReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathItemReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescriptionAndSummary)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiRequestBodyReference">
|
|
<summary>
|
|
Request Body Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.#ctor(Microsoft.OpenApi.OpenApiRequestBodyReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="openApiRequestBodyReference">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBodyReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBodyReference.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBodyReference.Required">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiRequestBodyReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiRequestBody)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.ConvertToBodyParameter(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.ConvertToFormDataParameters(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiRequestBodyReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiResponseReference">
|
|
<summary>
|
|
Response Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponseReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponseReference.#ctor(Microsoft.OpenApi.OpenApiResponseReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="openApiResponseReference">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponseReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponseReference.Content">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponseReference.Headers">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponseReference.Links">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponseReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponseReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiResponse)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponseReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiResponseReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSchemaReference">
|
|
<summary>
|
|
Schema reference object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.#ctor(Microsoft.OpenApi.OpenApiSchemaReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="schema">The schema reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Title">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Schema">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Id">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Comment">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Vocabulary">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.DynamicRef">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.DynamicAnchor">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Definitions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.ExclusiveMaximum">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.ExclusiveMinimum">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Const">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Format">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Maximum">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Minimum">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MaxLength">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MinLength">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Pattern">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MultipleOf">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Default">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.ReadOnly">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.WriteOnly">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.AllOf">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.OneOf">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.AnyOf">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Not">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Required">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Items">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MaxItems">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MinItems">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.UniqueItems">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Properties">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.PatternProperties">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MaxProperties">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.MinProperties">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.AdditionalPropertiesAllowed">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.AdditionalProperties">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Discriminator">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Example">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Examples">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Enum">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.UnevaluatedProperties">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.ExternalDocs">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Deprecated">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Xml">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.UnrecognizedKeywords">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaReference.DependentRequired">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.SerializeAsV31(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.SerializeAsV3(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.SerializeAsV2(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiSchema)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaReference.CopyReference(Microsoft.OpenApi.JsonSchemaReference)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSecuritySchemeReference">
|
|
<summary>
|
|
Security Scheme Object Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecuritySchemeReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">The externally referenced file.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecuritySchemeReference.#ctor(Microsoft.OpenApi.OpenApiSecuritySchemeReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="openApiSecuritySchemeReference">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.In">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.Scheme">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.BearerFormat">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.Flows">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.OpenIdConnectUrl">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSecuritySchemeReference.Type">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecuritySchemeReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiSecurityScheme)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecuritySchemeReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSecuritySchemeReference.CopyReference(Microsoft.OpenApi.OpenApiReferenceWithDescription)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiTagReference">
|
|
<summary>
|
|
Tag Object Reference
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagReference.Target">
|
|
<summary>
|
|
Resolved target of the reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagReference.#ctor(System.String,Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Constructor initializing the reference object.
|
|
</summary>
|
|
<param name="referenceId">The reference Id.</param>
|
|
<param name="hostDocument">The host OpenAPI document.</param>
|
|
<param name="externalResource">Optional: External resource in the reference.
|
|
It may be:
|
|
1. a absolute/relative file path, for example: ../commons/pet.json
|
|
2. a Url, for example: http://localhost/pet.json
|
|
</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagReference.#ctor(Microsoft.OpenApi.OpenApiTagReference)">
|
|
<summary>
|
|
Copy constructor
|
|
</summary>
|
|
<param name="openApiTagReference">The reference to copy</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagReference.Description">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagReference.ExternalDocs">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagReference.Extensions">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagReference.Name">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagReference.CopyReferenceAsTargetElementWithOverrides(Microsoft.OpenApi.IOpenApiTag)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagReference.CreateShallowCopy">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagReference.CopyReference(Microsoft.OpenApi.BaseOpenApiReference)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ReferenceType">
|
|
<summary>
|
|
The reference type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Schema">
|
|
<summary>
|
|
Schema item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Response">
|
|
<summary>
|
|
Responses item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Parameter">
|
|
<summary>
|
|
Parameters item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Example">
|
|
<summary>
|
|
Examples item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.RequestBody">
|
|
<summary>
|
|
RequestBodies item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Header">
|
|
<summary>
|
|
Headers item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.SecurityScheme">
|
|
<summary>
|
|
SecuritySchemes item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Link">
|
|
<summary>
|
|
Links item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Callback">
|
|
<summary>
|
|
Callbacks item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.Tag">
|
|
<summary>
|
|
Tags item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ReferenceType.PathItem">
|
|
<summary>
|
|
Path item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.RuntimeExpressionAnyWrapper">
|
|
<summary>
|
|
The wrapper either for <see cref="T:System.Text.Json.Nodes.JsonNode"/> or <see cref="T:Microsoft.OpenApi.RuntimeExpression"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpressionAnyWrapper.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpressionAnyWrapper.#ctor(Microsoft.OpenApi.RuntimeExpressionAnyWrapper)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.RuntimeExpressionAnyWrapper"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.RuntimeExpressionAnyWrapper.Any">
|
|
<summary>
|
|
Gets/Sets the <see cref="T:System.Text.Json.Nodes.JsonNode"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.RuntimeExpressionAnyWrapper.Expression">
|
|
<summary>
|
|
Gets/Set the <see cref="T:Microsoft.OpenApi.RuntimeExpression"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuntimeExpressionAnyWrapper.WriteValue(Microsoft.OpenApi.IOpenApiWriter)">
|
|
<summary>
|
|
Write <see cref="T:Microsoft.OpenApi.RuntimeExpressionAnyWrapper"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.SecuritySchemeType">
|
|
<summary>
|
|
The type of the security scheme
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.SecuritySchemeType.ApiKey">
|
|
<summary>
|
|
Use API key
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.SecuritySchemeType.Http">
|
|
<summary>
|
|
Use basic or bearer token authorization header.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.SecuritySchemeType.OAuth2">
|
|
<summary>
|
|
Use OAuth2
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.SecuritySchemeType.OpenIdConnect">
|
|
<summary>
|
|
Use OAuth2 with OpenId Connect URL to discover OAuth2 configuration value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSpecVersion">
|
|
<summary>
|
|
Represents versions of OpenAPI specification.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi2_0">
|
|
<summary>
|
|
Represents OpenAPI V2.0 spec
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0">
|
|
<summary>
|
|
Represents all patches of OpenAPI V3.0 spec (e.g. 3.0.0, 3.0.1)
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_1">
|
|
<summary>
|
|
Represents OpenAPI V3.1 spec
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiTagComparer">
|
|
<summary>
|
|
This comparer is used to maintain a globally unique list of tags encountered
|
|
in a particular OpenAPI document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagComparer.Instance">
|
|
<summary>
|
|
Default instance for the comparer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagComparer.Equals(Microsoft.OpenApi.IOpenApiTag,Microsoft.OpenApi.IOpenApiTag)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiTagComparer.GetHashCode(Microsoft.OpenApi.IOpenApiTag)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.SRResource">
|
|
<summary>
|
|
A strongly-typed resource class, for looking up localized strings, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ResourceManager">
|
|
<summary>
|
|
Returns the cached ResourceManager instance used by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Culture">
|
|
<summary>
|
|
Overrides the current thread's CurrentUICulture property for all
|
|
resource lookups using this strongly typed resource class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ActiveScopeNeededForPropertyNameWriting">
|
|
<summary>
|
|
Looks up a localized string similar to There must be an active scope for name '{0}' to be written..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ArgumentNullOrWhiteSpace">
|
|
<summary>
|
|
Looks up a localized string similar to The argument '{0}' is null, empty or consists only of white-space..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ArgumentNull">
|
|
<summary>
|
|
Looks up a localized string similar to The argument '{0}' is null..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.DefaultBaseUri">
|
|
<summary>
|
|
Looks up a localized string similar to http://localhost/.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ExtensionFieldNameMustBeginWithXDash">
|
|
<summary>
|
|
Looks up a localized string similar to The filed name '{0}' of extension doesn't begin with x-..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.IndentationLevelInvalid">
|
|
<summary>
|
|
Looks up a localized string similar to Indentation level cannot be lower than 0..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.InputItemShouldBeType">
|
|
<summary>
|
|
Looks up a localized string similar to The input item should be in type of '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.InvalidReferenceId">
|
|
<summary>
|
|
Looks up a localized string similar to Invalid Reference identifier '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.InvalidReferenceType">
|
|
<summary>
|
|
Looks up a localized string similar to Invalid Reference Type '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.LocalReferenceRequiresType">
|
|
<summary>
|
|
Looks up a localized string similar to Local reference must have type specified..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ObjectScopeNeededForPropertyNameWriting">
|
|
<summary>
|
|
Looks up a localized string similar to The active scope must be an object scope for property name '{0}' to be written..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiExceptionGenericError">
|
|
<summary>
|
|
Looks up a localized string similar to An error occurred while processing the Open API document..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiFormatNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to The given OpenAPI format '{0}' is not supported..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiObjectElementIsRequired">
|
|
<summary>
|
|
Looks up a localized string similar to The object element name '{0}' is required..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiObjectMarkAsReference">
|
|
<summary>
|
|
Looks up a localized string similar to The OpenApi element '{0}' is already marked as reference object..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiParameterRequiredPropertyMandatory">
|
|
<summary>
|
|
Looks up a localized string similar to If the parameter location is "path", this property is REQUIRED and its value MUST be true.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiSpecVersionNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to The given OpenAPI specification version '{0}' is not supported..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiUnsupportedValueType">
|
|
<summary>
|
|
Looks up a localized string similar to The type '{0}' is not supported in Open API document..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.OpenApiWriterExceptionGenericError">
|
|
<summary>
|
|
Looks up a localized string similar to An error occurred while writing the Open API document..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ParseServerUrlDefaultValueNotAvailable">
|
|
<summary>
|
|
Looks up a localized string similar to Invalid server variable '{0}'. A value was not provided and no default value was provided..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ParseServerUrlValueNotValid">
|
|
<summary>
|
|
Looks up a localized string similar to Value '{0}' is not a valid value for variable '{1}'. If an enum is provided, it should not be empty and the value provided should exist in the enum.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.PrimitiveTypeNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to The given primitive type '{0}' is not supported..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ReferenceHasInvalidFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The reference string '{0}' has invalid format..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.RemoteReferenceNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to Remote reference not supported..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.RuntimeExpressionHasInvalidFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The runtime expression '{0}' has invalid format..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.RuntimeExpressionMustBeginWithDollar">
|
|
<summary>
|
|
Looks up a localized string similar to The runtime expression '{0}' should start with '$'.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ScopeMustBePresentToEnd">
|
|
<summary>
|
|
Looks up a localized string similar to Scope must be present to end..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ScopeToEndHasIncorrectType">
|
|
<summary>
|
|
Looks up a localized string similar to The scope to end is expected to be of type '{0}' but it is of type '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.SourceExpressionHasInvalidFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The source expression '{0}' has invalid format..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.UnknownVisitorType">
|
|
<summary>
|
|
Looks up a localized string similar to Can not find visitor type registered for type '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_ComponentsKeyMustMatchRegularExpr">
|
|
<summary>
|
|
Looks up a localized string similar to The key '{0}' in '{1}' of components MUST match the regular expression '{2}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_ExtensionNameMustBeginWithXDash">
|
|
<summary>
|
|
Looks up a localized string similar to The extension name '{0}' in '{1}' object MUST begin with 'x-'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_FieldIsRequired">
|
|
<summary>
|
|
Looks up a localized string similar to The field '{0}' in '{1}' object is REQUIRED..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_PathItemMustBeginWithSlash">
|
|
<summary>
|
|
Looks up a localized string similar to The path item name '{0}' MUST begin with a slash..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_PathSignatureMustBeUnique">
|
|
<summary>
|
|
Looks up a localized string similar to The path signature '{0}' MUST be unique..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_RuleAddTwice">
|
|
<summary>
|
|
Looks up a localized string similar to The same rule cannot be in the same rule set twice..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_SchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator">
|
|
<summary>
|
|
Looks up a localized string similar to Schema {0} must contain property specified in the discriminator {1} in the required field list..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.Validation_StringMustBeEmailAddress">
|
|
<summary>
|
|
Looks up a localized string similar to The string '{0}' MUST be in the format of an email address..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.WorkspaceRequredForExternalReferenceResolution">
|
|
<summary>
|
|
Looks up a localized string similar to OpenAPI document must be added to an OpenApiWorkspace to be able to resolve external references..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.HostDocumentIsNull">
|
|
<summary>
|
|
Looks up a localized string similar to The HostDocument is null..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SRResource.ReferenceIdIsNullOrEmpty">
|
|
<summary>
|
|
Looks up a localized string similar to The identifier in the referenced element is null or empty ..
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.OpenApiDiagnostic">
|
|
<summary>
|
|
Object containing all diagnostic information related to Open API parsing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiDiagnostic.Errors">
|
|
<summary>
|
|
List of all errors.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiDiagnostic.Warnings">
|
|
<summary>
|
|
List of all warnings
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiDiagnostic.SpecificationVersion">
|
|
<summary>
|
|
Open API specification version of the document parsed.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiDiagnostic.AppendDiagnostic(Microsoft.OpenApi.Reader.OpenApiDiagnostic,System.String)">
|
|
<summary>
|
|
Append another set of diagnostic Errors and Warnings to this one, this may be appended from another external
|
|
document's parsing and we want to indicate which file it originated from.
|
|
</summary>
|
|
<param name="diagnosticToAdd">The diagnostic instance of which the errors and warnings are to be appended to this diagnostic's</param>
|
|
<param name="fileNameToAdd">The originating file of the diagnostic to be appended, this is prefixed to each error and warning to indicate the originating file</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.IDiagnosticExtensions">
|
|
<summary>
|
|
Extension class for IList to add the Method "AddRange" used above
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.IDiagnosticExtensions.AddRange``1(System.Collections.Generic.ICollection{``0},System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Extension method for IList so that another list can be added to the current list.
|
|
</summary>
|
|
<param name="collection"></param>
|
|
<param name="enumerable"></param>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.OpenApiJsonReader">
|
|
<summary>
|
|
A reader class for parsing JSON files into Open API documents.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiJsonReader.Read(System.IO.MemoryStream,System.Uri,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Reads the memory stream input and parses it into an Open API document.
|
|
</summary>
|
|
<param name="input">Memory stream containing OpenAPI description to parse.</param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<param name="settings">The Reader settings to be used during parsing.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiJsonReader.Read(System.Text.Json.Nodes.JsonNode,System.Uri,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Parses the JsonNode input into an Open API document.
|
|
</summary>
|
|
<param name="jsonNode">The JsonNode input.</param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<param name="settings">The Reader settings to be used during parsing.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiJsonReader.ReadAsync(System.IO.Stream,System.Uri,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Reads the stream input asynchronously and parses it into an Open API document.
|
|
</summary>
|
|
<param name="input">Memory stream containing OpenAPI description to parse.</param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<param name="settings">The Reader settings to be used during parsing.</param>
|
|
<param name="cancellationToken">Propagates notifications that operations should be cancelled.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiJsonReader.ReadFragment``1(System.IO.MemoryStream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.Reader.OpenApiDiagnostic@,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiJsonReader.ReadFragment``1(System.Text.Json.Nodes.JsonNode,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.Reader.OpenApiDiagnostic@,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.OpenApiModelFactory">
|
|
<summary>
|
|
A factory class for loading OpenAPI models from various sources.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.Load(System.IO.MemoryStream,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Loads the input stream and parses it into an Open API document.
|
|
</summary>
|
|
<param name="stream"> The input stream.</param>
|
|
<param name="settings"> The OpenApi reader settings.</param>
|
|
<param name="format">The OpenAPI format.</param>
|
|
<returns>An OpenAPI document instance.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.Load``1(System.IO.MemoryStream,Microsoft.OpenApi.OpenApiSpecVersion,System.String,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.Reader.OpenApiDiagnostic@,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Reads the stream input and parses the fragment of an OpenAPI description into an Open API Element.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
<param name="input">Stream containing OpenAPI description to parse.</param>
|
|
<param name="version">Version of the OpenAPI specification that the fragment conforms to.</param>
|
|
<param name="format"></param>
|
|
<param name="openApiDocument">The OpenApiDocument object to which the fragment belongs, used to lookup references.</param>
|
|
<param name="diagnostic">Returns diagnostic object containing errors detected during parsing.</param>
|
|
<param name="settings">The OpenApiReader settings.</param>
|
|
<returns>Instance of newly created IOpenApiElement.</returns>
|
|
<returns>The OpenAPI element.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.LoadAsync(System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Loads the input URL and parses it into an Open API document.
|
|
</summary>
|
|
<param name="url">The path to the OpenAPI file</param>
|
|
<param name="settings"> The OpenApi reader settings.</param>
|
|
<param name="token">The cancellation token</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.LoadAsync``1(System.String,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Reads the stream input and parses the fragment of an OpenAPI description into an Open API Element.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
<param name="url">The path to the OpenAPI file</param>
|
|
<param name="version">Version of the OpenAPI specification that the fragment conforms to.</param>
|
|
<param name="settings">The OpenApiReader settings.</param>
|
|
<param name="openApiDocument">The OpenApiDocument object to which the fragment belongs, used to lookup references.</param>
|
|
<param name="token"></param>
|
|
<returns>Instance of newly created IOpenApiElement.</returns>
|
|
<returns>The OpenAPI element.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.LoadAsync(System.IO.Stream,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Loads the input stream and parses it into an Open API document. If the stream is not buffered and it contains yaml, it will be buffered before parsing.
|
|
</summary>
|
|
<param name="input">The input stream.</param>
|
|
<param name="settings"> The OpenApi reader settings.</param>
|
|
<param name="cancellationToken">Propagates notification that operations should be cancelled.</param>
|
|
<param name="format">The Open API format</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.LoadAsync``1(System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Reads the stream input and ensures it is buffered before passing it to the Load method.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
<param name="input"></param>
|
|
<param name="version"></param>
|
|
<param name="openApiDocument">The document used to lookup tag or schema references.</param>
|
|
<param name="format"></param>
|
|
<param name="settings"></param>
|
|
<param name="token"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.Parse(System.String,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Reads the input string and parses it into an Open API document.
|
|
</summary>
|
|
<param name="input">The input string.</param>
|
|
<param name="format">The Open API format</param>
|
|
<param name="settings">The OpenApi reader settings.</param>
|
|
<returns>An OpenAPI document instance.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiModelFactory.Parse``1(System.String,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument,Microsoft.OpenApi.Reader.OpenApiDiagnostic@,System.String,Microsoft.OpenApi.Reader.OpenApiReaderSettings)">
|
|
<summary>
|
|
Reads the input string and parses it into an Open API document.
|
|
</summary>
|
|
<param name="input">The input string.</param>
|
|
<param name="version"></param>
|
|
<param name="openApiDocument">The OpenApiDocument object to which the fragment belongs, used to lookup references.</param>
|
|
<param name="diagnostic">The diagnostic entity containing information from the reading process.</param>
|
|
<param name="format">The Open API format</param>
|
|
<param name="settings">The OpenApi reader settings.</param>
|
|
<returns>An OpenAPI document instance.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.OpenApiReaderSettings">
|
|
<summary>
|
|
Configuration settings to control how OpenAPI documents are parsed
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.HttpClient">
|
|
<summary>
|
|
HttpClient to use for making requests and retrieve documents
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiReaderSettings.AddJsonReader">
|
|
<summary>
|
|
Adds a reader for the specified format
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiReaderSettings.GetReader(System.String)">
|
|
<summary>
|
|
Gets the reader for the specified format
|
|
</summary>
|
|
<param name="format">Format to fetch the reader for</param>
|
|
<returns>The retrieved reader</returns>
|
|
<exception cref="T:System.NotSupportedException">When no reader is registered for that format</exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiReaderSettings.TryAddReader(System.String,Microsoft.OpenApi.IOpenApiReader)">
|
|
<summary>
|
|
Adds a reader for the specified format.
|
|
This method is a no-op if the reader already exists.
|
|
This method is equivalent to TryAdd, is provided for compatibility reasons and TryAdd should be used instead when available.
|
|
</summary>
|
|
<param name="format">Format to add a reader for</param>
|
|
<param name="reader">Reader to add</param>
|
|
<returns>True if the reader was added, false if it already existed</returns>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.Readers">
|
|
<summary>
|
|
Readers to use to parse the OpenAPI document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.LoadExternalRefs">
|
|
<summary>
|
|
When external references are found, load them into a shared workspace
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.ExtensionParsers">
|
|
<summary>
|
|
Dictionary of parsers for converting extensions into strongly typed classes
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.RuleSet">
|
|
<summary>
|
|
Rules to use for validating OpenAPI specification. If none are provided a default set of rules are applied.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.BaseUrl">
|
|
<summary>
|
|
URL where relative references should be resolved from if the description does not contain Server definitions
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.DefaultContentType">
|
|
<summary>
|
|
Allows clients to define a custom DefaultContentType if produces array is empty
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.CustomExternalLoader">
|
|
<summary>
|
|
Function used to provide an alternative loader for accessing external references.
|
|
</summary>
|
|
<remarks>
|
|
Default loader will attempt to dereference http(s) urls and file urls.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiReaderSettings.LeaveStreamOpen">
|
|
<summary>
|
|
Whether to leave the <see cref="T:System.IO.Stream"/> object open after reading
|
|
from an OpenApiStreamReader object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiReaderSettings.AddMicrosoftExtensionParsers">
|
|
<summary>
|
|
Adds parsers for Microsoft OpenAPI extensions:
|
|
- <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension"/>
|
|
- <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension"/>
|
|
- <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPrimaryErrorMessageExtension"/>
|
|
- <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension"/>
|
|
- <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiReservedParameterExtension"/>
|
|
- <see cref="T:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension"/>
|
|
NOTE: The list of extensions is subject to change.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.OpenApiVersionExtensionMethods">
|
|
<summary>
|
|
Generates custom extension methods for the version string type
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiVersionExtensionMethods.is2_0(System.String)">
|
|
<summary>
|
|
Extension method for Spec version 2.0
|
|
</summary>
|
|
<param name="version"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiVersionExtensionMethods.is3_0(System.String)">
|
|
<summary>
|
|
Extension method for Spec version 3.0
|
|
</summary>
|
|
<param name="version"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiVersionExtensionMethods.is3_1(System.String)">
|
|
<summary>
|
|
Extension method for Spec version 3.1
|
|
</summary>
|
|
<param name="version"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.AnyFieldMapParameter`1.#ctor(System.Func{`0,System.Text.Json.Nodes.JsonNode},System.Action{`0,System.Text.Json.Nodes.JsonNode},System.Func{`0,Microsoft.OpenApi.IOpenApiSchema})">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyFieldMapParameter`1.PropertyGetter">
|
|
<summary>
|
|
Function to retrieve the value of the property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyFieldMapParameter`1.PropertySetter">
|
|
<summary>
|
|
Function to set the value of the property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyFieldMapParameter`1.SchemaGetter">
|
|
<summary>
|
|
Function to get the schema to apply to the property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.AnyListFieldMapParameter`1.#ctor(System.Func{`0,System.Collections.Generic.List{System.Text.Json.Nodes.JsonNode}},System.Action{`0,System.Collections.Generic.List{System.Text.Json.Nodes.JsonNode}},System.Func{`0,Microsoft.OpenApi.OpenApiSchema})">
|
|
<summary>
|
|
Constructor
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyListFieldMapParameter`1.PropertyGetter">
|
|
<summary>
|
|
Function to retrieve the value of the property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyListFieldMapParameter`1.PropertySetter">
|
|
<summary>
|
|
Function to set the value of the property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyListFieldMapParameter`1.SchemaGetter">
|
|
<summary>
|
|
Function to get the schema to apply to the property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.AnyMapFieldMapParameter`2.#ctor(System.Func{`0,System.Collections.Generic.IDictionary{System.String,`1}},System.Func{`1,System.Text.Json.Nodes.JsonNode},System.Action{`1,System.Text.Json.Nodes.JsonNode},System.Func{`0,Microsoft.OpenApi.IOpenApiSchema})">
|
|
<summary>
|
|
Constructor
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyMapFieldMapParameter`2.PropertyMapGetter">
|
|
<summary>
|
|
Function to retrieve the property that is a map from string to an inner element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyMapFieldMapParameter`2.PropertyGetter">
|
|
<summary>
|
|
Function to retrieve the value of the property from an inner element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyMapFieldMapParameter`2.PropertySetter">
|
|
<summary>
|
|
Function to set the value of the property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.AnyMapFieldMapParameter`2.SchemaGetter">
|
|
<summary>
|
|
Function to get the schema to apply to the property.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.JsonPointerExtensions">
|
|
<summary>
|
|
Extensions for JSON pointers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.JsonPointerExtensions.Find(Microsoft.OpenApi.JsonPointer,System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Finds the JSON node that corresponds to this JSON pointer based on the base Json node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ListNode.CreateAny">
|
|
<summary>
|
|
Create a <see cref="T:System.Text.Json.Nodes.JsonArray"/>
|
|
</summary>
|
|
<returns>The created Any object.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.MapNode">
|
|
<summary>
|
|
Abstraction of a Map to isolate semantic parsing from details of JSON DOM
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.MapNode.CreateAny">
|
|
<summary>
|
|
Create an <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/>
|
|
</summary>
|
|
<returns>The created Json object.</returns>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.SourceGenerationContext.JsonObject">
|
|
<summary>
|
|
Defines the source generated JSON serialization contract metadata for a given type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.SourceGenerationContext.Default">
|
|
<summary>
|
|
The default <see cref="T:System.Text.Json.Serialization.JsonSerializerContext"/> associated with a default <see cref="T:System.Text.Json.JsonSerializerOptions"/> instance.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.SourceGenerationContext.GeneratedSerializerOptions">
|
|
<summary>
|
|
The source-generated options associated with this context.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.SourceGenerationContext.#ctor">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.SourceGenerationContext.#ctor(System.Text.Json.JsonSerializerOptions)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.SourceGenerationContext.GetTypeInfo(System.Type)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.RootNode">
|
|
<summary>
|
|
Wrapper class around JsonDocument to isolate semantic parsing from details of Json DOM.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ValueNode.CreateAny">
|
|
<summary>
|
|
Create a <see cref="T:System.Text.Json.Nodes.JsonNode"/>
|
|
</summary>
|
|
<returns>The created Any object.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.ParsingContext">
|
|
<summary>
|
|
The Parsing Context holds temporary state needed whilst parsing an OpenAPI Document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ParsingContext.ExtensionParsers">
|
|
<summary>
|
|
Extension parsers
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ParsingContext.BaseUrl">
|
|
<summary>
|
|
The base url for the document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ParsingContext.DefaultContentType">
|
|
<summary>
|
|
Default content type for a response object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ParsingContext.Diagnostic">
|
|
<summary>
|
|
Diagnostic object that returns metadata about the parsing process.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.#ctor(Microsoft.OpenApi.Reader.OpenApiDiagnostic)">
|
|
<summary>
|
|
Create Parsing Context
|
|
</summary>
|
|
<param name="diagnostic">Provide instance for diagnostic object for collecting and accessing information about the parsing.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.Parse(System.Text.Json.Nodes.JsonNode,System.Uri)">
|
|
<summary>
|
|
Initiates the parsing process. Not thread safe and should only be called once on a parsing context
|
|
</summary>
|
|
<param name="jsonNode">Set of Json nodes to parse.</param>
|
|
<param name="location">Location of where the document that is getting loaded is saved</param>
|
|
<returns>An OpenApiDocument populated based on the passed yamlDocument </returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.ParseFragment``1(System.Text.Json.Nodes.JsonNode,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Initiates the parsing process of a fragment. Not thread safe and should only be called once on a parsing context
|
|
</summary>
|
|
<param name="jsonNode"></param>
|
|
<param name="version">OpenAPI version of the fragment</param>
|
|
<param name="openApiDocument">The OpenApiDocument object to which the fragment belongs, used to lookup references.</param>
|
|
<returns>An OpenApiDocument populated based on the passed yamlDocument </returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.GetVersion(Microsoft.OpenApi.Reader.RootNode)">
|
|
<summary>
|
|
Gets the version of the Open API document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ParsingContext.VersionService">
|
|
<summary>
|
|
Service providing all Version specific conversion functions
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.EndObject">
|
|
<summary>
|
|
End the current object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.GetLocation">
|
|
<summary>
|
|
Get the current location as string representing JSON pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.GetFromTempStorage``1(System.String,System.Object)">
|
|
<summary>
|
|
Gets the value from the temporary storage matching the given key.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.SetTempStorage(System.String,System.Object,System.Object)">
|
|
<summary>
|
|
Sets the temporary storage for this key and value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ParsingContext.StartObject(System.String)">
|
|
<summary>
|
|
Starts an object with the given object name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.ReadResult">
|
|
<summary>
|
|
Container object used for returning the result of reading an OpenAPI description.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ReadResult.Document">
|
|
<summary>
|
|
The parsed OpenApiDocument. Null will be returned if the document could not be parsed.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.ReadResult.Diagnostic">
|
|
<summary>
|
|
OpenApiDiagnostic contains the Errors reported while parsing
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.ReadResult.Deconstruct(Microsoft.OpenApi.OpenApiDocument@,Microsoft.OpenApi.Reader.OpenApiDiagnostic@)">
|
|
<summary>
|
|
Deconstructs the result for easier assignment on the client application.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.DefaultStreamLoader">
|
|
<summary>
|
|
Implementation of IInputLoader that loads streams from URIs
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.DefaultStreamLoader.#ctor(System.Net.Http.HttpClient)">
|
|
<summary>
|
|
The default stream loader
|
|
</summary>
|
|
<param name="httpClient">The HttpClient to use to retrieve documents when needed</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.DefaultStreamLoader.LoadAsync(System.Uri,System.Uri,System.Threading.CancellationToken)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.OpenApiRemoteReferenceCollector">
|
|
<summary>
|
|
Builds a list of all remote references used in an OpenApi document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Reader.OpenApiRemoteReferenceCollector.References">
|
|
<summary>
|
|
List of all external references collected from OpenApiDocument
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiRemoteReferenceCollector.Visit(Microsoft.OpenApi.IOpenApiReferenceHolder)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.OpenApiRemoteReferenceCollector.AddExternalReferences(Microsoft.OpenApi.BaseOpenApiReference)">
|
|
<summary>
|
|
Collect external references
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V2.OpenApiV2Deserializer">
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V2 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V2.OpenApiV2VersionService">
|
|
<summary>
|
|
The version specific implementations for OpenAPI V2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.V2.OpenApiV2VersionService.#ctor(Microsoft.OpenApi.Reader.OpenApiDiagnostic)">
|
|
<summary>
|
|
Create Parsing Context
|
|
</summary>
|
|
<param name="diagnostic">Provide instance for diagnostic object for collecting and accessing information about the parsing.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V2.TempStorageKeys">
|
|
<summary>
|
|
Strings to be used as keys for the temporary storage.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V31.OpenApiV31Deserializer">
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V31 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V31.OpenApiV31VersionService">
|
|
<summary>
|
|
The version service for the Open API V3.1.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.V31.OpenApiV31VersionService.#ctor(Microsoft.OpenApi.Reader.OpenApiDiagnostic)">
|
|
<summary>
|
|
Create Parsing Context
|
|
</summary>
|
|
<param name="diagnostic">Provide instance for diagnotic object for collecting and accessing information about the parsing.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V3.OpenApiV3Deserializer">
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
<summary>
|
|
Class containing logic to deserialize Open API V3 document into
|
|
runtime Open API object model.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Reader.V3.OpenApiV3VersionService">
|
|
<summary>
|
|
The version service for the Open API V3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Reader.V3.OpenApiV3VersionService.#ctor(Microsoft.OpenApi.Reader.OpenApiDiagnostic)">
|
|
<summary>
|
|
Create Parsing Context
|
|
</summary>
|
|
<param name="diagnostic">Provide instance for diagnostic object for collecting and accessing information about the parsing.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.CopyReferences.Visit(Microsoft.OpenApi.IOpenApiReferenceHolder)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.CopyReferences.Visit(Microsoft.OpenApi.IOpenApiSchema)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.LoopDetector.PushLoop``1(``0)">
|
|
<summary>
|
|
Maintain history of traversals to avoid stack overflows from cycles
|
|
</summary>
|
|
<param name="key">Identifier used for current context.</param>
|
|
<returns>If method returns false a loop was detected and the key is not added.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.LoopDetector.PopLoop``1">
|
|
<summary>
|
|
Exit from the context in cycle detection
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.LoopDetector.Loops">
|
|
<summary>
|
|
List of Loops detected
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.LoopDetector.ClearLoop``1">
|
|
<summary>
|
|
Reset loop tracking stack
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiFilterService">
|
|
<summary>
|
|
A service that slices an OpenApiDocument into a subset document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiFilterService.CreatePredicate(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Create predicate function based on passed query parameters
|
|
</summary>
|
|
<param name="operationIds">Comma delimited list of operationIds or * for all operations.</param>
|
|
<param name="tags">Comma delimited list of tags or a single regex.</param>
|
|
<param name="requestUrls">A dictionary of requests from a postman collection.</param>
|
|
<param name="source">The input OpenAPI document.</param>
|
|
<returns>A predicate.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiFilterService.CreateFilteredDocument(Microsoft.OpenApi.OpenApiDocument,System.Func{System.String,System.Net.Http.HttpMethod,Microsoft.OpenApi.OpenApiOperation,System.Boolean})">
|
|
<summary>
|
|
Create partial OpenAPI document based on the provided predicate.
|
|
</summary>
|
|
<param name="source">The target <see cref="T:Microsoft.OpenApi.OpenApiDocument"/>.</param>
|
|
<param name="predicate">A predicate function.</param>
|
|
<returns>A partial OpenAPI document.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiFilterService.CreateOpenApiUrlTreeNode(System.Collections.Generic.Dictionary{System.String,Microsoft.OpenApi.OpenApiDocument})">
|
|
<summary>
|
|
Creates an <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> from a collection of <see cref="T:Microsoft.OpenApi.OpenApiDocument"/>.
|
|
</summary>
|
|
<param name="sources">Dictionary of labels and their corresponding <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> objects.</param>
|
|
<returns>The created <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiReferenceError">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiReferenceError.Reference">
|
|
<summary>
|
|
The reference that caused the error.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceError.#ctor(Microsoft.OpenApi.OpenApiException)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiError"/> class using the message and pointer from the given exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiReferenceError.#ctor(Microsoft.OpenApi.BaseOpenApiReference,System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="reference"></param>
|
|
<param name="message"></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiUrlTreeNode">
|
|
<summary>
|
|
A directory structure representing the paths of an OpenAPI document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUrlTreeNode.Children">
|
|
<summary>
|
|
All the subdirectories of a node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUrlTreeNode.Path">
|
|
<summary>
|
|
The relative directory path of the current node from the root node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUrlTreeNode.PathItems">
|
|
<summary>
|
|
Dictionary of labels and Path Item objects that describe the operations available on a node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUrlTreeNode.AdditionalData">
|
|
<summary>
|
|
A dictionary of key value pairs that contain information about a node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUrlTreeNode.IsParameter">
|
|
<summary>
|
|
Flag indicating whether a node segment is a path parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiUrlTreeNode.Segment">
|
|
<summary>
|
|
The subdirectory of a relative path.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.HasOperations(System.String)">
|
|
<summary>
|
|
Flag indicating whether the node's PathItems dictionary has operations
|
|
under a given label.
|
|
</summary>
|
|
<param name="label">The name of the key for the target operations
|
|
in the node's PathItems dictionary.</param>
|
|
<returns>true or false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.#ctor(System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="segment">The subdirectory of a relative path.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.Create">
|
|
<summary>
|
|
Creates an empty structured directory of <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node.
|
|
</summary>
|
|
<returns>The root node of the created <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> directory structure.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.Create(Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Creates a structured directory of <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> nodes from the paths of an OpenAPI document.
|
|
</summary>
|
|
<param name="doc">The OpenAPI document.</param>
|
|
<param name="label">Name tag for labelling the <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> nodes in the directory structure.</param>
|
|
<returns>The root node of the created <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> directory structure.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.Attach(Microsoft.OpenApi.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Retrieves the paths from an OpenAPI document and appends the items to an <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node.
|
|
</summary>
|
|
<param name="doc">The OpenAPI document.</param>
|
|
<param name="label">Name tag for labelling related <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> nodes in the directory structure.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.Attach(System.String,Microsoft.OpenApi.IOpenApiPathItem,System.String)">
|
|
<summary>
|
|
Appends a path and the PathItem to an <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node.
|
|
</summary>
|
|
<param name="path">An OpenAPI path.</param>
|
|
<param name="pathItem">Path Item object that describes the operations available on an OpenAPI path.</param>
|
|
<param name="label">A name tag for labelling the <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node.</param>
|
|
<returns>An <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node describing an OpenAPI path.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.Attach(System.Collections.Generic.IEnumerable{System.String},Microsoft.OpenApi.IOpenApiPathItem,System.String,System.String)">
|
|
<summary>
|
|
Assembles the constituent properties of an <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node.
|
|
</summary>
|
|
<param name="segments">IEnumerable subdirectories of a relative path.</param>
|
|
<param name="pathItem">Path Item object that describes the operations available on an OpenAPI path.</param>
|
|
<param name="label">A name tag for labelling the <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node.</param>
|
|
<param name="currentPath">The relative path of a node.</param>
|
|
<returns>An <see cref="T:Microsoft.OpenApi.OpenApiUrlTreeNode"/> node with all constituent properties assembled.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.AddAdditionalData(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}})">
|
|
<summary>
|
|
Adds additional data information to the AdditionalData property of the node.
|
|
</summary>
|
|
<param name="additionalData">A dictionary of key value pairs that contain information about a node.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiUrlTreeNode.WriteMermaid(System.IO.TextWriter)">
|
|
<summary>
|
|
Write tree as Mermaid syntax
|
|
</summary>
|
|
<param name="writer">StreamWriter to write the Mermaid content to</param>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiUrlTreeNode.MermaidNodeStyles">
|
|
<summary>
|
|
Dictionary that maps a set of HTTP methods to HTML color. Keys are sorted, upper-cased, concatenated HTTP methods.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MermaidNodeStyle">
|
|
<summary>
|
|
Defines the color and shape of a node in a Mermaid graph diagram
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MermaidNodeStyle.#ctor(System.String,Microsoft.OpenApi.MermaidNodeShape)">
|
|
<summary>
|
|
Create a style that defines the color and shape of a diagram element
|
|
</summary>
|
|
<param name="color"></param>
|
|
<param name="shape"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MermaidNodeStyle.Color">
|
|
<summary>
|
|
The CSS color name of the diagram element
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.MermaidNodeStyle.Shape">
|
|
<summary>
|
|
The shape of the diagram element
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.MermaidNodeShape">
|
|
<summary>
|
|
Shapes supported by Mermaid diagrams
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.MermaidNodeShape.SquareCornerRectangle">
|
|
<summary>
|
|
Rectangle with square corners
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.MermaidNodeShape.RoundedCornerRectangle">
|
|
<summary>
|
|
Rectangle with rounded corners
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.MermaidNodeShape.Circle">
|
|
<summary>
|
|
Circle
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.MermaidNodeShape.Rhombus">
|
|
<summary>
|
|
Rhombus
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.MermaidNodeShape.OddShape">
|
|
<summary>
|
|
Odd shape
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiVisitorBase">
|
|
<summary>
|
|
Open API visitor base provides common logic for concrete visitors
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiVisitorBase.CurrentKeys">
|
|
<summary>
|
|
Properties available to identify context of where an object is within OpenAPI Document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Enter(System.String)">
|
|
<summary>
|
|
Allow Rule to indicate validation error occured at a deeper context level.
|
|
</summary>
|
|
<param name="segment">Identifier for context</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Exit">
|
|
<summary>
|
|
Exit from path context level. Enter and Exit calls should be matched.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiVisitorBase.PathString">
|
|
<summary>
|
|
Pointer to source of validation error in document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiDocument"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Visits <see cref="T:System.Text.Json.Nodes.JsonNode"/>
|
|
</summary>
|
|
<param name="node"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiInfo)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiInfo"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiContact)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiContact"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiLicense)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiLicense"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.OpenApiServer})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiServer"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiServer)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiServer"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiPaths)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiPaths"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiPathItem})">
|
|
<summary>
|
|
Visits Webhooks>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiPathItem)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiPathItem"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiServerVariable)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.Net.Http.HttpMethod,Microsoft.OpenApi.OpenApiOperation})">
|
|
<summary>
|
|
Visits the operations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiOperation)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiOperation"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.IOpenApiParameter})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiParameter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiParameter)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiParameter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiRequestBody)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiRequestBody"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiHeader})">
|
|
<summary>
|
|
Visits headers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiCallback})">
|
|
<summary>
|
|
Visits callbacks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiResponse)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiResponse"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiResponses)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiResponses"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiMediaType})">
|
|
<summary>
|
|
Visits media type content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiMediaType)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiEncoding)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiEncoding"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiExample})">
|
|
<summary>
|
|
Visits the examples.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiComponents)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiComponents"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiExternalDocs)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiComponents"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiSchema)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiSchema"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiLink})">
|
|
<summary>
|
|
Visits the links.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiLink)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiLink"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiCallback)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiCallback"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiTag)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiTag"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiTagReference)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiTagReference"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiHeader)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiHeader"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.OpenApiSecurityRequirement)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiSecurityScheme)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiSecurityScheme"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiExample)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiExample"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.ISet{Microsoft.OpenApi.OpenApiTag})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiTag"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.ISet{Microsoft.OpenApi.OpenApiTagReference})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiTagReference"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.OpenApiSecurityRequirement})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiExtensible)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiExtensible"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiExtension)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiExtension"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.List{Microsoft.OpenApi.IOpenApiExample})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.IOpenApiExample"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiServerVariable})">
|
|
<summary>
|
|
Visits a dictionary of server variables
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiEncoding})">
|
|
<summary>
|
|
Visits a dictionary of encodings
|
|
</summary>
|
|
<param name="encodings"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiVisitorBase.Visit(Microsoft.OpenApi.IOpenApiReferenceHolder)">
|
|
<summary>
|
|
Visits IOpenApiReferenceable instances that are references and not in components
|
|
</summary>
|
|
<param name="referenceHolder">Referencing object</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWalker">
|
|
<summary>
|
|
The walker to visit multiple Open API elements.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.#ctor(Microsoft.OpenApi.OpenApiVisitorBase)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiWalker"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiDocument"/> and child objects
|
|
</summary>
|
|
<param name="doc">OpenApiDocument to be walked</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.ISet{Microsoft.OpenApi.OpenApiTag})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiTag"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.ISet{Microsoft.OpenApi.OpenApiTagReference})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiTagReference"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.String)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiExternalDocs)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiComponents)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiComponents"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiPaths)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiPaths"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiPathItem})">
|
|
<summary>
|
|
Visits Webhooks and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.OpenApiServer})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiServer"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiInfo)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiInfo"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiExtensible)">
|
|
<summary>
|
|
Visits dictionary of extensions
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiExtension)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiExtension"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiLicense)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiLicense"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiContact)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiContact"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiCallback,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiCallback"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiTag)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiTag"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiTagReference)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiTagReference"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiServer)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiServer"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiServerVariable})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiServerVariable)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiServerVariable"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiPathItem,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiPathItem"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.Net.Http.HttpMethod,Microsoft.OpenApi.OpenApiOperation})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.OpenApiOperation"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiOperation)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiOperation"/> and child objects
|
|
</summary>
|
|
<param name="operation"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.OpenApiSecurityRequirement})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.IOpenApiParameter})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiParameter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiParameter,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiParameter"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiResponses)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiResponses"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiResponse,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiResponse"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiRequestBody,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiRequestBody"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiHeader})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.OpenApiHeader"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiCallback})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.IOpenApiCallback"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiMediaType})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiMediaType)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiMediaType"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiEncoding})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.OpenApiEncoding"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiEncoding)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiEncoding"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiSchema,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiSchema"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiExample})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.IOpenApiExample"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiExample,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiExample"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.List{Microsoft.OpenApi.IOpenApiExample})">
|
|
<summary>
|
|
Visits the list of <see cref="T:Microsoft.OpenApi.IOpenApiExample"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.IOpenApiSchema})">
|
|
<summary>
|
|
Visits a list of <see cref="T:Microsoft.OpenApi.IOpenApiSchema"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiOAuthFlows)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlows"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiLink})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.IOpenApiLink"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiLink,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiLink"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiHeader,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiHeader"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.OpenApiSecurityRequirement)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiSecurityRequirement"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiSecurityScheme,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.IOpenApiSecurityScheme"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiReferenceHolder)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.OpenApiSecurityScheme"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(Microsoft.OpenApi.IOpenApiElement)">
|
|
<summary>
|
|
Dispatcher method that enables using a single method to walk the model
|
|
starting from any <see cref="T:Microsoft.OpenApi.IOpenApiElement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.Walk(System.String,System.Action)">
|
|
<summary>
|
|
Adds a segment to the context path to enable pointing to the current location in the document
|
|
</summary>
|
|
<param name="context">An identifier for the context.</param>
|
|
<param name="walk">An action that walks objects within the context.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWalker.ProcessAsReference(Microsoft.OpenApi.IOpenApiReferenceHolder,System.Boolean)">
|
|
<summary>
|
|
Identify if an element is just a reference to a component, or an actual component
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.CurrentKeys">
|
|
<summary>
|
|
Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Path">
|
|
<summary>
|
|
Current Path key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Operation">
|
|
<summary>
|
|
Current Operation Type
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Response">
|
|
<summary>
|
|
Current Response Status Code
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Content">
|
|
<summary>
|
|
Current Content Media Type
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Callback">
|
|
<summary>
|
|
Current Callback Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Link">
|
|
<summary>
|
|
Current Link Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Header">
|
|
<summary>
|
|
Current Header Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Encoding">
|
|
<summary>
|
|
Current Encoding Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Example">
|
|
<summary>
|
|
Current Example Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.Extension">
|
|
<summary>
|
|
Current Extension Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.CurrentKeys.ServerVariable">
|
|
<summary>
|
|
Current ServerVariable
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWorkspace">
|
|
<summary>
|
|
Contains a set of OpenApi documents and document fragments that reference each other
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiWorkspace.BaseUrl">
|
|
<summary>
|
|
The base location from where all relative references are resolved
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.#ctor(System.Uri)">
|
|
<summary>
|
|
Initialize workspace pointing to a base URL to allow resolving relative document locations. Use a file:// url to point to a folder
|
|
</summary>
|
|
<param name="baseUrl"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.#ctor">
|
|
<summary>
|
|
Initialize workspace using current directory as the default location.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.#ctor(Microsoft.OpenApi.OpenApiWorkspace)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.OpenApiWorkspace"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.ComponentsCount">
|
|
<summary>
|
|
Returns the total count of all the components in the workspace registry
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.RegisterComponents(Microsoft.OpenApi.OpenApiDocument)">
|
|
<summary>
|
|
Registers a document's components into the workspace
|
|
</summary>
|
|
<param name="document"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.RegisterComponentForDocument``1(Microsoft.OpenApi.OpenApiDocument,``0,System.String)">
|
|
<summary>
|
|
Registers a component for a document in the workspace
|
|
</summary>
|
|
<param name="openApiDocument">The document to register the component for.</param>
|
|
<param name="componentToRegister">The component to register.</param>
|
|
<param name="id">The id of the component.</param>
|
|
<typeparam name="T">The type of the component to register.</typeparam>
|
|
<returns>true if the component is successfully registered; otherwise false.</returns>
|
|
<exception cref="T:System.ArgumentNullException">openApiDocument is null</exception>
|
|
<exception cref="T:System.ArgumentNullException">componentToRegister is null</exception>
|
|
<exception cref="T:System.ArgumentNullException">id is null or empty</exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.RegisterComponent``1(System.String,``0)">
|
|
<summary>
|
|
Registers a component in the component registry.
|
|
</summary>
|
|
<param name="location"></param>
|
|
<param name="component"></param>
|
|
<returns>true if the component is successfully registered; otherwise false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.AddDocumentId(System.String,System.Uri)">
|
|
<summary>
|
|
Adds a document id to the dictionaries of document locations and their ids.
|
|
</summary>
|
|
<param name="key"></param>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.GetDocumentId(System.String)">
|
|
<summary>
|
|
Retrieves the document id given a key.
|
|
</summary>
|
|
<param name="key"></param>
|
|
<returns>The document id of the given key.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.Contains(System.String)">
|
|
<summary>
|
|
Verify if workspace contains a component based on its URL.
|
|
</summary>
|
|
<param name="location">A relative or absolute URL of the file. Use file:// for folder locations.</param>
|
|
<returns>Returns true if a matching document is found.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.ResolveReference``1(System.String)">
|
|
<summary>
|
|
Resolves a reference given a key.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
<param name="location"></param>
|
|
<returns>The resolved reference.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWorkspace.ResolveJsonSchemaReference(System.String,Microsoft.OpenApi.IOpenApiSchema)">
|
|
<summary>
|
|
Recursively resolves a schema from a URI fragment.
|
|
</summary>
|
|
<param name="location"></param>
|
|
<param name="parentSchema">The parent schema to resolve against.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OperationSearch">
|
|
<summary>
|
|
Visits OpenApi operations and parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OperationSearch.SearchResults">
|
|
<summary>
|
|
A list of operations from the operation search.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OperationSearch.#ctor(System.Func{System.String,System.Net.Http.HttpMethod,Microsoft.OpenApi.OpenApiOperation,System.Boolean})">
|
|
<summary>
|
|
The OperationSearch constructor.
|
|
</summary>
|
|
<param name="predicate">A predicate function.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OperationSearch.Visit(Microsoft.OpenApi.IOpenApiPathItem)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OperationSearch.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.IOpenApiParameter})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.OpenApiParameter"/>.
|
|
</summary>
|
|
<param name="parameters">The target list of <see cref="T:Microsoft.OpenApi.OpenApiParameter"/>.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ReferenceHostDocumentSetter">
|
|
<summary>
|
|
This class is used to walk an OpenApiDocument and sets the host document of IOpenApiReferenceable objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ReferenceHostDocumentSetter.Visit(Microsoft.OpenApi.IOpenApiReferenceHolder)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.SearchResult">
|
|
<summary>
|
|
Defines a search result model for visited operations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SearchResult.CurrentKeys">
|
|
<summary>
|
|
An object containing contextual information based on where the walker is currently referencing in an OpenApiDocument.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SearchResult.Operation">
|
|
<summary>
|
|
An Operation object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.SearchResult.Parameters">
|
|
<summary>
|
|
Parameters object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Utils">
|
|
<summary>
|
|
Utilities methods
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Utils.CheckArgumentNull``1(``0,System.String)">
|
|
<summary>
|
|
Check whether the input argument value is null or not.
|
|
</summary>
|
|
<typeparam name="T">The input value type.</typeparam>
|
|
<param name="value">The input value.</param>
|
|
<param name="parameterName">The input parameter name.</param>
|
|
<returns>The input value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Utils.CheckArgumentNullOrEmpty(System.String,System.String)">
|
|
<summary>
|
|
Check whether the input string value is null or empty.
|
|
</summary>
|
|
<param name="value">The input string value.</param>
|
|
<param name="parameterName">The input parameter name.</param>
|
|
<returns>The input value.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IValidationContext">
|
|
<summary>
|
|
Constrained interface used to provide context to rule implementation
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IValidationContext.AddError(Microsoft.OpenApi.OpenApiValidatorError)">
|
|
<summary>
|
|
Register an error with the validation context.
|
|
</summary>
|
|
<param name="error">Error to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IValidationContext.AddWarning(Microsoft.OpenApi.OpenApiValidatorWarning)">
|
|
<summary>
|
|
Register a warning with the validation context.
|
|
</summary>
|
|
<param name="warning">Warning to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IValidationContext.Enter(System.String)">
|
|
<summary>
|
|
Allow Rule to indicate validation error occured at a deeper context level.
|
|
</summary>
|
|
<param name="segment">Identifier for context</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IValidationContext.Exit">
|
|
<summary>
|
|
Exit from path context level. Enter and Exit calls should be matched.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.IValidationContext.PathString">
|
|
<summary>
|
|
Pointer to source of validation error in document
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiValidatorWarning">
|
|
<summary>
|
|
Warnings detected when validating an OpenAPI Element
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidatorWarning.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiError"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiValidatorWarning.RuleName">
|
|
<summary>
|
|
Name of rule that detected the error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiValidator">
|
|
<summary>
|
|
Class containing dispatchers to execute validation rules on for Open API document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.#ctor(Microsoft.OpenApi.ValidationRuleSet)">
|
|
<summary>
|
|
Create a visitor that will validate an OpenAPIDocument
|
|
</summary>
|
|
<param name="ruleSet"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiValidator.Errors">
|
|
<summary>
|
|
Gets the validation errors.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiValidator.Warnings">
|
|
<summary>
|
|
Gets the validation warnings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.AddError(Microsoft.OpenApi.OpenApiValidatorError)">
|
|
<summary>
|
|
Register an error with the validation context.
|
|
</summary>
|
|
<param name="error">Error to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.AddWarning(Microsoft.OpenApi.OpenApiValidatorWarning)">
|
|
<summary>
|
|
Register an error with the validation context.
|
|
</summary>
|
|
<param name="warning">Error to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiDocument)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiInfo)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiContact)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiComponents)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiHeader)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiResponse)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiMediaType)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiResponses)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiExternalDocs)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiLicense)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiOAuthFlow)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiTag)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiParameter)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiSchema)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiServer)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiEncoding)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiCallback)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiExtensible)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiExtension)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.List{Microsoft.OpenApi.IOpenApiExample})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiPathItem)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiServerVariable)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiSecurityScheme)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiSecurityRequirement)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiRequestBody)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiPaths)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiLink)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.IOpenApiExample)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(Microsoft.OpenApi.OpenApiOperation)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.Net.Http.HttpMethod,Microsoft.OpenApi.OpenApiOperation})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiHeader})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiCallback})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiMediaType})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiExample})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiLink})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiServerVariable})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.OpenApiEncoding})">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidator.Validate(System.Object,System.Type)">
|
|
<summary>
|
|
This overload allows applying rules based on actual object type, rather than matched interface. This is
|
|
needed for validating extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiValidatorError">
|
|
<summary>
|
|
Errors detected when validating an OpenAPI Element
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiValidatorError.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.OpenApiError"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiValidatorError.RuleName">
|
|
<summary>
|
|
Name of rule that detected the error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiComponentsRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiComponents"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiComponentsRules.KeyRegex">
|
|
<summary>
|
|
The key regex.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiComponentsRules.KeyMustBeRegularExpression">
|
|
<summary>
|
|
All the fixed fields declared above are objects
|
|
that MUST use keys that match the regular expression: ^[a-zA-Z0-9\.\-_]+$.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiContactRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiContact"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiContactRules.EmailMustBeEmailFormat">
|
|
<summary>
|
|
Email field MUST be email address.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiDocumentRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiDocument"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiDocumentRules.OpenApiDocumentFieldIsMissing">
|
|
<summary>
|
|
The Info field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExtensibleRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.IOpenApiExtensible"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExtensibleRules.ExtensionNameMustStartWithXDash">
|
|
<summary>
|
|
Extension name MUST start with "x-".
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiExternalDocsRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiExternalDocs"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiExternalDocsRules.UrlIsRequired">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiInfoRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiInfo"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiInfoRules.InfoRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiLicenseRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiLicense"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiLicenseRules.LicenseRequiredFields">
|
|
<summary>
|
|
REQUIRED.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiNonDefaultRules">
|
|
<summary>
|
|
Defines a non-default set of rules for validating examples in header, media type and parameter objects against the schema
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiNonDefaultRules.HeaderMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiNonDefaultRules.MediaTypeMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiNonDefaultRules.ParameterMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiNonDefaultRules.SchemaMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiOAuthFlowRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiOAuthFlow"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiOAuthFlowRules.OAuthFlowRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiParameterRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiParameter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterRules.ParameterRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterRules.RequiredMustBeTrueWhenInIsPath">
|
|
<summary>
|
|
Validate the "required" field is true when "in" is path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiParameterRules.PathParameterShouldBeInThePath">
|
|
<summary>
|
|
Validate that a path parameter should always appear in the path
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiPathsRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiPaths"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathsRules.PathNameMustBeginWithSlash">
|
|
<summary>
|
|
A relative path to an individual endpoint. The field name MUST begin with a slash.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiPathsRules.PathMustBeUnique">
|
|
<summary>
|
|
A relative path to an individual endpoint. The field name MUST begin with a slash.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiPathsRules.GetPathSignature(System.String)">
|
|
<summary>
|
|
Replaces placeholders in the path with {}, e.g. /pets/{petId} becomes /pets/{} .
|
|
</summary>
|
|
<param name="path">The input path</param>
|
|
<returns>The path signature</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiResponseRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiResponse"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponseRules.ResponseRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiResponsesRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiResponses"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiResponsesRules.StatusCodeRegex">
|
|
<summary>
|
|
The response key regex pattern for status codes and ranges.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponsesRules.ResponsesMustContainAtLeastOneResponse">
|
|
<summary>
|
|
An OpenAPI operation must contain at least one response
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiResponsesRules.ResponsesMustBeIdentifiedByDefaultOrStatusCode">
|
|
<summary>
|
|
The response key must either be "default" or an HTTP status code (1xx, 2xx, 3xx, 4xx, 5xx).
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiRuleAttribute">
|
|
<summary>
|
|
The Validator attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiSchemaRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiSchema"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiSchemaRules.ValidateSchemaDiscriminator">
|
|
<summary>
|
|
Validates Schema Discriminator
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaRules.ValidateChildSchemaAgainstDiscriminator(Microsoft.OpenApi.IOpenApiSchema,System.String)">
|
|
<summary>
|
|
Validates the property name in the discriminator against the ones present in the children schema
|
|
</summary>
|
|
<param name="schema">The parent schema.</param>
|
|
<param name="discriminatorName">Adds support for polymorphism. The discriminator is an object name that is used to differentiate
|
|
between other schemas which may satisfy the payload description.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiSchemaRules.TraverseSchemaElements(System.String,System.Collections.Generic.IList{Microsoft.OpenApi.IOpenApiSchema})">
|
|
<summary>
|
|
Traverses the schema elements and checks whether the schema contains the discriminator.
|
|
</summary>
|
|
<param name="discriminatorName">Adds support for polymorphism. The discriminator is an object name that is used to differentiate
|
|
between other schemas which may satisfy the payload description.</param>
|
|
<param name="childSchema">The child schema.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiServerRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiServer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiServerRules.ServerRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiServerRules.ValidateServerVariableRequiredFields(Microsoft.OpenApi.IValidationContext,System.String,Microsoft.OpenApi.OpenApiServerVariable)">
|
|
<summary>
|
|
Validate required fields in server variable
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiTagRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.OpenApiTag"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiTagRules.TagRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.RuleHelpers.IsEmailAddress(System.String)">
|
|
<summary>
|
|
Input string must be in the format of an email address
|
|
</summary>
|
|
<param name="input">The input string.</param>
|
|
<returns>True if it's an email address. Otherwise False.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ValidationContextExtensions">
|
|
<summary>
|
|
Helper methods to simplify creating validation rules
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationContextExtensions.CreateError(Microsoft.OpenApi.IValidationContext,System.String,System.String)">
|
|
<summary>
|
|
Helper method to simplify validation rules
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationContextExtensions.CreateWarning(Microsoft.OpenApi.IValidationContext,System.String,System.String)">
|
|
<summary>
|
|
Helper method to simplify validation rules
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ValidationRule">
|
|
<summary>
|
|
Class containing validation rule logic.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.ValidationRule.ElementType">
|
|
<summary>
|
|
Element Type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.ValidationRule.Name">
|
|
<summary>
|
|
Validation rule Name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRule.Evaluate(Microsoft.OpenApi.IValidationContext,System.Object)">
|
|
<summary>
|
|
Validate the object.
|
|
</summary>
|
|
<param name="context">The context.</param>
|
|
<param name="item">The object item.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ValidationRule`1">
|
|
<summary>
|
|
Class containing validation rule logic for <see cref="T:Microsoft.OpenApi.IOpenApiElement"/>.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRule`1.#ctor(System.String,System.Action{Microsoft.OpenApi.IValidationContext,`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.ValidationRule"/> class.
|
|
</summary>
|
|
<param name="name">Validation rule name.</param>
|
|
<param name="validate">Action to perform the validation.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ValidationRuleSet">
|
|
<summary>
|
|
The rule set of the validation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.ValidationRuleSet.Rules">
|
|
<summary>
|
|
Gets the rules in this rule set.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.ValidationRuleSet.Count">
|
|
<summary>
|
|
Gets the number of elements contained in this rule set.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.ValidationRuleSet"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.FindRules(System.Type)">
|
|
<summary>
|
|
Retrieve the rules that are related to a specific type
|
|
</summary>
|
|
<param name="type">The type that is to be validated</param>
|
|
<returns>Either the rules related to the type, or an empty list.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.GetDefaultRuleSet">
|
|
<summary>
|
|
Gets the default validation rule sets.
|
|
</summary>
|
|
<remarks>
|
|
This is a method instead of a property to signal that a new default rule-set object is created
|
|
per call. Making this a property may be misleading callers to think the returned rule-sets from multiple calls
|
|
are the same objects.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.GetEmptyRuleSet">
|
|
<summary>
|
|
Return <see cref="T:Microsoft.OpenApi.ValidationRuleSet"/> with no rules
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.AddValidationRules(Microsoft.OpenApi.ValidationRuleSet,System.Collections.Generic.Dictionary{System.Type,System.Collections.Generic.List{Microsoft.OpenApi.ValidationRule}})">
|
|
<summary>
|
|
Add validation rules to the rule set.
|
|
</summary>
|
|
<param name="ruleSet">The rule set to add validation rules to.</param>
|
|
<param name="rules">The validation rules to be added to the rules set.</param>
|
|
<exception cref="T:Microsoft.OpenApi.OpenApiException">Throws a null argument exception if the arguments are null.</exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.#ctor(Microsoft.OpenApi.ValidationRuleSet)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.ValidationRuleSet"/> class.
|
|
</summary>
|
|
<param name="ruleSet">Rule set to be copied from.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.#ctor(System.Collections.Generic.Dictionary{System.Type,System.Collections.Generic.List{Microsoft.OpenApi.ValidationRule}})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.ValidationRuleSet"/> class.
|
|
</summary>
|
|
<param name="rules">Rules to be contained in this ruleset.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Add(System.Type,System.Collections.Generic.List{Microsoft.OpenApi.ValidationRule})">
|
|
<summary>
|
|
Add the new rule into the rule set.
|
|
</summary>
|
|
<param name="key">The key for the rule.</param>
|
|
<param name="rules">The list of rules.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Add(System.Type,Microsoft.OpenApi.ValidationRule)">
|
|
<summary>
|
|
Add a new rule into the rule set.
|
|
</summary>
|
|
<param name="key">The key for the rule.</param>
|
|
<param name="rule">The rule.</param>
|
|
<exception cref="T:Microsoft.OpenApi.OpenApiException">Exception thrown when rule already exists.</exception>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Update(System.Type,Microsoft.OpenApi.ValidationRule,Microsoft.OpenApi.ValidationRule)">
|
|
<summary>
|
|
Updates an existing rule with a new one.
|
|
</summary>
|
|
<param name="key">The key of the existing rule.</param>
|
|
<param name="newRule">The new rule.</param>
|
|
<param name="oldRule">The old rule.</param>
|
|
<returns>true, if the update was successful; otherwise false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Remove(System.Type)">
|
|
<summary>
|
|
Removes a collection of rules.
|
|
</summary>
|
|
<param name="key">The key of the collection of rules to be removed.</param>
|
|
<returns>true if the collection of rules with the provided key is removed; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Remove(System.String)">
|
|
<summary>
|
|
Remove a rule by its name from all types it is used by.
|
|
</summary>
|
|
<param name="ruleName">Name of the rule.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Remove(System.Type,Microsoft.OpenApi.ValidationRule)">
|
|
<summary>
|
|
Removes a rule by key.
|
|
</summary>
|
|
<param name="key">The key of the rule to be removed.</param>
|
|
<param name="rule">The rule to be removed.</param>
|
|
<returns>true if the rule is successfully removed; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Remove(Microsoft.OpenApi.ValidationRule)">
|
|
<summary>
|
|
Removes the first rule that matches the provided rule from the list of rules.
|
|
</summary>
|
|
<param name="rule">The rule to be removed.</param>
|
|
<returns>true if the rule is successfully removed; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Clear">
|
|
<summary>
|
|
Clears all rules in this rule set.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.ContainsKey(System.Type)">
|
|
<summary>
|
|
Determines whether the rule set contains an element with the specified key.
|
|
</summary>
|
|
<param name="key">The key to locate in the rule set.</param>
|
|
<returns>true if the rule set contains an element with the key; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.Contains(System.Type,Microsoft.OpenApi.ValidationRule)">
|
|
<summary>
|
|
Determines whether the provided rule is contained in the specified key in the rule set.
|
|
</summary>
|
|
<param name="key">The key to locate.</param>
|
|
<param name="rule">The rule to locate.</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.TryGetValue(System.Type,System.Collections.Generic.List{Microsoft.OpenApi.ValidationRule}@)">
|
|
<summary>
|
|
Gets the rules associated with the specified key.
|
|
</summary>
|
|
<param name="key">The key whose rules to get.</param>
|
|
<param name="rules">When this method returns, the rules associated with the specified key, if the
|
|
key is found; otherwise, an empty <see cref="T:System.Collections.Generic.IList`1"/> object.
|
|
This parameter is passed uninitialized.</param>
|
|
<returns>true if the specified key has rules.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.ValidationRuleSet.GetEnumerator">
|
|
<summary>
|
|
Get the enumerator.
|
|
</summary>
|
|
<returns>The enumerator.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.FormattingStreamWriter">
|
|
<summary>
|
|
A custom <see cref="T:System.IO.StreamWriter"/> which supports setting a <see cref="T:System.IFormatProvider"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.FormattingStreamWriter.#ctor(System.IO.Stream,System.IFormatProvider)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.FormattingStreamWriter"/> class.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="formatProvider"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.FormattingStreamWriter.FormatProvider">
|
|
<summary>
|
|
The <see cref="T:System.IFormatProvider"/> associated with this <see cref="T:Microsoft.OpenApi.FormattingStreamWriter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.IOpenApiWriter">
|
|
<summary>
|
|
Interface for writing Open API documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteStartObject">
|
|
<summary>
|
|
Write the start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteEndObject">
|
|
<summary>
|
|
Write the end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteStartArray">
|
|
<summary>
|
|
Write the start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteEndArray">
|
|
<summary>
|
|
Write the end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write the property name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteValue(System.String)">
|
|
<summary>
|
|
Write the string value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteValue(System.Decimal)">
|
|
<summary>
|
|
Write the decimal value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteValue(System.Int32)">
|
|
<summary>
|
|
Write the int value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteValue(System.Boolean)">
|
|
<summary>
|
|
Write the boolean value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteNull">
|
|
<summary>
|
|
Write the null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteRaw(System.String)">
|
|
<summary>
|
|
Write the raw content value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.WriteValue(System.Object)">
|
|
<summary>
|
|
Write the object value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.IOpenApiWriter.FlushAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Flush the writer.
|
|
</summary>
|
|
<param name="cancellationToken">The cancellation token.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiJsonWriter">
|
|
<summary>
|
|
JSON Writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.#ctor(System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiJsonWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.OpenApiJsonWriterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiJsonWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
<param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.OpenApiWriterSettings,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiJsonWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
<param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
|
|
<param name="terseOutput"> Setting for allowing the JSON emitted to be in terse format.</param>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiJsonWriter._produceTerseOutput">
|
|
<summary>
|
|
Indicates whether or not the produced document will be written in a compact or pretty fashion.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiJsonWriter.BaseIndentation">
|
|
<summary>
|
|
Base Indentation Level.
|
|
This denotes how many indentations are needed for the property in the base object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteStartObject">
|
|
<summary>
|
|
Write JSON start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteEndObject">
|
|
<summary>
|
|
Write JSON end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteStartArray">
|
|
<summary>
|
|
Write JSON start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteEndArray">
|
|
<summary>
|
|
Write JSON end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write property name.
|
|
</summary>
|
|
<param name="name">The property name.</param>
|
|
public override void WritePropertyName(string name)
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteValue(System.String)">
|
|
<summary>
|
|
Write string value.
|
|
</summary>
|
|
<param name="value">The string value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteNull">
|
|
<summary>
|
|
Write null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteValueSeparator">
|
|
<summary>
|
|
Writes a separator of a value if it's needed for the next value to be written.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteRaw(System.String)">
|
|
<summary>
|
|
Writes the content raw value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteIndentation">
|
|
<summary>
|
|
Write the indentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriter.WriteLine">
|
|
<summary>
|
|
Writes a line terminator to the text string or stream.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiJsonWriterSettings">
|
|
<summary>
|
|
Configuration settings to control how OpenAPI Json documents are written
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiJsonWriterSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiJsonWriterSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiJsonWriterSettings.Terse">
|
|
<summary>
|
|
Indicates whether or not the produced document will be written in a compact or pretty fashion.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWriterAnyExtensions">
|
|
<summary>
|
|
Extensions methods for writing the <see cref="T:Microsoft.OpenApi.JsonNodeExtension"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterAnyExtensions.WriteExtensions(Microsoft.OpenApi.IOpenApiWriter,System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.IOpenApiExtension},Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Write the specification extensions
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="extensions">The specification extensions.</param>
|
|
<param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterAnyExtensions.WriteAny(Microsoft.OpenApi.IOpenApiWriter,System.Text.Json.Nodes.JsonNode)">
|
|
<summary>
|
|
Write the <see cref="T:System.Text.Json.Nodes.JsonNode"/> value.
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="node">The JsonNode value</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWriterBase">
|
|
<summary>
|
|
Base class for Open API writer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiWriterBase.Settings">
|
|
<summary>
|
|
Settings for controlling how the OpenAPI document will be written out.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiWriterBase.IndentationString">
|
|
<summary>
|
|
The indentation string to prepend to each line for each indentation level.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiWriterBase.Scopes">
|
|
<summary>
|
|
Scope of the Open API element - object, array, property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiWriterBase._indentLevel">
|
|
<summary>
|
|
Number which specifies the level of indentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.#ctor(System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiWriterBase"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.#ctor(System.IO.TextWriter,Microsoft.OpenApi.OpenApiWriterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiWriterBase"/> class.
|
|
</summary>
|
|
<param name="textWriter"></param>
|
|
<param name="settings"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiWriterBase.BaseIndentation">
|
|
<summary>
|
|
Base Indentation Level.
|
|
This denotes how many indentations are needed for the property in the base object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiWriterBase.Writer">
|
|
<summary>
|
|
The text writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteStartObject">
|
|
<summary>
|
|
Write start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteEndObject">
|
|
<summary>
|
|
Write end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteStartArray">
|
|
<summary>
|
|
Write start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteEndArray">
|
|
<summary>
|
|
Write end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write the start property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValueSeparator">
|
|
<summary>
|
|
Writes a separator of a value if it's needed for the next value to be written.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteNull">
|
|
<summary>
|
|
Write null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteRaw(System.String)">
|
|
<summary>
|
|
Write content raw value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.FlushAsync(System.Threading.CancellationToken)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.String)">
|
|
<summary>
|
|
Write string value.
|
|
</summary>
|
|
<param name="value">The string value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Single)">
|
|
<summary>
|
|
Write float value.
|
|
</summary>
|
|
<param name="value">The float value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Double)">
|
|
<summary>
|
|
Write double value.
|
|
</summary>
|
|
<param name="value">The double value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Decimal)">
|
|
<summary>
|
|
Write decimal value.
|
|
</summary>
|
|
<param name="value">The decimal value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Int32)">
|
|
<summary>
|
|
Write integer value.
|
|
</summary>
|
|
<param name="value">The integer value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Int64)">
|
|
<summary>
|
|
Write long value.
|
|
</summary>
|
|
<param name="value">The long value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.DateTime)">
|
|
<summary>
|
|
Write DateTime value.
|
|
</summary>
|
|
<param name="value">The DateTime value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.DateTimeOffset)">
|
|
<summary>
|
|
Write DateTimeOffset value.
|
|
</summary>
|
|
<param name="value">The DateTimeOffset value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Boolean)">
|
|
<summary>
|
|
Write boolean value.
|
|
</summary>
|
|
<param name="value">The boolean value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteEnumerable``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>
|
|
Writes an enumerable collection as an array
|
|
</summary>
|
|
<param name="collection">The enumerable collection to write.</param>
|
|
<typeparam name="T">The type of elements in the collection.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteValue(System.Object)">
|
|
<summary>
|
|
Write object value.
|
|
</summary>
|
|
<param name="value">The object value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.IncreaseIndentation">
|
|
<summary>
|
|
Increases the level of indentation applied to the output.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.DecreaseIndentation">
|
|
<summary>
|
|
Decreases the level of indentation applied to the output.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteIndentation">
|
|
<summary>
|
|
Write the indentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.CurrentScope">
|
|
<summary>
|
|
Get current scope.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.StartScope(Microsoft.OpenApi.ScopeType)">
|
|
<summary>
|
|
Start the scope given the scope type.
|
|
</summary>
|
|
<param name="type">The scope type to start.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.EndScope(Microsoft.OpenApi.ScopeType)">
|
|
<summary>
|
|
End the scope of the given scope type.
|
|
</summary>
|
|
<param name="type"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.IsTopLevelScope">
|
|
<summary>
|
|
Whether the current scope is the top level (outermost) scope.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.IsObjectScope">
|
|
<summary>
|
|
Whether the current scope is an object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.IsArrayScope">
|
|
<summary>
|
|
Whether the current scope is an array scope.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.VerifyCanWritePropertyName(System.String)">
|
|
<summary>
|
|
Verifies whether a property name can be written based on whether
|
|
the property name is a valid string and whether the current scope is an object scope.
|
|
</summary>
|
|
<param name="name">property name</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterBase.WriteV2Examples(Microsoft.OpenApi.IOpenApiWriter,Microsoft.OpenApi.OpenApiExample,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc/>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWriterExtensions">
|
|
<summary>
|
|
Extension methods for writing Open API documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.IOpenApiWriter,System.String,System.String)">
|
|
<summary>
|
|
Write a string property.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteRequiredProperty(Microsoft.OpenApi.IOpenApiWriter,System.String,System.String)">
|
|
<summary>
|
|
Write required string property.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Write a boolean property.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
<param name="defaultValue">The default boolean value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Nullable{System.Boolean},System.Boolean)">
|
|
<summary>
|
|
Write a boolean property.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
<param name="defaultValue">The default boolean value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Nullable{``0})">
|
|
<summary>
|
|
Write a primitive property.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.IOpenApiWriter,System.String,``0)">
|
|
<summary>
|
|
Write a string/number property.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalObject``1(Microsoft.OpenApi.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the optional Open API object/element.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
<param name="action">The property value writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteRequiredObject``1(Microsoft.OpenApi.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the required Open API object/element.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="value">The property value.</param>
|
|
<param name="action">The property value writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalCollection(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{System.String},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.String})">
|
|
<summary>
|
|
Write the optional of collection string.
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The collection values.</param>
|
|
<param name="action">The collection string writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalCollection``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the optional Open API object/element collection.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The collection values.</param>
|
|
<param name="action">The collection element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalOrEmptyCollection``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the optional or empty Open API object/element collection.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The collection values.</param>
|
|
<param name="action">The collection element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteRequiredCollection``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the required Open API object/element collection.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The collection values.</param>
|
|
<param name="action">The collection element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteRequiredMap(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.String})">
|
|
<summary>
|
|
Write the required Open API element map (string to string mapping).
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalMap(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.Text.Json.Nodes.JsonNode},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.Text.Json.Nodes.JsonNode})">
|
|
<summary>
|
|
Write the optional Open API element map (string to string mapping).
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalMap(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.String})">
|
|
<summary>
|
|
Write the optional Open API element map (string to string mapping).
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalMap(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.Boolean},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.Boolean})">
|
|
<summary>
|
|
Write the optional Open API element map (string to string mapping).
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalMap(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.HashSet{System.String}},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.Collections.Generic.HashSet{System.String}})">
|
|
<summary>
|
|
Write the optional Open API element map (string to array mapping).
|
|
</summary>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalMap``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the optional Open API element map.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action with writer and value as input.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteOptionalMap``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.IOpenApiWriter,System.String,``0})">
|
|
<summary>
|
|
Write the optional Open API element map.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action with writer, key, and value as input.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiWriterExtensions.WriteRequiredMap``1(Microsoft.OpenApi.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the required Open API element map.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.IOpenApiElement"/></typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="name">The property name.</param>
|
|
<param name="elements">The map values.</param>
|
|
<param name="action">The map element writer action.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiWriterSettings">
|
|
<summary>
|
|
Configuration settings to control how OpenAPI documents are written
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiWriterSettings.InlineLocalReferences">
|
|
<summary>
|
|
Indicates if local references should be rendered as an inline object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiWriterSettings.InlineExternalReferences">
|
|
<summary>
|
|
Indicates if external references should be rendered as an inline object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiYamlWriter">
|
|
<summary>
|
|
YAML writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.#ctor(System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiYamlWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.OpenApiWriterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.OpenApiYamlWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
<param name="settings"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiYamlWriter.UseLiteralStyle">
|
|
<summary>
|
|
Allow rendering of multi-line strings using YAML | syntax
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.OpenApiYamlWriter.BaseIndentation">
|
|
<summary>
|
|
Base Indentation Level.
|
|
This denotes how many indentations are needed for the property in the base object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteStartObject">
|
|
<summary>
|
|
Write YAML start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteEndObject">
|
|
<summary>
|
|
Write YAML end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteStartArray">
|
|
<summary>
|
|
Write YAML start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteEndArray">
|
|
<summary>
|
|
Write YAML end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write the property name and the delimiter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteValue(System.String)">
|
|
<summary>
|
|
Write string value.
|
|
</summary>
|
|
<param name="value">The string value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteNull">
|
|
<summary>
|
|
Write null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteValueSeparator">
|
|
<summary>
|
|
Write value separator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenApiYamlWriter.WriteRaw(System.String)">
|
|
<summary>
|
|
Writes the content raw value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.ScopeType">
|
|
<summary>
|
|
Various scope types for Open API writer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ScopeType.Object">
|
|
<summary>
|
|
Object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.ScopeType.Array">
|
|
<summary>
|
|
Array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Scope">
|
|
<summary>
|
|
Class representing scope information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Scope._type">
|
|
<summary>
|
|
The type of the scope.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Scope.#ctor(Microsoft.OpenApi.ScopeType)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="type">The type of the scope.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Scope.ObjectCount">
|
|
<summary>
|
|
Get/Set the object count for this scope.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Scope.Type">
|
|
<summary>
|
|
Gets the scope type for this scope.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Scope.IsInArray">
|
|
<summary>
|
|
Get/Set the whether it is in previous array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.SpecialCharacterStringExtensions">
|
|
<summary>
|
|
Extensions class for strings to handle special characters.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.SpecialCharacterStringExtensions.GetYamlCompatibleString(System.String)">
|
|
<summary>
|
|
Escapes all special characters and put the string in quotes if necessary to
|
|
get a YAML-compatible string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.SpecialCharacterStringExtensions.GetJsonCompatibleString(System.String)">
|
|
<summary>
|
|
Handles control characters and backslashes and adds double quotes
|
|
to get JSON-compatible string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.WriterConstants">
|
|
<summary>
|
|
Constants for the writer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.ODataDateTimeFormat">
|
|
<summary>
|
|
JSON datetime format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.ODataDateTimeOffsetFormat">
|
|
<summary>
|
|
JSON datetime offset format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.ODataDateTimeOffsetPlusSign">
|
|
<summary>
|
|
A plus sign for the date time offset format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.JsonTrueLiteral">
|
|
<summary>
|
|
The true value literal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.JsonFalseLiteral">
|
|
<summary>
|
|
The false value literal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.JsonNullLiteral">
|
|
<summary>
|
|
The null value literal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.StartObjectScope">
|
|
<summary>
|
|
Character which starts the object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.EndObjectScope">
|
|
<summary>
|
|
Character which ends the object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.StartArrayScope">
|
|
<summary>
|
|
Character which starts the array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.EndArrayScope">
|
|
<summary>
|
|
Character which ends the array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.StartPaddingFunctionScope">
|
|
<summary>
|
|
"(" Json Padding Function scope open parens.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.EndPaddingFunctionScope">
|
|
<summary>
|
|
")" Json Padding Function scope close parens.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.ObjectMemberSeparator">
|
|
<summary>
|
|
The separator between object members.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.ArrayElementSeparator">
|
|
<summary>
|
|
The separator between array elements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.NameValueSeparator">
|
|
<summary>
|
|
The separator between the name and the value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.NameValueSeparatorWhiteSpaceSuffix">
|
|
<summary>
|
|
The white space postfixing <see cref="F:Microsoft.OpenApi.WriterConstants.NameValueSeparator"/>
|
|
when producing pretty content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.WhiteSpaceForEmptyObject">
|
|
<summary>
|
|
The white space for empty object
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.WhiteSpaceForEmptyArray">
|
|
<summary>
|
|
The white space for empty array
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.PrefixOfArrayItem">
|
|
<summary>
|
|
The prefix of array item
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.WhiteSpaceForIndent">
|
|
<summary>
|
|
The white space for indent
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.EmptyObject">
|
|
<summary>
|
|
Empty object
|
|
</summary>
|
|
<remarks>To indicate empty object in YAML.</remarks>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.WriterConstants.EmptyArray">
|
|
<summary>
|
|
Empty array
|
|
</summary>
|
|
<remarks>To indicate empty array in YAML.</remarks>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
|
<summary>
|
|
Indicates that the specified method requires the ability to generate new code at runtime,
|
|
for example through <see cref="N:System.Reflection"/>.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
A message that contains information about the usage of dynamic code.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
|
<summary>
|
|
Gets a message that contains information about the usage of dynamic code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
|
<summary>
|
|
Gets or sets an optional URL that contains more information about the method,
|
|
why it requires dynamic code, and what options a consumer has to deal with it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
|
<summary>
|
|
Indicates that the specified method requires dynamic access to code that is not referenced
|
|
statically, for example through <see cref="N:System.Reflection"/>.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
|
code from an application.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
A message that contains information about the usage of unreferenced code.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
|
<summary>
|
|
Gets a message that contains information about the usage of unreferenced code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
|
<summary>
|
|
Gets or sets an optional URL that contains more information about the method,
|
|
why it requires unreferenced code, and what options a consumer has to deal with it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
|
<summary>
|
|
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
|
single code artifact.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
|
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
|
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
|
class, specifying the category of the tool and the identifier for an analysis rule.
|
|
</summary>
|
|
<param name="category">The category for the attribute.</param>
|
|
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
|
<summary>
|
|
Gets the category identifying the classification of the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
|
for which a message suppression attribute applies.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
|
<summary>
|
|
Gets the identifier of the analysis tool rule to be suppressed.
|
|
</summary>
|
|
<remarks>
|
|
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
|
properties form a unique check identifier.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
|
<summary>
|
|
Gets or sets the scope of the code that is relevant for the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The Scope property is an optional argument that specifies the metadata scope for which
|
|
the attribute is relevant.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
|
<summary>
|
|
Gets or sets a fully qualified path that represents the target of the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
|
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
|
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
|
The analysis tool user interface should be capable of automatically formatting the parameter.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
|
<summary>
|
|
Gets or sets an optional argument expanding on exclusion criteria.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
|
exclusion where the literal metadata target is not sufficiently precise. For example,
|
|
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
|
and it may be desirable to suppress a violation against a statement in the method that will
|
|
give a rule violation, but not against all statements in the method.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
|
<summary>
|
|
Gets or sets the justification for suppressing the code analysis message.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute">
|
|
<summary>
|
|
States a dependency that one member has on another.
|
|
</summary>
|
|
<remarks>
|
|
This can be used to inform tooling of a dependency that is otherwise not evident purely from
|
|
metadata and IL, for example a member relied on via reflection.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified signature of a member on the same type as the consumer.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified signature of a member on a <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
<param name="type">The <see cref="T:System.Type"/> containing <paramref name="memberSignature"/>.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified signature of a member on a type in an assembly.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
<param name="typeName">The full name of the type containing the specified member.</param>
|
|
<param name="assemblyName">The assembly name of the type containing the specified member.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified types of members on a <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="memberTypes">The types of members depended on.</param>
|
|
<param name="type">The <see cref="T:System.Type"/> containing the specified members.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified types of members on a type in an assembly.
|
|
</summary>
|
|
<param name="memberTypes">The types of members depended on.</param>
|
|
<param name="typeName">The full name of the type containing the specified members.</param>
|
|
<param name="assemblyName">The assembly name of the type containing the specified members.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature">
|
|
<summary>
|
|
Gets the signature of the member depended on.
|
|
</summary>
|
|
<remarks>
|
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
|
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes">
|
|
<summary>
|
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
|
of members depended on.
|
|
</summary>
|
|
<remarks>
|
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
|
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type">
|
|
<summary>
|
|
Gets the <see cref="T:System.Type"/> containing the specified member.
|
|
</summary>
|
|
<remarks>
|
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
|
|
the type of the consumer is assumed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName">
|
|
<summary>
|
|
Gets the full name of the type containing the specified member.
|
|
</summary>
|
|
<remarks>
|
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
|
|
the type of the consumer is assumed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName">
|
|
<summary>
|
|
Gets the assembly name of the specified type.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName"/> is only valid when <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> is specified.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition">
|
|
<summary>
|
|
Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
|
<summary>
|
|
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
|
for example through <see cref="N:System.Reflection"/>.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which members are being accessed during the execution
|
|
of a program.
|
|
|
|
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
|
|
|
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
|
that the string represents a fully qualified type name.
|
|
|
|
When this attribute is applied to a class, interface, or struct, the members specified
|
|
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
|
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
|
|
|
If the attribute is applied to a method it's treated as a special case and it implies
|
|
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
|
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
|
will use it there).
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
|
with the specified member types.
|
|
</summary>
|
|
<param name="memberTypes">The types of members dynamically accessed.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
|
<summary>
|
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
|
of members dynamically accessed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
|
<summary>
|
|
Specifies the types of members that are dynamically accessed.
|
|
|
|
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
|
bitwise combination of its member values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
|
<summary>
|
|
Specifies no members.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
|
<summary>
|
|
Specifies the default, parameterless public constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
|
<summary>
|
|
Specifies all public constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
|
<summary>
|
|
Specifies all non-public constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
|
<summary>
|
|
Specifies all public methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
|
<summary>
|
|
Specifies all non-public methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
|
<summary>
|
|
Specifies all public fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
|
<summary>
|
|
Specifies all non-public fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
|
<summary>
|
|
Specifies all public nested types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
|
<summary>
|
|
Specifies all non-public nested types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
|
<summary>
|
|
Specifies all public properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
|
<summary>
|
|
Specifies all non-public properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
|
<summary>
|
|
Specifies all public events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
|
<summary>
|
|
Specifies all non-public events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
|
<summary>
|
|
Specifies all interfaces implemented by the type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
|
<summary>
|
|
Specifies all members.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Runtime.CompilerServices.IsExternalInit">
|
|
<summary>
|
|
Reserved to be used by the compiler for tracking metadata.
|
|
This class should not be used by developers in source code.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|