Microsoft.ApiManagement service/apis/operations 2022-09-01-preview

تعريف مورد Bicep

يمكن توزيع نوع مورد الخدمة/apis/العمليات مع العمليات التي تستهدف:

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/apis/operations، أضف Bicep التالي إلى القالب الخاص بك.

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2022-09-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'
  }
}

قيم Property

الخدمة/apis/العمليات

الاسم الوصف القيمة
الاسم اسم المورد

تعرف على كيفية تعيين الأسماء والأنواع للموارد التابعة في Bicep.
سلسلة (مطلوبة)

حد الأحرف: 1-80

الأحرف الصالحة:
الأبجدية الرقمية والواصلات.

يبدأ بالحرف وينتهي بالأبجدية الرقمية.
أصل في Bicep، يمكنك تحديد المورد الأصل لمورد تابع. تحتاج فقط إلى إضافة هذه الخاصية عند الإعلان عن المورد التابع خارج المورد الأصل.

لمزيد من المعلومات، راجع المورد التابع خارج المورد الأصل.
اسم رمزي لمورد من النوع: apis
خصائص خصائص عقد العملية. OperationContractProperties

OperationContractProperties

الاسم الوصف القيمة
الوصف وصف العملية. قد تتضمن علامات تنسيق HTML. سلسلة
اسم المستخدم اسم العملية. سلسلة (مطلوبة)
أسلوب أسلوب عملية HTTP صالح. أساليب Http النموذجية مثل GET وPUT وPOST ولكن لا تقتصر عليها فقط. سلسلة (مطلوبة)
النُهُج نهج العملية سلسلة
طلب كيان يحتوي على تفاصيل الطلب. طلب Contract
الاستجابات صفيف استجابات العملية. ResponseContract[]
معلمات القالب مجموعة من معلمات قالب URL. ParameterContract[]
urlTemplate قالب عنوان URL نسبي يحدد المورد المستهدف لهذه العملية. قد تتضمن معلمات. مثال: /customers/{cid}/orders/{oid}/?date={date} سلسلة (مطلوبة)

طلب Contract

الاسم الوصف القيمة
الوصف وصف طلب العملية. سلسلة
الرؤوس مجموعة من عناوين طلب العملية. ParameterContract[]
queryParameters مجموعة من معلمات استعلام طلب العملية. ParameterContract[]
تمثيلات مجموعة من تمثيلات طلب العملية. التمثيلContract[]

ParameterContract

الاسم الوصف القيمة
القيمة الظاهرية قيمة المعلمة الافتراضية. سلسلة
الوصف وصف المعلمة. سلسلة
امثله مثال معرف للمعلمة . ParameterExamplesContract
الاسم اسم المعلمة. سلسلة (مطلوبة)
مطلوب تحديد ما إذا كانت المعلمة مطلوبة أم لا. Bool
معرف المخطط معرف المخطط. سلسلة
النوع نوع المعلمة. سلسلة (مطلوبة)
Typename اكتب اسما معرفا بواسطة المخطط. سلسلة
القيم قيم المعلمات. سلسلة []

ParameterExamplesContract

الاسم الوصف القيمة
{خاصية مخصصة} ParameterExampleContract
{خاصية مخصصة} ParameterExampleContract

ParameterExampleContract

الاسم الوصف القيمة
الوصف وصف طويل للمثال سلسلة
قيمة خارجية عنوان URL يشير إلى المثال الحرفي سلسلة
الملخص وصف مختصر للمثال سلسلة
القيمة مثال على القيمة. قد تكون قيمة بدائية أو كائنا. بالنسبة إلى Bicep، يمكنك استخدام الدالة any().

تكديس التمثيل

الاسم الوصف القيمة
نوع المحتوى يحدد نوع محتوى مسجلا أو مخصصا لهذا التمثيل، على سبيل المثال application/xml. سلسلة (مطلوبة)
امثله مثال معرف للتمثيل. ParameterExamplesContract
formParameters مجموعة معلمات النموذج. مطلوب إذا كانت قيمة 'contentType' إما 'application/x-www-form-urlencoded' أو 'multipart/form-data'.. ParameterContract[]
معرف المخطط معرف المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. سلسلة
Typename اكتب اسما معرفا بواسطة المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. سلسلة

ResponseContract

الاسم الوصف القيمة
الوصف وصف استجابة العملية. سلسلة
الرؤوس مجموعة من عناوين استجابة العملية. ParameterContract[]
تمثيلات مجموعة من تمثيلات استجابة العملية. التمثيلContract[]
statusCode رمز حالة HTTP للاستجابة للعملية. int (مطلوب)

تعريف مورد قالب ARM

يمكن توزيع نوع مورد الخدمة/apis/العمليات مع العمليات التي تستهدف:

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/apis/operations، أضف JSON التالي إلى القالب الخاص بك.

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2022-09-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"
  }
}

قيم Property

الخدمة/apis/العمليات

الاسم الوصف القيمة
النوع نوع المورد 'Microsoft.ApiManagement/service/apis/operations'
apiVersion إصدار واجهة برمجة تطبيقات المورد 'معاينة 2022-09-01'
الاسم اسم المورد

تعرف على كيفية تعيين الأسماء والأنواع للموارد التابعة في قوالب JSON ARM.
سلسلة (مطلوب)

حد الحرف: 1-80

أحرف صالحة:
الأبجدية الرقمية والواصلات.

يبدأ بالحرف وينتهي بالأبجدية الرقمية.
خصائص خصائص عقد العملية. OperationContractProperties

OperationContractProperties

الاسم الوصف القيمة
الوصف وصف العملية. قد تتضمن علامات تنسيق HTML. سلسلة
اسم المستخدم اسم العملية. سلسلة (مطلوب)
أسلوب أسلوب عملية HTTP صالح. أساليب Http النموذجية مثل GET و PUT و POST ولكن لا تقتصر عليها فقط. سلسلة (مطلوب)
النُهُج نهج العملية سلسلة
طلب كيان يحتوي على تفاصيل الطلب. طلب التعاقد
الاستجابات صفيف استجابات العملية. ResponseContract[]
templateParameters مجموعة من معلمات قالب URL. ParameterContract[]
urlTemplate قالب عنوان URL نسبي يحدد المورد المستهدف لهذه العملية. قد تتضمن معلمات. مثال: /customers/{cid}/orders/{oid}/?date={date} سلسلة (مطلوب)

طلب التعاقد

الاسم الوصف القيمة
الوصف وصف طلب العملية. سلسلة
الرؤوس مجموعة من عناوين طلب العملية. ParameterContract[]
queryParameters مجموعة من معلمات استعلام طلب العملية. ParameterContract[]
تمثيلات مجموعة من تمثيلات طلب العملية. تمثيلContract[]

ParameterContract

الاسم الوصف القيمة
القيمة الظاهرية قيمة المعلمة الافتراضية. سلسلة
الوصف وصف المعلمة. سلسلة
امثله مثال معرف للمعلمة . ParameterExamplesContract
الاسم اسم المعلمة. سلسلة (مطلوب)
مطلوب تحديد ما إذا كانت المعلمة مطلوبة أم لا. Bool
معرف المخطط معرف المخطط. سلسلة
النوع نوع المعلمة. سلسلة (مطلوب)
Typename اكتب الاسم المحدد بواسطة المخطط. سلسلة
القيم قيم المعلمات. سلسلة []

ParameterExamplesContract

الاسم الوصف القيمة
{خاصية مخصصة} ParameterExampleContract
{خاصية مخصصة} ParameterExampleContract

ParameterExampleContract

الاسم الوصف القيمة
الوصف وصف طويل للمثال سلسلة
القيمة الخارجية عنوان URL يشير إلى المثال الحرفي سلسلة
الملخص وصف مختصر للمثال سلسلة
القيمة مثال على القيمة. قد تكون قيمة بدائية أو كائن.

تم التعاقد على التمثيل

الاسم الوصف القيمة
نوع المحتوى يحدد نوع محتوى مسجلا أو مخصصا لهذا التمثيل، على سبيل المثال application/xml. سلسلة (مطلوب)
امثله مثال معرف للتمثيل. ParameterExamplesContract
formParameters مجموعة من معلمات النموذج. مطلوب إذا كانت قيمة 'contentType' إما 'application/x-www-form-urlencoded' أو 'multipart/form-data'.. ParameterContract[]
معرف المخطط معرف المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. سلسلة
Typename اكتب الاسم المحدد بواسطة المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. سلسلة

ResponseContract

الاسم الوصف القيمة
الوصف وصف استجابة العملية. سلسلة
الرؤوس مجموعة من رؤوس استجابة العملية. ParameterContract[]
تمثيلات مجموعة من تمثيلات استجابة العملية. تمثيلContract[]
statusCode رمز حالة HTTP للاستجابة للعملية. int (مطلوب)

تعريف مورد Terraform (موفر AzAPI)

يمكن نشر نوع مورد الخدمة/apis/العمليات مع العمليات التي تستهدف:

  • مجموعات الموارد

للحصول على قائمة بالخصائص التي تم تغييرها في كل إصدار من إصدارات واجهة برمجة التطبيقات، راجع سجل التغيير.

تنسيق المورد

لإنشاء مورد Microsoft.ApiManagement/service/apis/operations، أضف Terraform التالي إلى القالب الخاص بك.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2022-09-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"
    }
  })
}

قيم Property

الخدمة/apis/العمليات

الاسم الوصف القيمة
النوع نوع المورد "Microsoft.ApiManagement/service/apis/operations@2022-09-01-preview"
الاسم اسم المورد سلسلة (مطلوب)

حد الحرف: 1-80

أحرف صالحة:
الأبجدية الرقمية والواصلات.

يبدأ بالحرف وينتهي بالأبجدية الرقمية.
parent_id معرف المورد الأصل لهذا المورد. معرف المورد من النوع: apis
خصائص خصائص عقد العملية. OperationContractProperties

OperationContractProperties

الاسم الوصف القيمة
الوصف وصف العملية. قد تتضمن علامات تنسيق HTML. سلسلة
اسم المستخدم اسم العملية. سلسلة (مطلوب)
أسلوب أسلوب عملية HTTP صالح. أساليب Http النموذجية مثل GET و PUT و POST ولكن لا تقتصر عليها فقط. سلسلة (مطلوب)
النُهُج نهج العملية سلسلة
طلب كيان يحتوي على تفاصيل الطلب. طلب التعاقد
الاستجابات صفيف استجابات العملية. ResponseContract[]
معلمات القالب مجموعة من معلمات قالب URL. ParameterContract[]
urlTemplate قالب عنوان URL نسبي يحدد المورد المستهدف لهذه العملية. قد تتضمن معلمات. مثال: /customers/{cid}/orders/{oid}/?date={date} سلسلة (مطلوبة)

طلب Contract

الاسم الوصف القيمة
الوصف وصف طلب العملية. سلسلة
الرؤوس مجموعة من عناوين طلب العملية. ParameterContract[]
queryParameters مجموعة من معلمات استعلام طلب العملية. ParameterContract[]
تمثيلات مجموعة من تمثيلات طلب العملية. التمثيلContract[]

ParameterContract

الاسم الوصف القيمة
القيمة الظاهرية قيمة المعلمة الافتراضية. سلسلة
الوصف وصف المعلمة. سلسلة
امثله مثال معرف للمعلمة . ParameterExamplesContract
الاسم اسم المعلمة. سلسلة (مطلوبة)
مطلوب تحديد ما إذا كانت المعلمة مطلوبة أم لا. Bool
معرف المخطط معرف المخطط. سلسلة
النوع نوع المعلمة. سلسلة (مطلوبة)
Typename اكتب اسما معرفا بواسطة المخطط. سلسلة
القيم قيم المعلمات. سلسلة []

ParameterExamplesContract

الاسم الوصف القيمة
{خاصية مخصصة} ParameterExampleContract
{خاصية مخصصة} ParameterExampleContract

ParameterExampleContract

الاسم الوصف القيمة
الوصف وصف طويل للمثال سلسلة
قيمة خارجية عنوان URL يشير إلى المثال الحرفي سلسلة
الملخص وصف مختصر للمثال سلسلة
القيمة مثال على القيمة. قد تكون قيمة بدائية أو كائنا.

تكديس التمثيل

الاسم الوصف القيمة
نوع المحتوى يحدد نوع محتوى مسجلا أو مخصصا لهذا التمثيل، على سبيل المثال application/xml. سلسلة (مطلوبة)
امثله مثال معرف للتمثيل. ParameterExamplesContract
formParameters مجموعة معلمات النموذج. مطلوب إذا كانت قيمة 'contentType' إما 'application/x-www-form-urlencoded' أو 'multipart/form-data'.. ParameterContract[]
معرف المخطط معرف المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. سلسلة
Typename اكتب اسما معرفا بواسطة المخطط. ينطبق فقط إذا كانت قيمة 'contentType' ليست 'application/x-www-form-urlencoded' ولا 'multipart/form-data'. سلسلة

ResponseContract

الاسم الوصف القيمة
الوصف وصف استجابة العملية. سلسلة
الرؤوس مجموعة من عناوين استجابة العملية. ParameterContract[]
تمثيلات مجموعة من تمثيلات استجابة العملية. التمثيلContract[]
statusCode رمز حالة HTTP للاستجابة للعملية. int (مطلوب)