メインコンテンツまでスキップ

Operationオブジェクト

パス上の単一の API オペレーションを記述します。

固定フィールド​

フィールド名タイプ説明
タグ[ string]API ドキュメント制御のタグのリスト。タグは、リソースまたはその他の修飾子ごとに操作を論理的にグループ化するために使用できます。
まとめstring操作の内容の短い概要。
説明string操作動作の詳細な説明。CommonMark 構文はリッチ テキスト表現に使用できます (MAY)。
外部ドキュメント外部ドキュメントオブジェクトこの操作に関する追加の外部ドキュメント。
操作IDstring操作を識別するために使用される一意の文字列。ID は、API で記述されているすべての操作の中で一意である必要があります。OperationId 値では大文字と小文字が区別されます。ツールとライブラリは操作を一意に識別するためにoperationIdを使用してもよい(MAY)。したがって、一般的なプログラミング命名規則に従うことが推奨される(RECOMMENDED)。
パラメーター[パラメータオブジェクト| 参照オブジェクト]この操作に適用できるパラメータのリスト。パラメータがPath Itemsですでに定義されている場合、新しい定義はそれをオーバーライドしますが、削除することはできません。リストには重複したパラメータを含めてはなりません。一意のパラメータは、名前と場所の組み合わせによって定義されます。リストは、参照オブジェクトを使用して、OpenAPI オブジェクトのコンポーネント/パラメータで定義されているパラメータにリンクできます。
リクエスト本文リクエスト本文オブジェクト| 参照オブジェクトこの操作に適用されるリクエスト本文。requestBodyは、HTTP 1.1 仕様RFC7231でリクエスト本文のセマンティクスが明示的に定義されている HTTP メソッドで完全にサポートされています。HTTP 仕様があいまいな他のケース ( GET、HEAD、DELETEなど) では、requestBodyが許可されますが、明確に定義されたセマンティクスがないため、可能であれば避けるべきです(SHOULD)。
反応応答オブジェクトこの操作の実行から返される可能性のある応答のリスト。
コールバックMap[ string,コールバック オブジェクト| 参照オブジェクト]親操作に関連する可能性のある帯域外コールバックのマップ。キーはコールバック オブジェクトの一意の識別子です。マップ内の各値は、API プロバイダーによって開始される可能性のあるリクエストと予期される応答を記述するコールバック オブジェクトです。
廃止されたbooleanこの操作を非推奨にすることを宣言します。消費者は、宣言された操作の使用を控えるべきです(SHOULD)。デフォルト値は ですfalse。
安全[セキュリティ要件の対象]この操作にどのセキュリティ メカニズムを使用できるかの宣言。値のリストには、使用できる代替セキュリティ要件オブジェクトが含まれています。リクエストを承認するには、セキュリティ要件オブジェクトのうち 1 つだけを満たす必要があります。セキュリティをオプションにするには、空のセキュリティ要件 ( {}) を配列に含めることができます。この定義は、宣言されたトップレベルをオーバーライドしますsecurity。最上位のセキュリティ宣言を削除するには、空の配列を使用できます。
サーバー[サーバーオブジェクト]この操作を処理するための代替serverアレイ。代替serverオブジェクトがパス項目オブジェクトまたはルート レベルで指定されている場合、この値によって上書きされます。

このオブジェクトは、仕様拡張機能を使用して拡張できます。

Operationオブジェクトの例​

{
  "tags": [
    "pet"
  ],
  "summary": "Updates a pet in the store with form data",
  "operationId": "updatePetWithForm",
  "parameters": [
    {
      "name": "petId",
      "in": "path",
      "description": "ID of pet that needs to be updated",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/x-www-form-urlencoded": {
        "schema": {
          "type": "object",
          "properties": {
            "name": {
              "description": "Updated name of the pet",
              "type": "string"
            },
            "status": {
              "description": "Updated status of the pet",
              "type": "string"
            }
          },
          "required": [
            "status"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Pet updated.",
      "content": {
        "application/json": {},
        "application/xml": {}
      }
    },
    "405": {
      "description": "Invalid input",
      "content": {
        "application/json": {},
        "application/xml": {}
      }
    }
  },
  "security": [
    {
      "petstore_auth": [
        "write:pets",
        "read:pets"
      ]
    }
  ]
}
tags:
  - pet
summary: Updates a pet in the store with form data
operationId: updatePetWithForm
parameters:
  - name: petId
    in: path
    description: ID of pet that needs to be updated
    required: true
    schema:
      type: string
requestBody:
  content:
    'application/x-www-form-urlencoded':
      schema:
        properties:
          name:
            description: Updated name of the pet
            type: string
          status:
            description: Updated status of the pet
            type: string
        required:
          - status
responses:
  '200':
    description: Pet updated.
    content:
      'application/json': { }
      'application/xml': { }
  '405':
    description: Invalid input
    content:
      'application/json': { }
      'application/xml': { }
security:
  - petstore_auth:
      - write:pets
      - read:pets