drupal Taxonomy Vocabularies API

openapi: 3.2.0
info:
  title: Drupal REST Taxonomy Vocabularies API
  description: The Drupal RESTful Web Services API is a core module that exposes Drupal entities and data as REST resources over HTTP.
  version: '1.0'
  contact:
    name: Drupal Community
    url: https://www.drupal.org/community
  termsOfService: https://www.drupal.org/about/legal
servers:
- url: https://example.com
  description: Drupal Site (replace with your Drupal installation base URL)
security:
- basicAuth: []
- cookieAuth: []
tags:
- name: Taxonomy Vocabularies
  description: Taxonomy vocabulary resources representing the container configurations that organize sets of taxonomy terms.
paths:
  /taxonomy/vocabulary/{id}:
    get:
      operationId: getTaxonomyVocabulary
      summary: Get a taxonomy vocabulary
      description: Retrieves a single taxonomy vocabulary configuration entity by its machine name ID. Returns the vocabulary name, description, and hierarchy settings.
      tags:
      - Taxonomy Vocabularies
      parameters:
      - $ref: '#/components/parameters/EntityId'
      - $ref: '#/components/parameters/AcceptFormat'
      responses:
        '200':
          description: Taxonomy vocabulary returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxonomyVocabulary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response returned for 4xx HTTP error codes.
      properties:
        message:
          type: string
          description: Human-readable description of the error.
    IntegerValue:
      type: object
      description: Drupal field value wrapper for an integer value.
      properties:
        value:
          type: integer
          description: The integer value.
    StringValue:
      type: object
      description: Drupal field value wrapper for a string value.
      properties:
        value:
          type: string
          description: The string value.
    TaxonomyVocabulary:
      type: object
      description: A Drupal taxonomy vocabulary configuration entity that defines a grouping container for taxonomy terms.
      properties:
        vid:
          type: array
          description: The machine name identifier of the vocabulary.
          items:
            $ref: '#/components/schemas/StringValue'
        uuid:
          type: array
          description: The universally unique identifier of the vocabulary.
          items:
            $ref: '#/components/schemas/StringValue'
        name:
          type: array
          description: The human-readable name of the vocabulary.
          items:
            $ref: '#/components/schemas/StringValue'
        description:
          type: array
          description: Optional description of the vocabulary and its purpose.
          items:
            $ref: '#/components/schemas/StringValue'
        hierarchy:
          type: array
          description: Hierarchy setting. 0 for no hierarchy, 1 for single hierarchy, 2 for multiple hierarchy.
          items:
            $ref: '#/components/schemas/IntegerValue'
  responses:
    NotFound:
      description: The requested entity does not exist or is not accessible.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication is required to access this resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    EntityId:
      name: id
      in: path
      required: true
      description: The numeric ID of the entity.
      schema:
        type: integer
        minimum: 1
    AcceptFormat:
      name: Accept
      in: header
      required: false
      description: The desired response serialization format. Defaults to application/json. Use application/hal+json for HAL+JSON hypermedia format.
      schema:
        type: string
        enum:
        - application/json
        - application/hal+json
        - application/xml
        default: application/json
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Drupal username and password.
    cookieAuth:
      type: apiKey
      in: cookie
      name: SESS
      description: Cookie-based session authentication obtained via Drupal login. The session cookie is returned after a successful login request.
    oAuth2:
      type: oauth2
      description: OAuth 2.0 authentication via the Simple OAuth module.
      flows:
        authorizationCode:
          authorizationUrl: https://example.com/oauth/authorize
          tokenUrl: https://example.com/oauth/token
          scopes:
            content: Access and manage content entities
            user: Access and manage user entities
externalDocs:
  description: Drupal RESTful Web Services API Documentation
  url: https://www.drupal.org/docs/drupal-apis/restful-web-services-api/restful-web-services-api-overview