@asyncapi/specs/definitions/3.1.0/APIKeyHTTPSecurityScheme.json

AsyncAPI schema versions

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://asyncapi.com/definitions/3.1.0/APIKeyHTTPSecurityScheme.json",
  "type": "object",
  "required": [ "type", "name", "in" ],
  "properties": {
    "description": {
      "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.",
      "type": "string"
    },
    "type": {
      "description": "The type of the security scheme.",
      "type": "string",
      "enum": [ "httpApiKey" ]
    },
    "in": {
      "description": "The location of the API key",
      "type": "string",
      "enum": [ "header", "query", "cookie" ]
    },
    "name": {
      "description": "The name of the header, query or cookie parameter to be used.",
      "type": "string"
    }
  },
  "patternProperties": {
    "^x-[\\w\\d\\.\\x2d_]+$": {
      "$ref": "http://asyncapi.com/definitions/3.1.0/specificationExtension.json"
    }
  },
  "additionalProperties": false,
  "example": {
    "$ref": "http://asyncapi.com/examples/3.1.0/APIKeyHTTPSecurityScheme.json"
  }
}