schemas.v1.1.operationObject.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-compat-spec-parser Show documentation

There is a newer version: 1.0.71

Show newest version

{
  "id": "http://swagger-api.github.io/schemas/v1.1/operationObject.json#",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "required": [
    "httpMethod",
    "nickname",
    "parameters"
  ],
  "properties": {
    "httpMethod": {
      "enum": [
        "GET",
        "POST",
        "PUT",
        "PATCH",
        "DELETE",
        "OPTIONS"
      ]
    },
    "summary": {
      "type": "string",
      "maxLength": 120
    },
    "notes": {
      "type": "string"
    },
    "nickname": {
      "type": "string",
      "pattern": "^[a-zA-Z0-9_]+$"
    },
    "parameters": {
      "type": "array",
      "items": {
        "$ref": "parameterObject.json#"
      }
    },
    "errorResponse": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/errorResponse"
      }
    },
    "deprecated": {
      "enum": [
        "true",
        "false"
      ]
    }
  },
  "definitions": {
    "errorResponse": {
      "type": "object",
      "required": [
        "code",
        "reason"
      ],
      "properties": {
        "code": {
          "$ref": "#/definitions/rfc2616section10"
        },
        "response": {
          "type": "string"
        }
      }
    },
    "rfc2616section10": {
      "type": "integer",
      "minimum": 100,
      "maximum": 600,
      "exclusiveMaximum": true
    }
  }
}