SwaggerSchema Class

Definition

The swagger schema.

public class SwaggerSchema
public class SwaggerSchema : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Logic.Models.SwaggerSchema>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Logic.Models.SwaggerSchema>
type SwaggerSchema = class
type SwaggerSchema = class
    interface IJsonModel<SwaggerSchema>
    interface IPersistableModel<SwaggerSchema>
Public Class SwaggerSchema
Public Class SwaggerSchema
Implements IJsonModel(Of SwaggerSchema), IPersistableModel(Of SwaggerSchema)
Inheritance
SwaggerSchema
Implements

Constructors

SwaggerSchema()

Initializes a new instance of SwaggerSchema.

Properties

AdditionalProperties

The additional properties.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

AllOf

The schemas which must pass validation when this schema is used.

Discriminator

The discriminator.

DynamicListNew

The dynamic list.

DynamicSchemaNew

The dynamic schema configuration.

DynamicSchemaOld

The dynamic schema configuration.

DynamicTree

The dynamic values tree configuration.

Example

The example value.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

ExternalDocs

The external documentation.

IsNotificationUrlExtension

Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.

IsReadOnly

Indicates whether this property must be present in the a request.

Items

The items schema.

MaxProperties

The maximum number of allowed properties.

MinProperties

The minimum number of allowed properties.

Properties

The object properties.

Reference

The reference.

RequiredProperties

The object required properties.

SchemaType

The type.

Title

The title.

Xml

The xml representation format for a property.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SwaggerSchema>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SwaggerSchema>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SwaggerSchema>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SwaggerSchema>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SwaggerSchema>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to