drupal

opencollection: 1.0.0
info:
  name: Drupal REST API
  version: '1.0'
request:
  auth:
    type: basic
    username: '{{username}}'
    password: '{{password}}'
items:
- info:
    name: Nodes
    type: folder
  items:
  - info:
      name: Get a node
      type: http
    http:
      method: GET
      url: https://example.com/node/:id
      headers:
      - name: Accept
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: 'Retrieves a single content node entity by its numeric ID. The response format depends on the Accept header supplied:
      JSON, HAL+JSON, or XML. Returns the node''s fields, metadata, and any configured display output.'
  - info:
      name: Update a node
      type: http
    http:
      method: PATCH
      url: https://example.com/node/:id
      headers:
      - name: Content-Type
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
      body:
        type: json
        data: '{}'
    docs: Updates an existing content node entity by its numeric ID. Only the fields included in the request body are modified.
      The caller must have edit permissions for the target node type. Requires authentication.
  - info:
      name: Delete a node
      type: http
    http:
      method: DELETE
      url: https://example.com/node/:id
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Permanently deletes a content node entity by its numeric ID. The caller must have delete permissions for the target
      node type. This operation cannot be undone. Requires authentication.
  - info:
      name: Create a node
      type: http
    http:
      method: POST
      url: https://example.com/node
      headers:
      - name: Content-Type
        value: ''
      body:
        type: json
        data: '{}'
    docs: Creates a new content node entity. The request body must include the content type (bundle), title, and any required
      fields. The caller must have create permissions for the specified node type. Requires authentication.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Get a user
      type: http
    http:
      method: GET
      url: https://example.com/user/:id
      headers:
      - name: Accept
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Retrieves a single user entity by its numeric ID. Returns the user's account fields and profile data. Anonymous
      users can retrieve basic information; additional fields require appropriate permissions.
  - info:
      name: Update a user
      type: http
    http:
      method: PATCH
      url: https://example.com/user/:id
      headers:
      - name: Content-Type
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
      body:
        type: json
        data: '{}'
    docs: Updates an existing user entity by its numeric ID. Only the fields included in the request body are modified. Users
      can update their own accounts; administrators can update any account. Requires authentication.
  - info:
      name: Delete a user
      type: http
    http:
      method: DELETE
      url: https://example.com/user/:id
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Permanently deletes a user account entity by its numeric ID. Only administrators with the appropriate permissions
      can delete user accounts. Requires authentication.
- info:
    name: Taxonomy Terms
    type: folder
  items:
  - info:
      name: Get a taxonomy term
      type: http
    http:
      method: GET
      url: https://example.com/taxonomy/term/:id
      headers:
      - name: Accept
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Retrieves a single taxonomy term entity by its numeric ID. Returns the term's name, vocabulary, description, and
      any additional fields configured on the term bundle.
  - info:
      name: Update a taxonomy term
      type: http
    http:
      method: PATCH
      url: https://example.com/taxonomy/term/:id
      headers:
      - name: Content-Type
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
      body:
        type: json
        data: '{}'
    docs: Updates an existing taxonomy term entity by its numeric ID. Only the fields included in the request body are modified.
      Requires taxonomy management permissions and authentication.
  - info:
      name: Delete a taxonomy term
      type: http
    http:
      method: DELETE
      url: https://example.com/taxonomy/term/:id
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Permanently deletes a taxonomy term entity by its numeric ID. Requires taxonomy management permissions and authentication.
  - info:
      name: Create a taxonomy term
      type: http
    http:
      method: POST
      url: https://example.com/taxonomy/term
      headers:
      - name: Content-Type
        value: ''
      body:
        type: json
        data: '{}'
    docs: Creates a new taxonomy term in a specified vocabulary. The request body must include the term name and target vocabulary.
      Requires taxonomy management permissions and authentication.
- info:
    name: Taxonomy Vocabularies
    type: folder
  items:
  - info:
      name: Get a taxonomy vocabulary
      type: http
    http:
      method: GET
      url: https://example.com/taxonomy/vocabulary/:id
      headers:
      - name: Accept
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Retrieves a single taxonomy vocabulary configuration entity by its machine name ID. Returns the vocabulary name,
      description, and hierarchy settings.
- info:
    name: Files
    type: folder
  items:
  - info:
      name: Get a file entity
      type: http
    http:
      method: GET
      url: https://example.com/file/:id
      headers:
      - name: Accept
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Retrieves a single file entity by its numeric ID. Returns metadata about the file including filename, MIME type,
      size, URI, and upload timestamps. Does not return the raw file binary; use the file URI to download the file.
  - info:
      name: Delete a file entity
      type: http
    http:
      method: DELETE
      url: https://example.com/file/:id
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Permanently deletes a file entity and its associated file from the Drupal file system by its numeric ID. Requires
      file management permissions and authentication.
- info:
    name: Comments
    type: folder
  items:
  - info:
      name: Get a comment
      type: http
    http:
      method: GET
      url: https://example.com/comment/:id
      headers:
      - name: Accept
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Retrieves a single comment entity by its numeric ID. Returns the comment body, author, timestamps, and the entity
      it is attached to. Anonymous users can read published comments.
  - info:
      name: Update a comment
      type: http
    http:
      method: PATCH
      url: https://example.com/comment/:id
      headers:
      - name: Content-Type
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
      body:
        type: json
        data: '{}'
    docs: Updates an existing comment entity by its numeric ID. Comment authors can edit their own comments within the configured
      edit window; administrators can edit any comment. Requires authentication.
  - info:
      name: Delete a comment
      type: http
    http:
      method: DELETE
      url: https://example.com/comment/:id
      params:
      - name: id
        value: ''
        type: path
        description: The numeric ID of the entity.
    docs: Permanently deletes a comment entity by its numeric ID. Requires comment administration permissions and authentication.
  - info:
      name: Create a comment
      type: http
    http:
      method: POST
      url: https://example.com/comment
      headers:
      - name: Content-Type
        value: ''
      body:
        type: json
        data: '{}'
    docs: Creates a new comment attached to a specified entity. The request body must include the comment body, target entity
      type, target entity ID, and field name. Requires comment posting permissions.
bundled: true