7813 lines
380 KiB
XML
Executable File
7813 lines
380 KiB
XML
Executable File
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Microsoft.OpenApi</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Microsoft.OpenApi.Any.AnyType">
|
|
<summary>
|
|
Type of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.AnyType.Primitive">
|
|
<summary>
|
|
Primitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.AnyType.Null">
|
|
<summary>
|
|
Null.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.AnyType.Array">
|
|
<summary>
|
|
Array.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.AnyType.Object">
|
|
<summary>
|
|
Object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.IOpenApiAny">
|
|
<summary>
|
|
Base interface for all the types that represent Open API Any.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.IOpenApiAny.AnyType">
|
|
<summary>
|
|
Type of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.PrimitiveType">
|
|
<summary>
|
|
Primitive type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Integer">
|
|
<summary>
|
|
Integer
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Long">
|
|
<summary>
|
|
Long
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Float">
|
|
<summary>
|
|
Float
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Double">
|
|
<summary>
|
|
Double
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.String">
|
|
<summary>
|
|
String
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Byte">
|
|
<summary>
|
|
Byte
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Binary">
|
|
<summary>
|
|
Binary
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Boolean">
|
|
<summary>
|
|
Boolean
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Date">
|
|
<summary>
|
|
Date
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.DateTime">
|
|
<summary>
|
|
DateTime
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Any.PrimitiveType.Password">
|
|
<summary>
|
|
Password
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.IOpenApiPrimitive">
|
|
<summary>
|
|
Base interface for the Primitive type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.IOpenApiPrimitive.PrimitiveType">
|
|
<summary>
|
|
Primitive type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiAnyCloneHelper">
|
|
<summary>
|
|
Contains logic for cloning objects through copy constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiAnyCloneHelper.CloneFromCopyConstructor(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<summary>
|
|
Clones an instance of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> object from the copy constructor
|
|
</summary>
|
|
<param name="obj">The object instance.</param>
|
|
<returns>A clone copy or the object itself.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiAnyCloneHelper.CloneFromCopyConstructor``1(``0)">
|
|
<summary>
|
|
Clones an instance of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> object from the copy constructor
|
|
</summary>
|
|
<param name="obj">The object instance.</param>
|
|
<returns>A clone copy or the object itself.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiArray">
|
|
<summary>
|
|
Open API array.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiArray.AnyType">
|
|
<summary>
|
|
The type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiArray.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiArray.#ctor(Microsoft.OpenApi.Any.OpenApiArray)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Any.OpenApiArray"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiArray.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Write out contents of OpenApiArray to passed writer
|
|
</summary>
|
|
<param name="writer">Instance of JSON or YAML writer.</param>
|
|
<param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiBinary">
|
|
<summary>
|
|
Open API binary.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiBinary.#ctor(System.Byte[])">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiBinary"/> class.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiBinary.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiBoolean">
|
|
<summary>
|
|
Open API boolean.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiBoolean.#ctor(System.Boolean)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiBoolean"/> class.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiBoolean.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiByte">
|
|
<summary>
|
|
Open API Byte
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiByte.#ctor(System.Byte)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiByte"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiByte.#ctor(System.Byte[])">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiByte"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiByte.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiDate">
|
|
<summary>
|
|
Open API Date
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiDate.#ctor(System.DateTime)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDate"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiDate.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiDateTime">
|
|
<summary>
|
|
Open API Datetime
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiDateTime.#ctor(System.DateTimeOffset)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDateTime"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiDateTime.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiDouble">
|
|
<summary>
|
|
Open API Double
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiDouble.#ctor(System.Double)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDouble"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiDouble.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiFloat">
|
|
<summary>
|
|
Open API Float
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiFloat.#ctor(System.Single)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiFloat"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiFloat.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiInteger">
|
|
<summary>
|
|
Open API Integer
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiInteger.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiInteger"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiInteger.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiLong">
|
|
<summary>
|
|
Open API long.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiLong.#ctor(System.Int64)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiLong"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiLong.PrimitiveType">
|
|
<summary>
|
|
Primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiNull">
|
|
<summary>
|
|
Open API null.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiNull.AnyType">
|
|
<summary>
|
|
The type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiNull.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiNull.#ctor(Microsoft.OpenApi.Any.OpenApiNull)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Any.OpenApiNull"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiNull.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Write out null representation
|
|
</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.Any.OpenApiObject">
|
|
<summary>
|
|
Open API object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiObject.AnyType">
|
|
<summary>
|
|
Type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiObject.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiObject.#ctor(Microsoft.OpenApi.Any.OpenApiObject)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Any.OpenApiObject"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiObject.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serialize OpenApiObject to writer
|
|
</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.Any.OpenApiPassword">
|
|
<summary>
|
|
Open API password.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiPassword.#ctor(System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiPassword"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiPassword.PrimitiveType">
|
|
<summary>
|
|
The primitive type this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiPrimitive`1">
|
|
<summary>
|
|
Open API primitive class.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.#ctor(`0)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/> class with the given value.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.#ctor(Microsoft.OpenApi.Any.OpenApiPrimitive{`0})">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/> object
|
|
</summary>
|
|
<param name="openApiPrimitive"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.AnyType">
|
|
<summary>
|
|
The kind of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.PrimitiveType">
|
|
<summary>
|
|
The primitive class this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.Value">
|
|
<summary>
|
|
Value of this <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Write out content of primitive element
|
|
</summary>
|
|
<param name="writer"></param>
|
|
<param name="specVersion"></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Any.OpenApiString">
|
|
<summary>
|
|
Open API string type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
|
|
</summary>
|
|
<param name="value"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String,System.Boolean)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
|
|
</summary>
|
|
<param name="value"></param>
|
|
<param name="isExplicit">Used to indicate if a string is quoted.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String,System.Boolean,System.Boolean)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
|
|
</summary>
|
|
<param name="value"></param>
|
|
<param name="isExplicit">Used to indicate if a string is quoted.</param>
|
|
<param name="isRawString">Used to indicate to the writer that the value should be written without encoding.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Any.OpenApiString.PrimitiveType">
|
|
<summary>
|
|
The primitive class this object represents.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiString.IsExplicit">
|
|
<summary>
|
|
True if string was specified explicitly by the means of double quotes, single quotes, or literal or folded style.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Any.OpenApiString.IsRawString">
|
|
<summary>
|
|
True if the writer should process the value as supplied without encoding.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Attributes.DisplayAttribute">
|
|
<summary>
|
|
Represents the Open Api Data type metadata attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Attributes.DisplayAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Attributes.DisplayAttribute"/> class.
|
|
</summary>
|
|
<param name="name">The display name.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Attributes.DisplayAttribute.Name">
|
|
<summary>
|
|
The display Name.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Exceptions.OpenApiException">
|
|
<summary>
|
|
Exception type representing exceptions in the Open API library.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with default values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.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.Exceptions.OpenApiException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.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.Exceptions.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.Exceptions.OpenApiWriterException">
|
|
<summary>
|
|
Exception type representing exceptions in the OpenAPI writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with default values.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.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.Exceptions.OpenApiWriterException.#ctor(System.String,System.Exception)">
|
|
<summary>
|
|
Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.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.Expressions.BodyExpression">
|
|
<summary>
|
|
Body expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.BodyExpression.Body">
|
|
<summary>
|
|
body string
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.BodyExpression.PointerPrefix">
|
|
<summary>
|
|
Prefix for a pointer
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.BodyExpression.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.BodyExpression"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.BodyExpression.#ctor(Microsoft.OpenApi.JsonPointer)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.BodyExpression"/> class.
|
|
</summary>
|
|
<param name="pointer">a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901).</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.BodyExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.BodyExpression.Fragment">
|
|
<summary>
|
|
Gets the fragment string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.CompositeExpression">
|
|
<summary>
|
|
String literal with embedded expressions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.CompositeExpression.ContainedExpressions">
|
|
<summary>
|
|
Expressions embedded into string literal
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.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.Expressions.CompositeExpression.Expression">
|
|
<summary>
|
|
Return original string literal with embedded expression
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.HeaderExpression">
|
|
<summary>
|
|
Header expression, The token identifier in header is case-insensitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.HeaderExpression.Header">
|
|
<summary>
|
|
header. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.HeaderExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.HeaderExpression"/> class.
|
|
</summary>
|
|
<param name="token">The token string, it's case-insensitive.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.HeaderExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.HeaderExpression.Token">
|
|
<summary>
|
|
Gets the token string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.MethodExpression">
|
|
<summary>
|
|
Method expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.MethodExpression.Method">
|
|
<summary>
|
|
$method. string
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.MethodExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.MethodExpression.#ctor">
|
|
<summary>
|
|
Private constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.PathExpression">
|
|
<summary>
|
|
Path expression, the name in path is case-sensitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.PathExpression.Path">
|
|
<summary>
|
|
path. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.PathExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.PathExpression"/> class.
|
|
</summary>
|
|
<param name="name">The name string, it's case-insensitive.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.PathExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.PathExpression.Name">
|
|
<summary>
|
|
Gets the name string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.QueryExpression">
|
|
<summary>
|
|
Query expression, the name in query is case-sensitive.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.QueryExpression.Query">
|
|
<summary>
|
|
query. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.QueryExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.QueryExpression"/> class.
|
|
</summary>
|
|
<param name="name">The name string, it's case-insensitive.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.QueryExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.QueryExpression.Name">
|
|
<summary>
|
|
Gets the name string.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.RequestExpression">
|
|
<summary>
|
|
$request. expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.RequestExpression.Request">
|
|
<summary>
|
|
$request. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.RequestExpression.#ctor(Microsoft.OpenApi.Expressions.SourceExpression)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.RequestExpression"/> class.
|
|
</summary>
|
|
<param name="source">The source of the request.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.RequestExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.RequestExpression.Source">
|
|
<summary>
|
|
The <see cref="T:Microsoft.OpenApi.Expressions.SourceExpression"/> expression.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.ResponseExpression">
|
|
<summary>
|
|
$response. expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.ResponseExpression.Response">
|
|
<summary>
|
|
$response. string
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.ResponseExpression.#ctor(Microsoft.OpenApi.Expressions.SourceExpression)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.ResponseExpression"/> class.
|
|
</summary>
|
|
<param name="source">The source of the response.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.ResponseExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.ResponseExpression.Source">
|
|
<summary>
|
|
The <see cref="T:Microsoft.OpenApi.Expressions.SourceExpression"/> expression.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.RuntimeExpression">
|
|
<summary>
|
|
Base class for the Open API runtime expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.RuntimeExpression.Prefix">
|
|
<summary>
|
|
The dollar sign prefix for a runtime expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.RuntimeExpression.Expression">
|
|
<summary>
|
|
The expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.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.Expressions.RuntimeExpression.GetHashCode">
|
|
<summary>
|
|
GetHashCode implementation for IEquatable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Equals(System.Object)">
|
|
<summary>
|
|
Equals implementation for IEquatable.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Equals(Microsoft.OpenApi.Expressions.RuntimeExpression)">
|
|
<summary>
|
|
Equals implementation for object of the same type.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.ToString">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.SourceExpression">
|
|
<summary>
|
|
Source expression.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.SourceExpression.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.QueryExpression"/> class.
|
|
</summary>
|
|
<param name="value">The value string.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.SourceExpression.Value">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.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.Expressions.StatusCodeExpression">
|
|
<summary>
|
|
StatusCode expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.StatusCodeExpression.StatusCode">
|
|
<summary>
|
|
$statusCode string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.StatusCodeExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.StatusCodeExpression.#ctor">
|
|
<summary>
|
|
Private constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Expressions.UrlExpression">
|
|
<summary>
|
|
Url expression.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Expressions.UrlExpression.Url">
|
|
<summary>
|
|
$url string.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Expressions.UrlExpression.Expression">
|
|
<summary>
|
|
Gets the expression string.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Expressions.UrlExpression.#ctor">
|
|
<summary>
|
|
Private constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Extensions.EnumExtensions">
|
|
<summary>
|
|
Enumeration type extension methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.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.Extensions.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.Attributes.DisplayAttribute"/> if exists.
|
|
Otherwise, use the standard string representation.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Extensions.OpenApiElementExtensions">
|
|
<summary>
|
|
Extension methods that apply across all OpenAPIElements
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiElementExtensions.Validate(Microsoft.OpenApi.Interfaces.IOpenApiElement,Microsoft.OpenApi.Validations.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.Extensions.OpenApiExtensibleExtensions">
|
|
<summary>
|
|
Extension methods to verify validity and add an extension to Extensions property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiExtensibleExtensions.AddExtension``1(``0,System.String,Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
|
|
<summary>
|
|
Add extension into the Extensions
|
|
</summary>
|
|
<typeparam name="T"><see cref="T:Microsoft.OpenApi.Interfaces.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.Extensions.OpenApiReferencableExtensions">
|
|
<summary>
|
|
Extension methods for resolving references on <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable"/> elements.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiReferencableExtensions.ResolveReference(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable,Microsoft.OpenApi.JsonPointer)">
|
|
<summary>
|
|
Resolves a JSON Pointer with respect to an element, returning the referenced element.
|
|
</summary>
|
|
<param name="element">The referencable 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.Extensions.OpenApiSerializableExtensions">
|
|
<summary>
|
|
Extension methods for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> serialization.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsJson``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serialize the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document (JSON) using the given stream and specification version.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.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>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsYaml``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document (YAML) using the given stream and specification version.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.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>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.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.Interfaces.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>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.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.Interfaces.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>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to Open API document using the given specification version and writer.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.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>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsJson``1(``0,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in JSON format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsYaml``1(``0,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in YAML format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
|
|
<param name="element">The Open API element.</param>
|
|
<param name="specVersion">The Open API specification version.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat)">
|
|
<summary>
|
|
Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in the given format.
|
|
</summary>
|
|
<typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.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>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Extensions.OpenApiTypeMapper">
|
|
<summary>
|
|
Extension methods for <see cref="T:System.Type"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.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 integer int32 signed 32 bits
|
|
long integer 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.Extensions.OpenApiTypeMapper.MapOpenApiPrimitiveTypeToSimpleType(Microsoft.OpenApi.Models.OpenApiSchema)">
|
|
<summary>
|
|
Maps an OpenAPI 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="T:Microsoft.OpenApi.Extensions.StringExtensions">
|
|
<summary>
|
|
String extension methods.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Extensions.StringExtensions.GetEnumFromDisplayName``1(System.String)">
|
|
<summary>
|
|
Gets the enum value based on the given enum type and display name.
|
|
</summary>
|
|
<param name="displayName">The display name.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.OpenAPIWriterExtensions.GetSettings(Microsoft.OpenApi.Writers.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.Interfaces.IEffective`1">
|
|
<summary>
|
|
OpenApiElements that implement IEffective indicate that their description is not self-contained.
|
|
External elements affect the effective description.
|
|
</summary>
|
|
<remarks>Currently this will only be used for accessing external references.
|
|
In the next major version, this will be the approach accessing all referenced elements.
|
|
This will enable us to support merging properties that are peers of the $ref </remarks>
|
|
<typeparam name="T">Type of OpenApi Element that is being referenced.</typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Interfaces.IEffective`1.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns a calculated and cloned version of the element.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Interfaces.IOpenApiAnnotatable">
|
|
<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.Interfaces.IOpenApiAnnotatable.Annotations">
|
|
<summary>
|
|
A collection of properties associated with the current OpenAPI element.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Interfaces.IOpenApiElement">
|
|
<summary>
|
|
Represents an Open API element.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible">
|
|
<summary>
|
|
Represents an Extensible Open API element.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Interfaces.IOpenApiExtensible.Extensions">
|
|
<summary>
|
|
Specification extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension">
|
|
<summary>
|
|
Interface required for implementing any custom extension
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Interfaces.IOpenApiExtension.Write(Microsoft.OpenApi.Writers.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.Interfaces.IOpenApiReferenceable">
|
|
<summary>
|
|
Represents an Open API element is referenceable.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable">
|
|
<summary>
|
|
Represents an Open API element that comes with serialization functionality.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Interfaces.IOpenApiSerializable.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize Open API element to v3.0.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Interfaces.IOpenApiSerializable.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize Open API element to v2.0.
|
|
</summary>
|
|
<param name="writer">The writer.</param>
|
|
</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.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiDeprecationExtension.Parse(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<summary>
|
|
Parses the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> 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.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumFlagsExtension.Parse(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<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.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.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiEnumValuesDescriptionExtension.Parse(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<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(Microsoft.OpenApi.Any.OpenApiObject)">
|
|
<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.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.MicrosoftExtensions.OpenApiPagingExtension.Parse(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<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.Writers.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(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<summary>
|
|
Parses the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> 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.Writers.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(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<summary>
|
|
Parses the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> 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.Models.OpenApiCallback">
|
|
<summary>
|
|
Callback Object: A map of possible out-of band callbacks related to the parent operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiCallback.PathItems">
|
|
<summary>
|
|
A Path Item Object used to define a callback request and expected responses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiCallback.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiCallback.Reference">
|
|
<summary>
|
|
Reference pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiCallback.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.#ctor(Microsoft.OpenApi.Models.OpenApiCallback)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.AddPathItem(Microsoft.OpenApi.Expressions.RuntimeExpression,Microsoft.OpenApi.Models.OpenApiPathItem)">
|
|
<summary>
|
|
Add a <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> into the <see cref="P:Microsoft.OpenApi.Models.OpenApiCallback.PathItems"/>.
|
|
</summary>
|
|
<param name="expression">The runtime expression.</param>
|
|
<param name="pathItem">The path item.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiCallback object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiCallback</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiComponents">
|
|
<summary>
|
|
Components Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Schemas">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Responses">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Parameters">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Examples">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.RequestBodies">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Headers">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.SecuritySchemes">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Links">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Callbacks">
|
|
<summary>
|
|
An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> Objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiComponents.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiComponents.#ctor(Microsoft.OpenApi.Models.OpenApiComponents)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiComponents.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiComponents.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiConstants">
|
|
<summary>
|
|
Constants used in the Open API document.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OpenApi">
|
|
<summary>
|
|
Field: OpenApi
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Info">
|
|
<summary>
|
|
Field: Info
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Title">
|
|
<summary>
|
|
Field: Title
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Type">
|
|
<summary>
|
|
Field: Type
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Format">
|
|
<summary>
|
|
Field: Format
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Version">
|
|
<summary>
|
|
Field: Version
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Contact">
|
|
<summary>
|
|
Field: Contact
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.License">
|
|
<summary>
|
|
Field: License
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.TermsOfService">
|
|
<summary>
|
|
Field: TermsOfService
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Servers">
|
|
<summary>
|
|
Field: Servers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Server">
|
|
<summary>
|
|
Field: Server
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Paths">
|
|
<summary>
|
|
Field: Paths
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Components">
|
|
<summary>
|
|
Field: Components
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Security">
|
|
<summary>
|
|
Field: Security
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Tags">
|
|
<summary>
|
|
Field: Tags
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExternalDocs">
|
|
<summary>
|
|
Field: ExternalDocs
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OperationRef">
|
|
<summary>
|
|
Field: OperationRef
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OperationId">
|
|
<summary>
|
|
Field: OperationId
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Parameters">
|
|
<summary>
|
|
Field: Parameters
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RequestBody">
|
|
<summary>
|
|
Field: RequestBody
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExtensionFieldNamePrefix">
|
|
<summary>
|
|
Field: ExtensionFieldNamePrefix
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Name">
|
|
<summary>
|
|
Field: Name
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Namespace">
|
|
<summary>
|
|
Field: Namespace
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Prefix">
|
|
<summary>
|
|
Field: Prefix
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Attribute">
|
|
<summary>
|
|
Field: Attribute
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Wrapped">
|
|
<summary>
|
|
Field: Wrapped
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.In">
|
|
<summary>
|
|
Field: In
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Summary">
|
|
<summary>
|
|
Field: Summary
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Variables">
|
|
<summary>
|
|
Field: Variables
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Description">
|
|
<summary>
|
|
Field: Description
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Required">
|
|
<summary>
|
|
Field: Required
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Deprecated">
|
|
<summary>
|
|
Field: Deprecated
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Style">
|
|
<summary>
|
|
Field: Style
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Explode">
|
|
<summary>
|
|
Field: Explode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllowReserved">
|
|
<summary>
|
|
Field: AllowReserved
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schema">
|
|
<summary>
|
|
Field: Schema
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schemas">
|
|
<summary>
|
|
Field: Schemas
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Responses">
|
|
<summary>
|
|
Field: Responses
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Example">
|
|
<summary>
|
|
Field: Example
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Examples">
|
|
<summary>
|
|
Field: Examples
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Encoding">
|
|
<summary>
|
|
Field: Encoding
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RequestBodies">
|
|
<summary>
|
|
Field: RequestBodies
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllowEmptyValue">
|
|
<summary>
|
|
Field: AllowEmptyValue
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Value">
|
|
<summary>
|
|
Field: Value
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExternalValue">
|
|
<summary>
|
|
Field: ExternalValue
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DollarRef">
|
|
<summary>
|
|
Field: DollarRef
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Headers">
|
|
<summary>
|
|
Field: Headers
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.SecuritySchemes">
|
|
<summary>
|
|
Field: SecuritySchemes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Content">
|
|
<summary>
|
|
Field: Content
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Links">
|
|
<summary>
|
|
Field: Links
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Callbacks">
|
|
<summary>
|
|
Field: Callbacks
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Url">
|
|
<summary>
|
|
Field: Url
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Email">
|
|
<summary>
|
|
Field: Email
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Default">
|
|
<summary>
|
|
Field: Default
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Enum">
|
|
<summary>
|
|
Field: Enum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MultipleOf">
|
|
<summary>
|
|
Field: MultipleOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Maximum">
|
|
<summary>
|
|
Field: Maximum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExclusiveMaximum">
|
|
<summary>
|
|
Field: ExclusiveMaximum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Minimum">
|
|
<summary>
|
|
Field: Minimum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExclusiveMinimum">
|
|
<summary>
|
|
Field: ExclusiveMinimum
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxLength">
|
|
<summary>
|
|
Field: MaxLength
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinLength">
|
|
<summary>
|
|
Field: MinLength
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Pattern">
|
|
<summary>
|
|
Field: Pattern
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxItems">
|
|
<summary>
|
|
Field: MaxItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinItems">
|
|
<summary>
|
|
Field: MinItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.UniqueItems">
|
|
<summary>
|
|
Field: UniqueItems
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxProperties">
|
|
<summary>
|
|
Field: MaxProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinProperties">
|
|
<summary>
|
|
Field: MinProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllOf">
|
|
<summary>
|
|
Field: AllOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OneOf">
|
|
<summary>
|
|
Field: OneOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AnyOf">
|
|
<summary>
|
|
Field: AnyOf
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Not">
|
|
<summary>
|
|
Field: Not
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Items">
|
|
<summary>
|
|
Field: Items
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Properties">
|
|
<summary>
|
|
Field: Properties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AdditionalProperties">
|
|
<summary>
|
|
Field: AdditionalProperties
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Nullable">
|
|
<summary>
|
|
Field: Nullable
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Discriminator">
|
|
<summary>
|
|
Field: Discriminator
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ReadOnly">
|
|
<summary>
|
|
Field: ReadOnly
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.WriteOnly">
|
|
<summary>
|
|
Field: WriteOnly
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Xml">
|
|
<summary>
|
|
Field: Xml
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Flow">
|
|
<summary>
|
|
Field: Flow
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Application">
|
|
<summary>
|
|
Field: Application
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AccessCode">
|
|
<summary>
|
|
Field: AccessCode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Implicit">
|
|
<summary>
|
|
Field: Implicit
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Password">
|
|
<summary>
|
|
Field: Password
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ClientCredentials">
|
|
<summary>
|
|
Field: ClientCredentials
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AuthorizationCode">
|
|
<summary>
|
|
Field: AuthorizationCode
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AuthorizationUrl">
|
|
<summary>
|
|
Field: AuthorizationUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.TokenUrl">
|
|
<summary>
|
|
Field: TokenUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RefreshUrl">
|
|
<summary>
|
|
Field: RefreshUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Scopes">
|
|
<summary>
|
|
Field: Scopes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ContentType">
|
|
<summary>
|
|
Field: ContentType
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Get">
|
|
<summary>
|
|
Field: Get
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Put">
|
|
<summary>
|
|
Field: Put
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Post">
|
|
<summary>
|
|
Field: Post
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Delete">
|
|
<summary>
|
|
Field: Delete
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Options">
|
|
<summary>
|
|
Field: Options
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Head">
|
|
<summary>
|
|
Field: Head
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Patch">
|
|
<summary>
|
|
Field: Patch
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Trace">
|
|
<summary>
|
|
Field: Trace
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.PropertyName">
|
|
<summary>
|
|
Field: PropertyName
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Mapping">
|
|
<summary>
|
|
Field: Mapping
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Scheme">
|
|
<summary>
|
|
Field: Scheme
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BearerFormat">
|
|
<summary>
|
|
Field: BearerFormat
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Flows">
|
|
<summary>
|
|
Field: Flows
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OpenIdConnectUrl">
|
|
<summary>
|
|
Field: OpenIdConnectUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultName">
|
|
<summary>
|
|
Field: DefaultName
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultDefault">
|
|
<summary>
|
|
Field: DefaultDefault
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultTitle">
|
|
<summary>
|
|
Field: DefaultTitle
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultDescription">
|
|
<summary>
|
|
Field: DefaultDescription
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BodyName">
|
|
<summary>
|
|
Field: BodyName extensions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExamplesExtension">
|
|
<summary>
|
|
Field: Examples Extension
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.version3_0_0">
|
|
<summary>
|
|
Field: version3_0_0
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.defaultUrl">
|
|
<summary>
|
|
Field: defaultUrl
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Host">
|
|
<summary>
|
|
Field: Host
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Swagger">
|
|
<summary>
|
|
Field: Swagger
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.version2_0">
|
|
<summary>
|
|
Field: version2_0
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BasePath">
|
|
<summary>
|
|
Field: BasePath
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schemes">
|
|
<summary>
|
|
Field: Schemes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.SecurityDefinitions">
|
|
<summary>
|
|
Field: SecurityDefinitions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Definitions">
|
|
<summary>
|
|
Field: Definitions
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Basic">
|
|
<summary>
|
|
Field: Basic
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Bearer">
|
|
<summary>
|
|
Field: Bearer
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Jwt">
|
|
<summary>
|
|
Field: JWT
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Consumes">
|
|
<summary>
|
|
Field: Consumes
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Produces">
|
|
<summary>
|
|
Field: Produces
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiContact">
|
|
<summary>
|
|
Contact Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiContact.Name">
|
|
<summary>
|
|
The identifying name of the contact person/organization.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.OpenApiContact.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiContact.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiContact.#ctor(Microsoft.OpenApi.Models.OpenApiContact)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiContact.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiContact.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiDiscriminator">
|
|
<summary>
|
|
Discriminator object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiDiscriminator.Mapping">
|
|
<summary>
|
|
An object to hold mappings between payload values and schema names or references.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.#ctor(Microsoft.OpenApi.Models.OpenApiDiscriminator)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> instance
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiDocument">
|
|
<summary>
|
|
Describes an OpenAPI object (OpenAPI document). See: https://swagger.io/specification
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Workspace">
|
|
<summary>
|
|
Related workspace containing OpenApiDocuments that are referenced in this document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiDocument.Servers">
|
|
<summary>
|
|
An array of Server Objects, which provide connectivity information to a target server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Paths">
|
|
<summary>
|
|
REQUIRED. The available paths and operations for the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Components">
|
|
<summary>
|
|
An element to hold various schemas for the specification.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.SecurityRequirements">
|
|
<summary>
|
|
A declaration of which security mechanisms can be used across the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Tags">
|
|
<summary>
|
|
A list of tags used by the specification with additional metadata.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.HashCode">
|
|
<summary>
|
|
The unique hash code of the generated OpenAPI document
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Annotations">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.#ctor(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Initializes a copy of an an <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> to the latest patch of OpenAPI object V3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> to OpenAPI object V2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.ResolveReferences">
|
|
<summary>
|
|
Walk the OpenApiDocument and resolve unresolved references
|
|
</summary>
|
|
<remarks>
|
|
This method will be replaced by a LoadExternalReferences in the next major update to this library.
|
|
Resolving references at load time is going to go away.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.ResolveReferenceTo``1(Microsoft.OpenApi.Models.OpenApiReference)">
|
|
<summary>
|
|
Load the referenced <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.ResolveReference(Microsoft.OpenApi.Models.OpenApiReference)">
|
|
<summary>
|
|
Load the referenced <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.GenerateHashValue(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Takes in an OpenApi document instance and generates its hash value
|
|
</summary>
|
|
<param name="doc">The OpenAPI description to hash.</param>
|
|
<returns>The hash value.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiDocument.ResolveReference(Microsoft.OpenApi.Models.OpenApiReference,System.Boolean)">
|
|
<summary>
|
|
Load the referenced <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiEncoding">
|
|
<summary>
|
|
ExternalDocs object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiEncoding.Headers">
|
|
<summary>
|
|
A map allowing additional information to be provided as headers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Style">
|
|
<summary>
|
|
Describes how a specific property value will be serialized depending on its type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.OpenApiEncoding.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.#ctor(Microsoft.OpenApi.Models.OpenApiEncoding)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiError">
|
|
<summary>
|
|
Error related to the Open API Document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(Microsoft.OpenApi.Exceptions.OpenApiException)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class using the message and pointer from the given exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(Microsoft.OpenApi.Models.OpenApiError)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiError.Message">
|
|
<summary>
|
|
Message explaining the error.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiError.Pointer">
|
|
<summary>
|
|
Pointer to the location of the error.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiError.ToString">
|
|
<summary>
|
|
Gets the string representation of <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiExample">
|
|
<summary>
|
|
Example Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExample.Summary">
|
|
<summary>
|
|
Short description for the example.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExample.Description">
|
|
<summary>
|
|
Long description for the example.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExample.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.Models.OpenApiExample.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="P:Microsoft.OpenApi.Models.OpenApiExample.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExample.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExample.UnresolvedReference">
|
|
<summary>
|
|
Indicates object is a placeholder reference to an actual object and does not contain valid data.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.#ctor(Microsoft.OpenApi.Models.OpenApiExample)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiExample object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiExample</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.Serialize(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
|
|
<summary>
|
|
Writes out existing examples in a mediatype object
|
|
</summary>
|
|
<param name="writer"></param>
|
|
<param name="version"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1">
|
|
<summary>
|
|
Generic dictionary type for Open API dictionary element.
|
|
</summary>
|
|
<typeparam name="T">The Open API element, <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.#ctor(System.Collections.Generic.Dictionary{System.String,`0},System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Interfaces.IOpenApiExtension})">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1"/> class.
|
|
</summary>
|
|
<param name="dictionary">The generic dictionary.</param>
|
|
<param name="extensions">The dictionary of <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiExternalDocs">
|
|
<summary>
|
|
ExternalDocs object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Description">
|
|
<summary>
|
|
A short description of the target documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiExternalDocs.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.#ctor(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiHeader">
|
|
<summary>
|
|
Header Object.
|
|
The Header Object follows the structure of the Parameter Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Reference">
|
|
<summary>
|
|
Reference pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Description">
|
|
<summary>
|
|
A brief description of the header.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Required">
|
|
<summary>
|
|
Determines whether this header is mandatory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Deprecated">
|
|
<summary>
|
|
Specifies that a header is deprecated and SHOULD be transitioned out of usage.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.AllowEmptyValue">
|
|
<summary>
|
|
Sets the ability to pass empty-valued headers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.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.Models.OpenApiHeader.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.Models.OpenApiHeader.AllowReserved">
|
|
<summary>
|
|
Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Schema">
|
|
<summary>
|
|
The schema defining the type used for the header.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Example">
|
|
<summary>
|
|
Example of the media type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Examples">
|
|
<summary>
|
|
Examples of the media type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Content">
|
|
<summary>
|
|
A map containing the representations for the header.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.#ctor(Microsoft.OpenApi.Models.OpenApiHeader)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiHeader object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiHeader</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiInfo">
|
|
<summary>
|
|
Open API Info Object, it provides the metadata about the Open API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Title">
|
|
<summary>
|
|
REQUIRED. The title of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Description">
|
|
<summary>
|
|
A short description of the application.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Version">
|
|
<summary>
|
|
REQUIRED. The version of the OpenAPI document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiInfo.Contact">
|
|
<summary>
|
|
The contact information for the exposed API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiInfo.License">
|
|
<summary>
|
|
The license information for the exposed API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiInfo.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiInfo.#ctor(Microsoft.OpenApi.Models.OpenApiInfo)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiInfo.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiInfo.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiLicense">
|
|
<summary>
|
|
License Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Name">
|
|
<summary>
|
|
REQUIRED. The license name used for the API.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiLicense.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLicense.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLicense.#ctor(Microsoft.OpenApi.Models.OpenApiLicense)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLicense.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLicense.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiLink">
|
|
<summary>
|
|
Link Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiLink.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.Models.OpenApiLink.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.Models.OpenApiLink.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.Models.OpenApiLink.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.Models.OpenApiLink.Description">
|
|
<summary>
|
|
A description of the link.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiLink.Server">
|
|
<summary>
|
|
A server object to be used by the target operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiLink.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiLink.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiLink.Reference">
|
|
<summary>
|
|
Reference pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.#ctor(Microsoft.OpenApi.Models.OpenApiLink)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiLink object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiLink</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiMediaType">
|
|
<summary>
|
|
Media Type Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Schema">
|
|
<summary>
|
|
The schema defining the type used for the request body.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.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.Models.OpenApiMediaType.Extensions">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.#ctor(Microsoft.OpenApi.Models.OpenApiMediaType)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow">
|
|
<summary>
|
|
OAuth Flow Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.OpenApiOAuthFlow.RefreshUrl">
|
|
<summary>
|
|
The URL to be used for obtaining refresh tokens.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.Scopes">
|
|
<summary>
|
|
REQUIRED. A map between the scope name and a short description for it.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.#ctor(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows">
|
|
<summary>
|
|
OAuth Flows Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Implicit">
|
|
<summary>
|
|
Configuration for the OAuth Implicit flow
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Password">
|
|
<summary>
|
|
Configuration for the OAuth Resource Owner Password flow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.ClientCredentials">
|
|
<summary>
|
|
Configuration for the OAuth Client Credentials flow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.AuthorizationCode">
|
|
<summary>
|
|
Configuration for the OAuth Authorization Code flow.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.#ctor(Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> object
|
|
</summary>
|
|
<param name="oAuthFlows"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiOperation">
|
|
<summary>
|
|
Operation Object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiOperation.DeprecatedDefault">
|
|
<summary>
|
|
Default value for <see cref="P:Microsoft.OpenApi.Models.OpenApiOperation.Deprecated"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiOperation.Summary">
|
|
<summary>
|
|
A short summary of what the operation does.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiOperation.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation for this operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.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.Models.OpenApiOperation.Responses">
|
|
<summary>
|
|
REQUIRED. The list of possible responses as they are returned from executing this operation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.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.Models.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.Models.OpenApiOperation.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Annotations">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOperation.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOperation.#ctor(Microsoft.OpenApi.Models.OpenApiOperation)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOperation.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiOperation.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiParameter">
|
|
<summary>
|
|
Parameter Object.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiParameter._style">
|
|
<summary>
|
|
The style of the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.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.Models.OpenApiParameter.In">
|
|
<summary>
|
|
REQUIRED. The location of the parameter.
|
|
Possible values are "query", "header", "path" or "cookie".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Description">
|
|
<summary>
|
|
A brief description of the parameter. This could contain examples of use.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.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.Models.OpenApiParameter.Deprecated">
|
|
<summary>
|
|
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.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.Models.OpenApiParameter.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.Models.OpenApiParameter.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.Models.OpenApiParameter.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.Models.OpenApiParameter.Schema">
|
|
<summary>
|
|
The schema defining the type used for the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiParameter.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.Models.OpenApiParameter.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.Models.OpenApiParameter.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="P:Microsoft.OpenApi.Models.OpenApiParameter.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.#ctor">
|
|
<summary>
|
|
A parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.#ctor(Microsoft.OpenApi.Models.OpenApiParameter)">
|
|
<summary>
|
|
Initializes a clone instance of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiParameter object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiParameter</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiBodyParameter">
|
|
<summary>
|
|
Body parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiFormDataParameter">
|
|
<summary>
|
|
Form parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiPathItem">
|
|
<summary>
|
|
Path Item Object: to describe the operations available on a single path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Summary">
|
|
<summary>
|
|
An optional, string summary, intended to apply to all operations in this path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Description">
|
|
<summary>
|
|
An optional, string description, intended to apply to all operations in this path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Operations">
|
|
<summary>
|
|
Gets the definition of operations on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Servers">
|
|
<summary>
|
|
An alternative server array to service all operations in this path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.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="P:Microsoft.OpenApi.Models.OpenApiPathItem.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.AddOperation(Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.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.Models.OpenApiPathItem.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.#ctor(Microsoft.OpenApi.Models.OpenApiPathItem)">
|
|
<summary>
|
|
Initializes a clone of an <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiPathItem object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiPathItem</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize inline PathItem in OpenAPI V2
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize inline PathItem in OpenAPI V3
|
|
</summary>
|
|
<param name="writer"></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiPaths">
|
|
<summary>
|
|
Paths object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPaths.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiPaths.#ctor(Microsoft.OpenApi.Models.OpenApiPaths)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/> object
|
|
</summary>
|
|
<param name="paths">The <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiReference">
|
|
<summary>
|
|
A simple object to allow referencing other components in the specification, internally and externally.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiReference.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.Models.OpenApiReference.Type">
|
|
<summary>
|
|
The element type referenced.
|
|
</summary>
|
|
<remarks>This must be present if <see cref="P:Microsoft.OpenApi.Models.OpenApiReference.ExternalResource"/> is not present.</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiReference.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.Models.OpenApiReference.IsExternal">
|
|
<summary>
|
|
Gets a flag indicating whether this reference is an external reference.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiReference.IsLocal">
|
|
<summary>
|
|
Gets a flag indicating whether this reference is a local reference.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OpenApiReference.IsFragrament">
|
|
<summary>
|
|
Gets a flag indicating whether a file is a valid OpenAPI document or a fragment
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiReference.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.Models.OpenApiReference.ReferenceV3">
|
|
<summary>
|
|
Gets the full reference string for v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiReference.ReferenceV2">
|
|
<summary>
|
|
Gets the full reference string for V2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiReference.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiReference.#ctor(Microsoft.OpenApi.Models.OpenApiReference)">
|
|
<summary>
|
|
Initializes a copy instance of the <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiReference.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiReference.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiRequestBody">
|
|
<summary>
|
|
Request Body Object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Description">
|
|
<summary>
|
|
A brief description of the request body. This could contain examples of use.
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Required">
|
|
<summary>
|
|
Determines if the request body is required in the request. Defaults to false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.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="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.#ctor">
|
|
<summary>
|
|
Parameter-less constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.#ctor(Microsoft.OpenApi.Models.OpenApiRequestBody)">
|
|
<summary>
|
|
Initializes a copy instance of an <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiRequestBody object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiRequestBody</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiResponse">
|
|
<summary>
|
|
Response object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Description">
|
|
<summary>
|
|
REQUIRED. A short description of the response.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Headers">
|
|
<summary>
|
|
Maps a header name to its definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiResponse.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.Models.OpenApiResponse.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="P:Microsoft.OpenApi.Models.OpenApiResponse.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiResponse.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Reference">
|
|
<summary>
|
|
Reference pointer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.#ctor(Microsoft.OpenApi.Models.OpenApiResponse)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> to Open Api v3.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiRequestBody object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiResponse</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> to Open Api v2.0.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiResponses">
|
|
<summary>
|
|
Responses object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponses.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiResponses.#ctor(Microsoft.OpenApi.Models.OpenApiResponses)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/> object
|
|
</summary>
|
|
<param name="openApiResponses">The <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiSchema">
|
|
<summary>
|
|
Schema Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Title">
|
|
<summary>
|
|
Follow JSON Schema definition. Short text providing information about the data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Type">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
Value MUST be a string. Multiple types via an array are not supported.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Format">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
While relying on JSON Schema's defined formats,
|
|
the OAS offers a few additional predefined formats.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Description">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Maximum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExclusiveMaximum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Minimum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExclusiveMinimum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxLength">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinLength">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Pattern">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MultipleOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Default">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
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.Models.OpenApiSchema.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.Models.OpenApiSchema.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.Models.OpenApiSchema.AllOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.OneOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AnyOf">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Not">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Required">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Items">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
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.Models.OpenApiSchema.MaxItems">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinItems">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.UniqueItems">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Properties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AdditionalPropertiesAllowed">
|
|
<summary>
|
|
Indicates if the schema can contain properties other than those defined by the properties map.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AdditionalProperties">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
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.Models.OpenApiSchema.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.Models.OpenApiSchema.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.Models.OpenApiSchema.Enum">
|
|
<summary>
|
|
Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Nullable">
|
|
<summary>
|
|
Allows sending a null value for the defined schema. Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation for this schema.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.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.Models.OpenApiSchema.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.Models.OpenApiSchema.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.UnresolvedReference">
|
|
<summary>
|
|
Indicates object is a placeholder reference to an actual object and does not contain valid data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Annotations">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.#ctor(Microsoft.OpenApi.Models.OpenApiSchema)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.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.Models.OpenApiSchema.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference 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.Models.OpenApiSchema.GetEffective(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Returns an effective OpenApiSchema object based on the presence of a $ref
|
|
</summary>
|
|
<param name="doc">The host OpenApiDocument that contains the reference.</param>
|
|
<returns>OpenApiSchema</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.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.Models.OpenApiSecurityRequirement.#ctor">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> class.
|
|
This constructor ensures that only Reference.Id is considered when two dictionary keys
|
|
of type <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> are compared.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.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.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.Equals(Microsoft.OpenApi.Models.OpenApiSecurityScheme,Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
|
|
<summary>
|
|
Determines whether the specified objects are equal.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.GetHashCode(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
|
|
<summary>
|
|
Returns a hash code for the specified object.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme">
|
|
<summary>
|
|
Security Scheme Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Type">
|
|
<summary>
|
|
REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Description">
|
|
<summary>
|
|
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Name">
|
|
<summary>
|
|
REQUIRED. The name of the header, query or cookie parameter to be used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.In">
|
|
<summary>
|
|
REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.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.Models.OpenApiSecurityScheme.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.Models.OpenApiSecurityScheme.Flows">
|
|
<summary>
|
|
REQUIRED. An object containing configuration information for the flow types supported.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.OpenIdConnectUrl">
|
|
<summary>
|
|
REQUIRED. OpenId Connect URL to discover OAuth2 configuration values.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Reference">
|
|
<summary>
|
|
Reference object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.#ctor(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
|
|
<summary>
|
|
Initializes a copy of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.WriteOAuthFlowForV2(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
|
|
<summary>
|
|
Arbitrarily chooses one <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> object from the <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/>
|
|
to populate in V2 security scheme.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiServer">
|
|
<summary>
|
|
Server Object: an object representing a Server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.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.Models.OpenApiServer.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServer.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServer.#ctor(Microsoft.OpenApi.Models.OpenApiServer)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServer.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServer.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiServerVariable">
|
|
<summary>
|
|
Server Variable Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.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.Models.OpenApiServerVariable.Enum">
|
|
<summary>
|
|
An enumeration of string values to be used if the substitution options are from a limited set.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.#ctor(Microsoft.OpenApi.Models.OpenApiServerVariable)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiTag">
|
|
<summary>
|
|
Tag Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiTag.Name">
|
|
<summary>
|
|
The name of the tag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiTag.Description">
|
|
<summary>
|
|
A short description for the tag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiTag.ExternalDocs">
|
|
<summary>
|
|
Additional external documentation for this tag.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiTag.Extensions">
|
|
<summary>
|
|
This object MAY be extended with Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiTag.UnresolvedReference">
|
|
<summary>
|
|
Indicates if object is populated with data or is just a reference to the data
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiTag.Reference">
|
|
<summary>
|
|
Reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiTag.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiTag.#ctor(Microsoft.OpenApi.Models.OpenApiTag)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V3 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize to OpenAPI V2 document without using reference.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OpenApiXml">
|
|
<summary>
|
|
XML Object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiXml.Name">
|
|
<summary>
|
|
Replaces the name of the element/attribute used for the described schema property.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiXml.Prefix">
|
|
<summary>
|
|
The prefix to be used for the name
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.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.Models.OpenApiXml.Wrapped">
|
|
<summary>
|
|
Signifies whether the array is wrapped.
|
|
Default value is false.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.OpenApiXml.Extensions">
|
|
<summary>
|
|
Specification Extensions.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiXml.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiXml.#ctor(Microsoft.OpenApi.Models.OpenApiXml)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiXml.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> to Open Api v3.0
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.OpenApiXml.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> to Open Api v2.0
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.OperationType">
|
|
<summary>
|
|
Operation type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Get">
|
|
<summary>
|
|
A definition of a GET operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Put">
|
|
<summary>
|
|
A definition of a PUT operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Post">
|
|
<summary>
|
|
A definition of a POST operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Delete">
|
|
<summary>
|
|
A definition of a DELETE operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Options">
|
|
<summary>
|
|
A definition of a OPTIONS operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Head">
|
|
<summary>
|
|
A definition of a HEAD operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Patch">
|
|
<summary>
|
|
A definition of a PATCH operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.OperationType.Trace">
|
|
<summary>
|
|
A definition of a TRACE operation on this path.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.ParameterLocation">
|
|
<summary>
|
|
The location of the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterLocation.Query">
|
|
<summary>
|
|
Parameters that are appended to the URL.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterLocation.Header">
|
|
<summary>
|
|
Custom headers that are expected as part of the request.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.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.Models.ParameterLocation.Cookie">
|
|
<summary>
|
|
Used to pass a specific cookie value to the API.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.ParameterStyle">
|
|
<summary>
|
|
The style of the parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.Matrix">
|
|
<summary>
|
|
Path-style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.Label">
|
|
<summary>
|
|
Label style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.Form">
|
|
<summary>
|
|
Form style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.Simple">
|
|
<summary>
|
|
Simple style parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.SpaceDelimited">
|
|
<summary>
|
|
Space separated array values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.PipeDelimited">
|
|
<summary>
|
|
Pipe separated array values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ParameterStyle.DeepObject">
|
|
<summary>
|
|
Provides a simple way of rendering nested objects using form parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.ReferenceType">
|
|
<summary>
|
|
The reference type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Schema">
|
|
<summary>
|
|
Schema item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Response">
|
|
<summary>
|
|
Responses item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Parameter">
|
|
<summary>
|
|
Parameters item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Example">
|
|
<summary>
|
|
Examples item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.RequestBody">
|
|
<summary>
|
|
RequestBodies item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Header">
|
|
<summary>
|
|
Headers item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.SecurityScheme">
|
|
<summary>
|
|
SecuritySchemes item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Link">
|
|
<summary>
|
|
Links item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Callback">
|
|
<summary>
|
|
Callbacks item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Tag">
|
|
<summary>
|
|
Tags item.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.ReferenceType.Path">
|
|
<summary>
|
|
Paths item.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper">
|
|
<summary>
|
|
The wrapper either for <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> or <see cref="T:Microsoft.OpenApi.Expressions.RuntimeExpression"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.#ctor">
|
|
<summary>
|
|
Parameterless constructor
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.#ctor(Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.Any">
|
|
<summary>
|
|
Gets/Sets the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.Expression">
|
|
<summary>
|
|
Gets/Set the <see cref="T:Microsoft.OpenApi.Expressions.RuntimeExpression"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.WriteValue(Microsoft.OpenApi.Writers.IOpenApiWriter)">
|
|
<summary>
|
|
Write <see cref="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper"/>
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Models.SecuritySchemeType">
|
|
<summary>
|
|
The type of the security scheme
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.ApiKey">
|
|
<summary>
|
|
Use API key
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.Http">
|
|
<summary>
|
|
Use basic or bearer token authorization header.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.OAuth2">
|
|
<summary>
|
|
Use OAuth2
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.OpenIdConnect">
|
|
<summary>
|
|
Use OAuth2 with OpenId Connect URL to discover OAuth2 configuration value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.OpenApiFormat">
|
|
<summary>
|
|
Represents the Open Api document format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiFormat.Json">
|
|
<summary>
|
|
JSON format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.OpenApiFormat.Yaml">
|
|
<summary>
|
|
Yaml format.
|
|
</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="T:Microsoft.OpenApi.Properties.SRResource">
|
|
<summary>
|
|
A strongly-typed resource class, for looking up localized strings, etc.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.ResourceManager">
|
|
<summary>
|
|
Returns the cached ResourceManager instance used by this class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.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.Properties.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.Properties.SRResource.DefaultBaseUri">
|
|
<summary>
|
|
Looks up a localized string similar to http://localhost/.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.SRResource.IndentationLevelInvalid">
|
|
<summary>
|
|
Looks up a localized string similar to Indentation level cannot be lower than 0..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.SRResource.InvalidReferenceId">
|
|
<summary>
|
|
Looks up a localized string similar to Invalid Reference identifier '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.InvalidReferenceType">
|
|
<summary>
|
|
Looks up a localized string similar to Invalid Reference Type '{0}'..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.LocalReferenceRequiresType">
|
|
<summary>
|
|
Looks up a localized string similar to Local reference must have type specified..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.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.Properties.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.Properties.SRResource.OpenApiObjectElementIsRequired">
|
|
<summary>
|
|
Looks up a localized string similar to The object element name '{0}' is required..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.SRResource.ReferenceHasInvalidFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The reference string '{0}' has invalid format..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.RemoteReferenceNotSupported">
|
|
<summary>
|
|
Looks up a localized string similar to Remote reference not supported..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.RuntimeExpressionHasInvalidFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The runtime expression '{0}' has invalid format..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.RuntimeExpressionMustBeginWithDollar">
|
|
<summary>
|
|
Looks up a localized string similar to The runtime expression '{0}' should start with '$'.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.SRResource.ScopeMustBePresentToEnd">
|
|
<summary>
|
|
Looks up a localized string similar to Scope must be present to end..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.SRResource.SourceExpressionHasInvalidFormat">
|
|
<summary>
|
|
Looks up a localized string similar to The source expression '{0}' has invalid format..
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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.Properties.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="M:Microsoft.OpenApi.Services.CopyReferences.Visit(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
|
|
<summary>
|
|
Visits IOpenApiReferenceable instances that are references and not in components.
|
|
</summary>
|
|
<param name="referenceable"> An IOpenApiReferenceable object.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.CopyReferences.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
|
|
</summary>
|
|
<param name="schema">The OpenApiSchema to be visited.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.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.Services.LoopDetector.PopLoop``1">
|
|
<summary>
|
|
Exit from the context in cycle detection
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.LoopDetector.Loops">
|
|
<summary>
|
|
List of Loops detected
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.LoopDetector.ClearLoop``1">
|
|
<summary>
|
|
Reset loop tracking stack
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiFilterService">
|
|
<summary>
|
|
A service that slices an OpenApiDocument into a subset document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiFilterService.CreatePredicate(System.String,System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},Microsoft.OpenApi.Models.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.Services.OpenApiFilterService.CreateFilteredDocument(Microsoft.OpenApi.Models.OpenApiDocument,System.Func{System.String,System.Nullable{Microsoft.OpenApi.Models.OperationType},Microsoft.OpenApi.Models.OpenApiOperation,System.Boolean})">
|
|
<summary>
|
|
Create partial OpenAPI document based on the provided predicate.
|
|
</summary>
|
|
<param name="source">The target <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>.</param>
|
|
<param name="predicate">A predicate function.</param>
|
|
<returns>A partial OpenAPI document.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiFilterService.CreateOpenApiUrlTreeNode(System.Collections.Generic.Dictionary{System.String,Microsoft.OpenApi.Models.OpenApiDocument})">
|
|
<summary>
|
|
Creates an <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> from a collection of <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>.
|
|
</summary>
|
|
<param name="sources">Dictionary of labels and their corresponding <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> objects.</param>
|
|
<returns>The created <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiReferenceError">
|
|
<summary>
|
|
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceError.#ctor(Microsoft.OpenApi.Exceptions.OpenApiException)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class using the message and pointer from the given exception.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceError.#ctor(Microsoft.OpenApi.Models.OpenApiReference,System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="reference"></param>
|
|
<param name="message"></param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiReferenceResolver">
|
|
<summary>
|
|
This class is used to walk an OpenApiDocument and convert unresolved references to references to populated objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.#ctor(Microsoft.OpenApi.Models.OpenApiDocument,System.Boolean)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Services.OpenApiReferenceResolver"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Errors">
|
|
<summary>
|
|
List of errors related to the OpenApiDocument
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Resolves tags in OpenApiDocument
|
|
</summary>
|
|
<param name="doc"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
|
|
<summary>
|
|
Visits the referenceable element in the host document
|
|
</summary>
|
|
<param name="referenceable">The referenceable element in the doc.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
|
|
<summary>
|
|
Resolves references in components
|
|
</summary>
|
|
<param name="components"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
|
|
<summary>
|
|
Resolves all references used in callbacks
|
|
</summary>
|
|
<param name="callbacks"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiOperation)">
|
|
<summary>
|
|
Resolve all references used in an operation
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
|
|
<summary>
|
|
Resolve all references using in mediaType object
|
|
</summary>
|
|
<param name="mediaType"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Resolve all references to examples
|
|
</summary>
|
|
<param name="examples"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
|
|
<summary>
|
|
Resolve all references to responses
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
|
|
<summary>
|
|
Resolve all references to headers
|
|
</summary>
|
|
<param name="headers"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
|
|
<summary>
|
|
Resolve all references to SecuritySchemes
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
|
|
<summary>
|
|
Resolve all references to parameters
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
|
|
<summary>
|
|
Resolve all references used in a parameter
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
|
|
<summary>
|
|
Resolve all references to links
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
|
|
<summary>
|
|
Resolve all references used in a schema
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiReferenceResolver.ResolveTags(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
|
|
<summary>
|
|
Replace references to tags with either tag objects declared in components, or inline tag object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode">
|
|
<summary>
|
|
A directory structure representing the paths of an OpenAPI document.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Children">
|
|
<summary>
|
|
All the subdirectories of a node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Path">
|
|
<summary>
|
|
The relative directory path of the current node from the root node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.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.Services.OpenApiUrlTreeNode.AdditionalData">
|
|
<summary>
|
|
A dictionary of key value pairs that contain information about a node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.IsParameter">
|
|
<summary>
|
|
Flag indicating whether a node segment is a path parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Segment">
|
|
<summary>
|
|
The subdirectory of a relative path.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.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.Services.OpenApiUrlTreeNode.#ctor(System.String)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="segment">The subdirectory of a relative path.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Create">
|
|
<summary>
|
|
Creates an empty structured directory of <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> node.
|
|
</summary>
|
|
<returns>The root node of the created <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> directory structure.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Create(Microsoft.OpenApi.Models.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Creates a structured directory of <see cref="T:Microsoft.OpenApi.Services.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.Services.OpenApiUrlTreeNode"/> nodes in the directory structure.</param>
|
|
<returns>The root node of the created <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> directory structure.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Attach(Microsoft.OpenApi.Models.OpenApiDocument,System.String)">
|
|
<summary>
|
|
Retrieves the paths from an OpenAPI document and appends the items to an <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> node.
|
|
</summary>
|
|
<param name="doc">The OpenAPI document.</param>
|
|
<param name="label">Name tag for labelling related <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> nodes in the directory structure.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Attach(System.String,Microsoft.OpenApi.Models.OpenApiPathItem,System.String)">
|
|
<summary>
|
|
Appends a path and the PathItem to an <see cref="T:Microsoft.OpenApi.Services.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.Services.OpenApiUrlTreeNode"/> node.</param>
|
|
<returns>An <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> node describing an OpenAPI path.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiUrlTreeNode.Attach(System.Collections.Generic.IEnumerable{System.String},Microsoft.OpenApi.Models.OpenApiPathItem,System.String,System.String)">
|
|
<summary>
|
|
Assembles the constituent properties of an <see cref="T:Microsoft.OpenApi.Services.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.Services.OpenApiUrlTreeNode"/> node.</param>
|
|
<param name="currentPath">The relative path of a node.</param>
|
|
<returns>An <see cref="T:Microsoft.OpenApi.Services.OpenApiUrlTreeNode"/> node with all constituent properties assembled.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.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.Services.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.Services.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.Services.MermaidNodeStyle">
|
|
<summary>
|
|
Defines the color and shape of a node in a Mermaid graph diagram
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.MermaidNodeStyle.#ctor(System.String,Microsoft.OpenApi.Services.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.Services.MermaidNodeStyle.Color">
|
|
<summary>
|
|
The CSS color name of the diagram element
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.MermaidNodeStyle.Shape">
|
|
<summary>
|
|
The shape of the diagram element
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.MermaidNodeShape">
|
|
<summary>
|
|
Shapes supported by Mermaid diagrams
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Services.MermaidNodeShape.SquareCornerRectangle">
|
|
<summary>
|
|
Rectangle with square corners
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Services.MermaidNodeShape.RoundedCornerRectangle">
|
|
<summary>
|
|
Rectangle with rounded corners
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Services.MermaidNodeShape.Circle">
|
|
<summary>
|
|
Circle
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Services.MermaidNodeShape.Rhombus">
|
|
<summary>
|
|
Rhombus
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Services.MermaidNodeShape.OddShape">
|
|
<summary>
|
|
Odd shape
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiVisitorBase">
|
|
<summary>
|
|
Open API visitor base provides common logic for concrete visitors
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiVisitorBase.CurrentKeys">
|
|
<summary>
|
|
Properties available to identify context of where an object is within OpenAPI Document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.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.Services.OpenApiVisitorBase.Exit">
|
|
<summary>
|
|
Exit from path context level. Enter and Exit calls should be matched.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiVisitorBase.PathString">
|
|
<summary>
|
|
Pointer to source of validation error in document
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiInfo)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiContact)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiLicense)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiServer})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiServer)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiPaths)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiPathItem)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiServerVariable)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
|
|
<summary>
|
|
Visits the operations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiOperation)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiRequestBody)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
|
|
<summary>
|
|
Visits headers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
|
|
<summary>
|
|
Visits callbacks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiResponse)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
|
|
<summary>
|
|
Visits media type content.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiEncoding)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Visits the examples.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
|
|
<summary>
|
|
Visits the links.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiLink)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiCallback)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiTag)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiHeader)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiExample)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSecurityRequirement})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
|
|
<summary>
|
|
Visits a dictionary of server variables
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
|
|
<summary>
|
|
Visits a dictionary of encodings
|
|
</summary>
|
|
<param name="encodings"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
|
|
<summary>
|
|
Visits IOpenApiReferenceable instances that are references and not in components
|
|
</summary>
|
|
<param name="referenceable">referenced object</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiWalker">
|
|
<summary>
|
|
The walker to visit multiple Open API elements.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.#ctor(Microsoft.OpenApi.Services.OpenApiVisitorBase)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Services.OpenApiWalker"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> and child objects
|
|
</summary>
|
|
<param name="doc">OpenApiDocument to be walked</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiComponents)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiPaths)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiServer})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiInfo)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
|
|
<summary>
|
|
Visits dictionary of extensions
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiLicense)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiContact)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiCallback,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiTag)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiServer)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiServerVariable)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiPathItem)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOperation)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> and child objects
|
|
</summary>
|
|
<param name="operation"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSecurityRequirement})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiParameter,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiResponses)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiResponse,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiRequestBody,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiMediaType)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiEncoding)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSchema,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Any.IOpenApiAny)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiExample,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Visits the list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSchema})">
|
|
<summary>
|
|
Visits a list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
|
|
<summary>
|
|
Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiLink,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiHeader,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSecurityScheme,System.Boolean)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> and child objects
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiElement)">
|
|
<summary>
|
|
Dispatcher method that enables using a single method to walk the model
|
|
starting from any <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.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.Services.OpenApiWalker.ProcessAsReference(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable,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.Services.CurrentKeys">
|
|
<summary>
|
|
Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Path">
|
|
<summary>
|
|
Current Path key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Operation">
|
|
<summary>
|
|
Current Operation Type
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Response">
|
|
<summary>
|
|
Current Response Status Code
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Content">
|
|
<summary>
|
|
Current Content Media Type
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Callback">
|
|
<summary>
|
|
Current Callback Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Link">
|
|
<summary>
|
|
Current Link Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Header">
|
|
<summary>
|
|
Current Header Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Encoding">
|
|
<summary>
|
|
Current Encoding Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Example">
|
|
<summary>
|
|
Current Example Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.Extension">
|
|
<summary>
|
|
Current Extension Key
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.CurrentKeys.ServerVariable">
|
|
<summary>
|
|
Current ServerVariable
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OpenApiWorkspace">
|
|
<summary>
|
|
Contains a set of OpenApi documents and document fragments that reference each other
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiWorkspace.Documents">
|
|
<summary>
|
|
A list of OpenApiDocuments contained in the workspace
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiWorkspace.Fragments">
|
|
<summary>
|
|
A list of document fragments that are contained in the workspace
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiWorkspace.BaseUrl">
|
|
<summary>
|
|
The base location from where all relative references are resolved
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OpenApiWorkspace.Artifacts">
|
|
<summary>
|
|
A list of document fragments that are contained in the workspace
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.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.Services.OpenApiWorkspace.#ctor">
|
|
<summary>
|
|
Initialize workspace using current directory as the default location.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWorkspace.#ctor(Microsoft.OpenApi.Services.OpenApiWorkspace)">
|
|
<summary>
|
|
Initializes a copy of an <see cref="T:Microsoft.OpenApi.Services.OpenApiWorkspace"/> object
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWorkspace.Contains(System.String)">
|
|
<summary>
|
|
Verify if workspace contains a document 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.Services.OpenApiWorkspace.AddDocument(System.String,Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Add an OpenApiDocument to the workspace.
|
|
</summary>
|
|
<param name="location"></param>
|
|
<param name="document"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWorkspace.AddFragment(System.String,Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
|
|
<summary>
|
|
Adds a fragment of an OpenApiDocument to the workspace.
|
|
</summary>
|
|
<param name="location"></param>
|
|
<param name="fragment"></param>
|
|
<remarks>Not sure how this is going to work. Does the reference just point to the fragment as a whole, or do we need to
|
|
to be able to point into the fragment. Keeping it private until we figure it out.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWorkspace.AddArtifact(System.String,System.IO.Stream)">
|
|
<summary>
|
|
Add a stream based artifact to the workspace. Useful for images, examples, alternative schemas.
|
|
</summary>
|
|
<param name="location"></param>
|
|
<param name="artifact"></param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWorkspace.ResolveReference(Microsoft.OpenApi.Models.OpenApiReference)">
|
|
<summary>
|
|
Returns the target of an OpenApiReference from within the workspace.
|
|
</summary>
|
|
<param name="reference">An instance of an OpenApiReference</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OpenApiWorkspace.GetArtifact(System.String)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="location"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.OperationSearch">
|
|
<summary>
|
|
Visits OpenApi operations and parameters.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.OperationSearch.SearchResults">
|
|
<summary>
|
|
A list of operations from the operation search.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OperationSearch.#ctor(System.Func{System.String,System.Nullable{Microsoft.OpenApi.Models.OperationType},Microsoft.OpenApi.Models.OpenApiOperation,System.Boolean})">
|
|
<summary>
|
|
The OperationSearch constructor.
|
|
</summary>
|
|
<param name="predicate">A predicate function.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OperationSearch.Visit(Microsoft.OpenApi.Models.OpenApiPathItem)">
|
|
<summary>
|
|
Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/>
|
|
</summary>
|
|
<param name="pathItem"> The target <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/>.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Services.OperationSearch.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
|
|
<summary>
|
|
Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>.
|
|
</summary>
|
|
<param name="parameters">The target list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>.</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Services.SearchResult">
|
|
<summary>
|
|
Defines a search result model for visited operations.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.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.Services.SearchResult.Operation">
|
|
<summary>
|
|
An Operation object.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Services.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.Validations.IValidationContext">
|
|
<summary>
|
|
Constrained interface used to provide context to rule implementation
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.IValidationContext.AddError(Microsoft.OpenApi.Validations.OpenApiValidatorError)">
|
|
<summary>
|
|
Register an error with the validation context.
|
|
</summary>
|
|
<param name="error">Error to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.IValidationContext.AddWarning(Microsoft.OpenApi.Validations.OpenApiValidatorWarning)">
|
|
<summary>
|
|
Register a warning with the validation context.
|
|
</summary>
|
|
<param name="warning">Warning to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.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.Validations.IValidationContext.Exit">
|
|
<summary>
|
|
Exit from path context level. Enter and Exit calls should be matched.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.IValidationContext.PathString">
|
|
<summary>
|
|
Pointer to source of validation error in document
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.OpenApiValidatorWarning">
|
|
<summary>
|
|
Warnings detected when validating an OpenAPI Element
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidatorWarning.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.OpenApiValidatorWarning.RuleName">
|
|
<summary>
|
|
Name of rule that detected the error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.OpenApiValidator">
|
|
<summary>
|
|
Class containing dispatchers to execute validation rules on for Open API document.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.#ctor(Microsoft.OpenApi.Validations.ValidationRuleSet)">
|
|
<summary>
|
|
Create a visitor that will validate an OpenAPIDocument
|
|
</summary>
|
|
<param name="ruleSet"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.OpenApiValidator.Errors">
|
|
<summary>
|
|
Gets the validation errors.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.OpenApiValidator.Warnings">
|
|
<summary>
|
|
Gets the validation warnings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.AddError(Microsoft.OpenApi.Validations.OpenApiValidatorError)">
|
|
<summary>
|
|
Register an error with the validation context.
|
|
</summary>
|
|
<param name="error">Error to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.AddWarning(Microsoft.OpenApi.Validations.OpenApiValidatorWarning)">
|
|
<summary>
|
|
Register an error with the validation context.
|
|
</summary>
|
|
<param name="warning">Error to register.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiInfo)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiContact)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiHeader)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiResponse)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiLicense)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiTag)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiServer)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiEncoding)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiCallback)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
|
|
<summary>
|
|
Execute validation rules against an <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Execute validation rules against a list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
|
|
</summary>
|
|
<param name="items">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiPathItem)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiServerVariable)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiRequestBody)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiPaths)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiLink)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiExample)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiOperation)">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
|
|
<summary>
|
|
Execute validation rules against a <see cref="T:System.Collections.Generic.IDictionary`2"/>
|
|
</summary>
|
|
<param name="item">The object to be validated</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.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.Validations.OpenApiValidatorError">
|
|
<summary>
|
|
Errors detected when validating an OpenAPI Element
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.OpenApiValidatorError.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.OpenApiValidatorError.RuleName">
|
|
<summary>
|
|
Name of rule that detected the error.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules.KeyRegex">
|
|
<summary>
|
|
The key regex.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.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.Validations.Rules.OpenApiContactRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiContactRules.EmailMustBeEmailFormat">
|
|
<summary>
|
|
Email field MUST be email address.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiDocumentRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiDocumentRules.OpenApiDocumentFieldIsMissing">
|
|
<summary>
|
|
The Info field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiExtensibleRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiExtensibleRules.ExtensionNameMustStartWithXDash">
|
|
<summary>
|
|
Extension name MUST start with "x-".
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiExternalDocsRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiExternalDocsRules.UrlIsRequired">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiHeaderRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiHeaderRules.HeaderMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiInfoRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiInfoRules.InfoRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiLicenseRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiLicenseRules.LicenseRequiredFields">
|
|
<summary>
|
|
REQUIRED.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiMediaTypeRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>.
|
|
</summary>
|
|
<remarks>
|
|
Removed this in v1.3 as a default rule as the OpenAPI specification does not require that example
|
|
values validate against the schema. Validating examples against the schema is particularly difficult
|
|
as it requires parsing of the example using the schema as a guide. This is not possible when the schema
|
|
is referenced. Even if we fix this issue, this rule should be treated as a warning, not an error
|
|
Future versions of the validator should make that distinction.
|
|
Future versions of the example parsers should not try an infer types.
|
|
Example validation should be done as a separate post reading step so all schemas can be fully available.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiMediaTypeRules.MediaTypeMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiOAuthFlowRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiOAuthFlowRules.OAuthFlowRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.ParameterRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.RequiredMustBeTrueWhenInIsPath">
|
|
<summary>
|
|
Validate the "required" field is true when "in" is path.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.ParameterMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.PathParameterShouldBeInThePath">
|
|
<summary>
|
|
Validate that a path parameter should always appear in the path
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiPathsRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.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.Validations.Rules.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.Validations.Rules.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.Validations.Rules.OpenApiResponseRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponseRules.ResponseRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules.ResponsesMustContainAtLeastOneResponse">
|
|
<summary>
|
|
An OpenAPI operation must contain at least one response
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.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.Validations.Rules.OpenApiRuleAttribute">
|
|
<summary>
|
|
The Validator attribute.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.SchemaMismatchedDataType">
|
|
<summary>
|
|
Validate the data matches with the given data type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.ValidateSchemaDiscriminator">
|
|
<summary>
|
|
Validates Schema Discriminator
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.ValidateChildSchemaAgainstDiscriminator(Microsoft.OpenApi.Models.OpenApiSchema,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.Validations.Rules.OpenApiSchemaRules.TraverseSchemaElements(System.String,System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSchema})">
|
|
<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.Validations.Rules.OpenApiServerRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiServerRules.ServerRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiTagRules">
|
|
<summary>
|
|
The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiTagRules.TagRequiredFields">
|
|
<summary>
|
|
Validate the field is required.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.Rules.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.Validations.ValidationContextExtensions">
|
|
<summary>
|
|
Helper methods to simplify creating validation rules
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationContextExtensions.CreateError(Microsoft.OpenApi.Validations.IValidationContext,System.String,System.String)">
|
|
<summary>
|
|
Helper method to simplify validation rules
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationContextExtensions.CreateWarning(Microsoft.OpenApi.Validations.IValidationContext,System.String,System.String)">
|
|
<summary>
|
|
Helper method to simplify validation rules
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Validations.ValidationRule">
|
|
<summary>
|
|
Class containing validation rule logic.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.ValidationRule.ElementType">
|
|
<summary>
|
|
Element Type.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.ValidationRule.Name">
|
|
<summary>
|
|
Validation rule Name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRule.Evaluate(Microsoft.OpenApi.Validations.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.Validations.ValidationRule`1">
|
|
<summary>
|
|
Class containing validation rule logic for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/>.
|
|
</summary>
|
|
<typeparam name="T"></typeparam>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRule`1.#ctor(System.Action{Microsoft.OpenApi.Validations.IValidationContext,`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRule"/> class.
|
|
</summary>
|
|
<param name="validate">Action to perform the validation.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRule`1.#ctor(System.String,System.Action{Microsoft.OpenApi.Validations.IValidationContext,`0})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.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.Validations.ValidationRuleSet">
|
|
<summary>
|
|
The rule set of the validation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.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.Validations.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.Validations.ValidationRuleSet.GetEmptyRuleSet">
|
|
<summary>
|
|
Return <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> with no rules
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor(Microsoft.OpenApi.Validations.ValidationRuleSet)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
|
|
</summary>
|
|
<param name="ruleSet">Rule set to be copied from.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor(System.Collections.Generic.IEnumerable{Microsoft.OpenApi.Validations.ValidationRule})">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
|
|
</summary>
|
|
<param name="rules">Rules to be contained in this ruleset.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Validations.ValidationRuleSet.Rules">
|
|
<summary>
|
|
Gets the rules in this rule set.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.Add(Microsoft.OpenApi.Validations.ValidationRule)">
|
|
<summary>
|
|
Add the new rule into the rule set.
|
|
</summary>
|
|
<param name="rule">The rule.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.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.Validations.ValidationRuleSet.Remove(System.Type)">
|
|
<summary>
|
|
Remove a rule by element type.
|
|
</summary>
|
|
<param name="type">Type of the rule.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetEnumerator">
|
|
<summary>
|
|
Get the enumerator.
|
|
</summary>
|
|
<returns>The enumerator.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Get the enumerator.
|
|
</summary>
|
|
<returns>The enumerator.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.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.Writers.FormattingStreamWriter.#ctor(System.IO.Stream,System.IFormatProvider)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.FormattingStreamWriter"/> class.
|
|
</summary>
|
|
<param name="stream"></param>
|
|
<param name="formatProvider"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.FormattingStreamWriter.FormatProvider">
|
|
<summary>
|
|
The <see cref="T:System.IFormatProvider"/> associated with this <see cref="T:Microsoft.OpenApi.Writers.FormattingStreamWriter"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.IOpenApiWriter">
|
|
<summary>
|
|
Interface for writing Open API documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteStartObject">
|
|
<summary>
|
|
Write the start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteEndObject">
|
|
<summary>
|
|
Write the end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteStartArray">
|
|
<summary>
|
|
Write the start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteEndArray">
|
|
<summary>
|
|
Write the end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write the property name.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.String)">
|
|
<summary>
|
|
Write the string value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Decimal)">
|
|
<summary>
|
|
Write the decimal value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Int32)">
|
|
<summary>
|
|
Write the int value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Boolean)">
|
|
<summary>
|
|
Write the boolean value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteNull">
|
|
<summary>
|
|
Write the null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteRaw(System.String)">
|
|
<summary>
|
|
Write the raw content value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Object)">
|
|
<summary>
|
|
Write the object value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.Flush">
|
|
<summary>
|
|
Flush the writer.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter">
|
|
<summary>
|
|
JSON Writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiJsonWriterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.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.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.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.Writers.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.Writers.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.Writers.OpenApiJsonWriter.WriteStartObject">
|
|
<summary>
|
|
Write JSON start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteEndObject">
|
|
<summary>
|
|
Write JSON end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteStartArray">
|
|
<summary>
|
|
Write JSON start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteEndArray">
|
|
<summary>
|
|
Write JSON end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.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.Writers.OpenApiJsonWriter.WriteValue(System.String)">
|
|
<summary>
|
|
Write string value.
|
|
</summary>
|
|
<param name="value">The string value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteNull">
|
|
<summary>
|
|
Write null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.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.Writers.OpenApiJsonWriter.WriteRaw(System.String)">
|
|
<summary>
|
|
Writes the content raw value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteIndentation">
|
|
<summary>
|
|
Write the indentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteLine">
|
|
<summary>
|
|
Writes a line terminator to the text string or stream.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.OpenApiJsonWriterSettings">
|
|
<summary>
|
|
Configuration settings to control how OpenAPI Json documents are written
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriterSettings.#ctor">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiJsonWriterSettings"/> class.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterAnyExtensions">
|
|
<summary>
|
|
Extensions methods for writing the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterAnyExtensions.WriteExtensions(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Interfaces.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.Writers.OpenApiWriterAnyExtensions.WriteAny``1(Microsoft.OpenApi.Writers.IOpenApiWriter,``0)">
|
|
<summary>
|
|
Write the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> value.
|
|
</summary>
|
|
<typeparam name="T">The Open API Any type.</typeparam>
|
|
<param name="writer">The Open API writer.</param>
|
|
<param name="any">The Any value</param>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.OpenApiWriterBase">
|
|
<summary>
|
|
Base class for Open API writer.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.Settings">
|
|
<summary>
|
|
Settings for controlling how the OpenAPI document will be written out.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase.IndentationString">
|
|
<summary>
|
|
The indentation string to prepend to each line for each indentation level.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase.Scopes">
|
|
<summary>
|
|
Scope of the Open API element - object, array, property.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase._indentLevel">
|
|
<summary>
|
|
Number which specifies the level of indentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.#ctor(System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiWriterBase"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiWriterBase"/> class.
|
|
</summary>
|
|
<param name="textWriter"></param>
|
|
<param name="settings"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterBase.Writer">
|
|
<summary>
|
|
The text writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteStartObject">
|
|
<summary>
|
|
Write start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteEndObject">
|
|
<summary>
|
|
Write end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteStartArray">
|
|
<summary>
|
|
Write start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteEndArray">
|
|
<summary>
|
|
Write end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write the start property.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterBase.WriteNull">
|
|
<summary>
|
|
Write null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteRaw(System.String)">
|
|
<summary>
|
|
Write content raw value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.Flush">
|
|
<summary>
|
|
Flush the writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.String)">
|
|
<summary>
|
|
Write string value.
|
|
</summary>
|
|
<param name="value">The string value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Single)">
|
|
<summary>
|
|
Write float value.
|
|
</summary>
|
|
<param name="value">The float value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Double)">
|
|
<summary>
|
|
Write double value.
|
|
</summary>
|
|
<param name="value">The double value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Decimal)">
|
|
<summary>
|
|
Write decimal value.
|
|
</summary>
|
|
<param name="value">The decimal value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Int32)">
|
|
<summary>
|
|
Write integer value.
|
|
</summary>
|
|
<param name="value">The integer value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Int64)">
|
|
<summary>
|
|
Write long value.
|
|
</summary>
|
|
<param name="value">The long value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.DateTime)">
|
|
<summary>
|
|
Write DateTime value.
|
|
</summary>
|
|
<param name="value">The DateTime value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.DateTimeOffset)">
|
|
<summary>
|
|
Write DateTimeOffset value.
|
|
</summary>
|
|
<param name="value">The DateTimeOffset value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Boolean)">
|
|
<summary>
|
|
Write boolean value.
|
|
</summary>
|
|
<param name="value">The boolean value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Object)">
|
|
<summary>
|
|
Write object value.
|
|
</summary>
|
|
<param name="value">The object value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IncreaseIndentation">
|
|
<summary>
|
|
Increases the level of indentation applied to the output.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.DecreaseIndentation">
|
|
<summary>
|
|
Decreases the level of indentation applied to the output.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteIndentation">
|
|
<summary>
|
|
Write the indentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.CurrentScope">
|
|
<summary>
|
|
Get current scope.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.StartScope(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterBase.EndScope(Microsoft.OpenApi.Writers.ScopeType)">
|
|
<summary>
|
|
End the scope of the given scope type.
|
|
</summary>
|
|
<param name="type"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsTopLevelScope">
|
|
<summary>
|
|
Whether the current scope is the top level (outermost) scope.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsObjectScope">
|
|
<summary>
|
|
Whether the current scope is an object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsArrayScope">
|
|
<summary>
|
|
Whether the current scope is an array scope.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.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="T:Microsoft.OpenApi.Writers.OpenApiWriterExtensions">
|
|
<summary>
|
|
Extension methods for writing Open API documentation.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteRequiredProperty(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteOptionalObject``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the optional Open API object/element.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.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.Writers.OpenApiWriterExtensions.WriteRequiredObject``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the required Open API object/element.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.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.Writers.OpenApiWriterExtensions.WriteOptionalCollection(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{System.String},System.Action{Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteOptionalCollection``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.Writers.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.Interfaces.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.Writers.OpenApiWriterExtensions.WriteRequiredCollection``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.Writers.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.Interfaces.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.Writers.OpenApiWriterExtensions.WriteOptionalMap(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Action{Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteRequiredMap(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Action{Microsoft.OpenApi.Writers.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.Writers.OpenApiWriterExtensions.WriteOptionalMap``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the optional Open API element map.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.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.Writers.OpenApiWriterExtensions.WriteOptionalMap``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.Writers.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.Interfaces.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.Writers.OpenApiWriterExtensions.WriteRequiredMap``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
|
|
<summary>
|
|
Write the required Open API element map.
|
|
</summary>
|
|
<typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.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.Writers.ReferenceInlineSetting">
|
|
<summary>
|
|
Indicates if and when the writer should convert references into complete object renderings
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.DoNotInlineReferences">
|
|
<summary>
|
|
Render all references as $ref.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.InlineLocalReferences">
|
|
<summary>
|
|
Render all local references as inline objects
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.InlineAllReferences">
|
|
<summary>
|
|
Render all references as inline objects.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.OpenApiWriterSettings">
|
|
<summary>
|
|
Configuration settings to control how OpenAPI documents are written
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.OpenApiWriterSettings.ReferenceInline">
|
|
<summary>
|
|
Indicates how references in the source document should be handled.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.OpenApiWriterSettings.InlineLocalReferences">
|
|
<summary>
|
|
Indicates if local references should be rendered as an inline object
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.OpenApiWriterSettings.InlineExternalReferences">
|
|
<summary>
|
|
Indicates if external references should be rendered as an inline object
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter">
|
|
<summary>
|
|
YAML writer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.#ctor(System.IO.TextWriter)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter"/> class.
|
|
</summary>
|
|
<param name="textWriter">The text writer.</param>
|
|
<param name="settings"></param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.OpenApiYamlWriter.UseLiteralStyle">
|
|
<summary>
|
|
Allow rendering of multi-line strings using YAML | syntax
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.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.Writers.OpenApiYamlWriter.WriteStartObject">
|
|
<summary>
|
|
Write YAML start object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteEndObject">
|
|
<summary>
|
|
Write YAML end object.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteStartArray">
|
|
<summary>
|
|
Write YAML start array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteEndArray">
|
|
<summary>
|
|
Write YAML end array.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WritePropertyName(System.String)">
|
|
<summary>
|
|
Write the property name and the delimiter.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteValue(System.String)">
|
|
<summary>
|
|
Write string value.
|
|
</summary>
|
|
<param name="value">The string value.</param>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteNull">
|
|
<summary>
|
|
Write null value.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteValueSeparator">
|
|
<summary>
|
|
Write value separator.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteRaw(System.String)">
|
|
<summary>
|
|
Writes the content raw value.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.ScopeType">
|
|
<summary>
|
|
Various scope types for Open API writer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.ScopeType.Object">
|
|
<summary>
|
|
Object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.ScopeType.Array">
|
|
<summary>
|
|
Array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.Scope">
|
|
<summary>
|
|
Class representing scope information.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.Scope._type">
|
|
<summary>
|
|
The type of the scope.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.Scope.#ctor(Microsoft.OpenApi.Writers.ScopeType)">
|
|
<summary>
|
|
Constructor.
|
|
</summary>
|
|
<param name="type">The type of the scope.</param>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.Scope.ObjectCount">
|
|
<summary>
|
|
Get/Set the object count for this scope.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.Scope.Type">
|
|
<summary>
|
|
Gets the scope type for this scope.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.OpenApi.Writers.Scope.IsInArray">
|
|
<summary>
|
|
Get/Set the whether it is in previous array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions">
|
|
<summary>
|
|
Extensions class for strings to handle special characters.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.OpenApi.Writers.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.Writers.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.Writers.WriterConstants">
|
|
<summary>
|
|
Constants for the writer.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeFormat">
|
|
<summary>
|
|
JSON datetime format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeOffsetFormat">
|
|
<summary>
|
|
JSON datetime offset format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeOffsetPlusSign">
|
|
<summary>
|
|
A plus sign for the date time offset format.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonTrueLiteral">
|
|
<summary>
|
|
The true value literal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonFalseLiteral">
|
|
<summary>
|
|
The false value literal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonNullLiteral">
|
|
<summary>
|
|
The null value literal.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartObjectScope">
|
|
<summary>
|
|
Character which starts the object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndObjectScope">
|
|
<summary>
|
|
Character which ends the object scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartArrayScope">
|
|
<summary>
|
|
Character which starts the array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndArrayScope">
|
|
<summary>
|
|
Character which ends the array scope.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartPaddingFunctionScope">
|
|
<summary>
|
|
"(" Json Padding Function scope open parens.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndPaddingFunctionScope">
|
|
<summary>
|
|
")" Json Padding Function scope close parens.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.ObjectMemberSeparator">
|
|
<summary>
|
|
The separator between object members.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.ArrayElementSeparator">
|
|
<summary>
|
|
The separator between array elements.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.NameValueSeparator">
|
|
<summary>
|
|
The separator between the name and the value.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.NameValueSeparatorWhiteSpaceSuffix">
|
|
<summary>
|
|
The white space postfixing <see cref="F:Microsoft.OpenApi.Writers.WriterConstants.NameValueSeparator"/>
|
|
when producing pretty content.
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForEmptyObject">
|
|
<summary>
|
|
The white space for empty object
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForEmptyArray">
|
|
<summary>
|
|
The white space for empty array
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.PrefixOfArrayItem">
|
|
<summary>
|
|
The prefix of array item
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForIndent">
|
|
<summary>
|
|
The white space for indent
|
|
</summary>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.WriterConstants.EmptyObject">
|
|
<summary>
|
|
Empty object
|
|
</summary>
|
|
<remarks>To indicate empty object in YAML.</remarks>
|
|
</member>
|
|
<member name="F:Microsoft.OpenApi.Writers.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>
|
|
</members>
|
|
</doc>
|