OpenAPI · Schema

OpenAPI Tag Object

Adds metadata to a single tag that is used by the Operation Object.

DocumentationRESTSpecification

Properties

Name Type Description
name string The name of the tag.
description string A description for the tag.
externalDocs object
View JSON Schema on GitHub

JSON Schema

openapi-tag.json Raw ↑ 
{
  "$id": "openapi-tag.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OpenAPI Tag Object",
  "description": "Adds metadata to a single tag that is used by the Operation Object.",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the tag."
    },
    "description": {
      "type": "string",
      "description": "A description for the tag."
    },
    "externalDocs": {
      "$ref": "openapi-external-documentation.json"
    }
  },
  "patternProperties": {
    "^x-": {}
  },
  "additionalProperties": false
}