Share via

Microsoft.ApiManagement service/workspaces/apis/operations 2023-05-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp service/workspaces/apis/operations kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/workspaces/apis/operations-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/operations@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    method: 'string'
    policies: 'string'
    request: {
      description: 'string'
      headers: [
        {
          defaultValue: 'string'
          description: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          name: 'string'
          required: bool
          schemaId: 'string'
          type: 'string'
          typeName: 'string'
          values: [
            'string'
          ]
        }
      ]
      queryParameters: [
        {
          defaultValue: 'string'
          description: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          name: 'string'
          required: bool
          schemaId: 'string'
          type: 'string'
          typeName: 'string'
          values: [
            'string'
          ]
        }
      ]
      representations: [
        {
          contentType: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any()
                }
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any()
                }
              }
              name: 'string'
              required: bool
              schemaId: 'string'
              type: 'string'
              typeName: 'string'
              values: [
                'string'
              ]
            }
          ]
          schemaId: 'string'
          typeName: 'string'
        }
      ]
    }
    responses: [
      {
        description: 'string'
        headers: [
          {
            defaultValue: 'string'
            description: 'string'
            examples: {
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
            }
            name: 'string'
            required: bool
            schemaId: 'string'
            type: 'string'
            typeName: 'string'
            values: [
              'string'
            ]
          }
        ]
        representations: [
          {
            contentType: 'string'
            examples: {
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any()
                  }
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any()
                  }
                }
                name: 'string'
                required: bool
                schemaId: 'string'
                type: 'string'
                typeName: 'string'
                values: [
                  'string'
                ]
              }
            ]
            schemaId: 'string'
            typeName: 'string'
          }
        ]
        statusCode: int
      }
    ]
    templateParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        examples: {
          {customized property}: {
            description: 'string'
            externalValue: 'string'
            summary: 'string'
            value: any()
          }
          {customized property}: {
            description: 'string'
            externalValue: 'string'
            summary: 'string'
            value: any()
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Eigenschaftswerte

service/workspaces/apis/operations

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für ressource vom Typ: apis
properties Eigenschaften des Vorgangsvertrags. OperationContractProperties

OperationContractProperties

Name BESCHREIBUNG Wert
description Beschreibung des Vorgangs. Kann HTML-Formatierungstags umfassen. Zeichenfolge
displayName Vorgangsname. Zeichenfolge (erforderlich)
method Eine gültige HTTP-Vorgangsmethode. Typische Http-Methoden wie GET, PUT, POST, aber nicht nur darauf beschränkt. Zeichenfolge (erforderlich)
Richtlinien Vorgangsrichtlinien Zeichenfolge
request Eine Entität, die Anforderungsdetails enthält. RequestContract
responses Array von Vorgangsantworten. ResponseContract[]
templateParameters Sammlung von URL-Vorlagenparametern. ParameterContract[]
urlTemplate Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} Zeichenfolge (erforderlich)

RequestContract

Name BESCHREIBUNG Wert
description Vorgangsanforderungsbeschreibung. Zeichenfolge
headers Auflistung der Vorgangsanforderungsheader. ParameterContract[]
queryParameters Auflistung der Vorgangsanforderungs-Abfrageparameter. ParameterContract[]
representations Die Sammlung von Vorgangsanforderungsdarstellungen. RepresentationContract[]

ParameterContract

Name BESCHREIBUNG Wert
defaultValue Standardparameterwert. Zeichenfolge
description Beschreibung des Parameters. Zeichenfolge
Beispiele Beispiel, das für den Parameter definiert ist. ParameterExamplesContract
name Parametername. Zeichenfolge (erforderlich)
Erforderlich Gibt an, ob der Parameter erforderlich ist oder nicht. bool
schemaId Schemabezeichner. Zeichenfolge
type Der Parametertyp. Zeichenfolge (erforderlich)
typeName Geben Sie den vom Schema definierten Namen ein. Zeichenfolge
Werte Parameterwerte. string[]

ParameterExamplesContract

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} ParameterExampleContract
{angepasste Eigenschaft} ParameterExampleContract

ParameterExampleContract

Name BESCHREIBUNG Wert
description Lange Beschreibung für das Beispiel Zeichenfolge
externalValue Eine URL, die auf das Literalbeispiel verweist Zeichenfolge
Zusammenfassung Kurzbeschreibung für das Beispiel Zeichenfolge
value Beispielwert. Kann ein primitiver Wert oder ein Objekt sein. Für Bicep können Sie die funktion any() verwenden.

RepresentationContract

Name BESCHREIBUNG Wert
contentType Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml. Zeichenfolge (erforderlich)
Beispiele Beispiel, das für die Darstellung definiert ist. ParameterExamplesContract
formParameters Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist. ParameterContract[]
schemaId Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist. Zeichenfolge
typeName Geben Sie den vom Schema definierten Namen ein. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist. Zeichenfolge

ResponseContract

Name BESCHREIBUNG Wert
description Vorgangsantwortbeschreibung. Zeichenfolge
headers Sammlung von Vorgangsantwortheadern. ParameterContract[]
representations Die Sammlung von Vorgangsantwortdarstellungen. RepresentationContract[]
statusCode Vorgangsantwort HTTP-status Code. int (erforderlich)

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp service/workspaces/apis/operations kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.ApiManagement/service/workspaces/apis/operations zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.ApiManagement/service/workspaces/apis/operations",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "method": "string",
    "policies": "string",
    "request": {
      "description": "string",
      "headers": [
        {
          "defaultValue": "string",
          "description": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "name": "string",
          "required": "bool",
          "schemaId": "string",
          "type": "string",
          "typeName": "string",
          "values": [ "string" ]
        }
      ],
      "queryParameters": [
        {
          "defaultValue": "string",
          "description": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "name": "string",
          "required": "bool",
          "schemaId": "string",
          "type": "string",
          "typeName": "string",
          "values": [ "string" ]
        }
      ],
      "representations": [
        {
          "contentType": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{customized property}": {
                  "description": "string",
                  "externalValue": "string",
                  "summary": "string",
                  "value": {}
                },
                "{customized property}": {
                  "description": "string",
                  "externalValue": "string",
                  "summary": "string",
                  "value": {}
                }
              },
              "name": "string",
              "required": "bool",
              "schemaId": "string",
              "type": "string",
              "typeName": "string",
              "values": [ "string" ]
            }
          ],
          "schemaId": "string",
          "typeName": "string"
        }
      ]
    },
    "responses": [
      {
        "description": "string",
        "headers": [
          {
            "defaultValue": "string",
            "description": "string",
            "examples": {
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              },
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "name": "string",
            "required": "bool",
            "schemaId": "string",
            "type": "string",
            "typeName": "string",
            "values": [ "string" ]
          }
        ],
        "representations": [
          {
            "contentType": "string",
            "examples": {
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              },
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{customized property}": {
                    "description": "string",
                    "externalValue": "string",
                    "summary": "string",
                    "value": {}
                  },
                  "{customized property}": {
                    "description": "string",
                    "externalValue": "string",
                    "summary": "string",
                    "value": {}
                  }
                },
                "name": "string",
                "required": "bool",
                "schemaId": "string",
                "type": "string",
                "typeName": "string",
                "values": [ "string" ]
              }
            ],
            "schemaId": "string",
            "typeName": "string"
          }
        ],
        "statusCode": "int"
      }
    ],
    "templateParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "examples": {
          "{customized property}": {
            "description": "string",
            "externalValue": "string",
            "summary": "string",
            "value": {}
          },
          "{customized property}": {
            "description": "string",
            "externalValue": "string",
            "summary": "string",
            "value": {}
          }
        },
        "name": "string",
        "required": "bool",
        "schemaId": "string",
        "type": "string",
        "typeName": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Eigenschaftswerte

service/workspaces/apis/operations

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.ApiManagement/service/workspaces/apis/operations"
apiVersion Die Version der Ressourcen-API "2023-05-01-preview"
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)
properties Eigenschaften des Vorgangsvertrags. OperationContractProperties

OperationContractProperties

Name BESCHREIBUNG Wert
description Beschreibung des Vorgangs. Kann HTML-Formatierungstags umfassen. Zeichenfolge
displayName Vorgangsname. Zeichenfolge (erforderlich)
method Eine gültige HTTP-Vorgangsmethode. Typische Http-Methoden wie GET, PUT, POST, aber nicht nur darauf beschränkt. Zeichenfolge (erforderlich)
Richtlinien Vorgangsrichtlinien Zeichenfolge
request Eine Entität, die Anforderungsdetails enthält. RequestContract
responses Array von Vorgangsantworten. ResponseContract[]
templateParameters Sammlung von URL-Vorlagenparametern. ParameterContract[]
urlTemplate Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} Zeichenfolge (erforderlich)

RequestContract

Name BESCHREIBUNG Wert
description Vorgangsanforderungsbeschreibung. Zeichenfolge
headers Auflistung der Vorgangsanforderungsheader. ParameterContract[]
queryParameters Auflistung der Vorgangsanforderungs-Abfrageparameter. ParameterContract[]
representations Die Sammlung von Vorgangsanforderungsdarstellungen. RepresentationContract[]

ParameterContract

Name BESCHREIBUNG Wert
defaultValue Standardparameterwert. Zeichenfolge
description Beschreibung des Parameters. Zeichenfolge
Beispiele Beispiel, das für den Parameter definiert ist. ParameterExamplesContract
name Parametername. Zeichenfolge (erforderlich)
Erforderlich Gibt an, ob der Parameter erforderlich ist oder nicht. bool
schemaId Schemabezeichner. Zeichenfolge
type Der Parametertyp. Zeichenfolge (erforderlich)
typeName Typname, der durch das Schema definiert wird. Zeichenfolge
Werte Parameterwerte. string[]

ParameterExamplesContract

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} ParameterExampleContract
{angepasste Eigenschaft} ParameterExampleContract

ParameterExampleContract

Name BESCHREIBUNG Wert
description Lange Beschreibung für das Beispiel Zeichenfolge
externalValue Eine URL, die auf das Literalbeispiel verweist Zeichenfolge
Zusammenfassung Kurze Beschreibung für das Beispiel Zeichenfolge
value Beispielwert. Kann ein primitiver Wert oder ein Objekt sein.

RepresentationContract

Name BESCHREIBUNG Wert
contentType Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml. Zeichenfolge (erforderlich)
Beispiele Beispiel, das für die Darstellung definiert ist. ParameterExamplesContract
formParameters Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist. ParameterContract[]
schemaId Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist. Zeichenfolge
typeName Typname, der durch das Schema definiert wird. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist. Zeichenfolge

ResponseContract

Name BESCHREIBUNG Wert
description Vorgangsantwortbeschreibung. Zeichenfolge
headers Auflistung von Vorgangsantwortheadern. ParameterContract[]
representations Die Sammlung von Vorgangsantwortdarstellungen. RepresentationContract[]
statusCode Vorgangsantwort HTTP status Code. int (erforderlich)

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp service/workspaces/apis/operations kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/workspaces/apis/operations-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/apis/operations@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      method = "string"
      policies = "string"
      request = {
        description = "string"
        headers = [
          {
            defaultValue = "string"
            description = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        queryParameters = [
          {
            defaultValue = "string"
            description = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                examples = {
                  {customized property} = {
                    description = "string"
                    externalValue = "string"
                    summary = "string"
                  }
                  {customized property} = {
                    description = "string"
                    externalValue = "string"
                    summary = "string"
                  }
                }
                name = "string"
                required = bool
                schemaId = "string"
                type = "string"
                typeName = "string"
                values = [
                  "string"
                ]
              }
            ]
            schemaId = "string"
            typeName = "string"
          }
        ]
      }
      responses = [
        {
          description = "string"
          headers = [
            {
              defaultValue = "string"
              description = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
              }
              name = "string"
              required = bool
              schemaId = "string"
              type = "string"
              typeName = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
              }
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  examples = {
                    {customized property} = {
                      description = "string"
                      externalValue = "string"
                      summary = "string"
                    }
                    {customized property} = {
                      description = "string"
                      externalValue = "string"
                      summary = "string"
                    }
                  }
                  name = "string"
                  required = bool
                  schemaId = "string"
                  type = "string"
                  typeName = "string"
                  values = [
                    "string"
                  ]
                }
              ]
              schemaId = "string"
              typeName = "string"
            }
          ]
          statusCode = int
        }
      ]
      templateParameters = [
        {
          defaultValue = "string"
          description = "string"
          examples = {
            {customized property} = {
              description = "string"
              externalValue = "string"
              summary = "string"
            }
            {customized property} = {
              description = "string"
              externalValue = "string"
              summary = "string"
            }
          }
          name = "string"
          required = bool
          schemaId = "string"
          type = "string"
          typeName = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Eigenschaftswerte

service/workspaces/apis/operations

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/workspaces/apis/operations@2023-05-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: apis
properties Eigenschaften des Vorgangsvertrags. OperationContractProperties

OperationContractProperties

Name BESCHREIBUNG Wert
description Beschreibung des Vorgangs. Kann HTML-Formatierungstags umfassen. Zeichenfolge
displayName Vorgangsname. Zeichenfolge (erforderlich)
method Eine gültige HTTP-Vorgangsmethode. Typische Http-Methoden wie GET, PUT, POST, aber nicht nur darauf beschränkt. Zeichenfolge (erforderlich)
Richtlinien Vorgangsrichtlinien Zeichenfolge
request Eine Entität, die Anforderungsdetails enthält. RequestContract
responses Array von Vorgangsantworten. ResponseContract[]
templateParameters Sammlung von URL-Vorlagenparametern. ParameterContract[]
urlTemplate Relative URL-Vorlage, die die Zielressource für diesen Vorgang identifiziert. Kann Parameter enthalten. Beispiel: /customers/{cid}/orders/{oid}/?date={date} Zeichenfolge (erforderlich)

RequestContract

Name BESCHREIBUNG Wert
description Vorgangsanforderungsbeschreibung. Zeichenfolge
headers Auflistung der Vorgangsanforderungsheader. ParameterContract[]
queryParameters Auflistung der Vorgangsanforderungs-Abfrageparameter. ParameterContract[]
representations Die Sammlung von Vorgangsanforderungsdarstellungen. RepresentationContract[]

ParameterContract

Name BESCHREIBUNG Wert
defaultValue Standardparameterwert. Zeichenfolge
description Beschreibung des Parameters. Zeichenfolge
Beispiele Beispiel, das für den Parameter definiert ist. ParameterExamplesContract
name Parametername. Zeichenfolge (erforderlich)
Erforderlich Gibt an, ob der Parameter erforderlich ist oder nicht. bool
schemaId Schemabezeichner. Zeichenfolge
type Der Parametertyp. Zeichenfolge (erforderlich)
typeName Typname, der durch das Schema definiert wird. Zeichenfolge
Werte Parameterwerte. string[]

ParameterExamplesContract

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} ParameterExampleContract
{angepasste Eigenschaft} ParameterExampleContract

ParameterExampleContract

Name BESCHREIBUNG Wert
description Lange Beschreibung für das Beispiel Zeichenfolge
externalValue Eine URL, die auf das Literalbeispiel verweist Zeichenfolge
Zusammenfassung Kurze Beschreibung für das Beispiel Zeichenfolge
value Beispielwert. Kann ein primitiver Wert oder ein Objekt sein.

RepresentationContract

Name BESCHREIBUNG Wert
contentType Gibt einen registrierten oder benutzerdefinierten Inhaltstyp für diese Darstellung an, z. B. application/xml. Zeichenfolge (erforderlich)
Beispiele Beispiel, das für die Darstellung definiert ist. ParameterExamplesContract
formParameters Sammlung von Formularparametern. Erforderlich, wenn der Wert "contentType" entweder "application/x-www-form-urlencoded" oder "multipart/form-data" ist. ParameterContract[]
schemaId Schemabezeichner. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist. Zeichenfolge
typeName Typname, der durch das Schema definiert wird. Gilt nur, wenn der Wert "contentType" weder "application/x-www-form-urlencoded" noch "multipart/form-data" ist. Zeichenfolge

ResponseContract

Name BESCHREIBUNG Wert
description Vorgangsantwortbeschreibung. Zeichenfolge
headers Auflistung von Vorgangsantwortheadern. ParameterContract[]
representations Die Sammlung von Vorgangsantwortdarstellungen. RepresentationContract[]
statusCode Vorgangsantwort HTTP status Code. int (erforderlich)