GitBook Glossary API

openapi: 3.2.0
info:
  title: GitBook Glossary API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:
- name: Glossary
  x-page-title: Glossary
  x-page-description: Manage custom terms translations used by the translation feature.
  x-parent: translations
  description: 'Define terms and specify their translations for different languages to ensure consistent wording.


    {% openapi-schemas spec="gitbook" schemas="GlossaryEntry" grouped="false" %}

    The GlossaryEntry object

    {% endopenapi-schemas %}'
paths:
  /orgs/{organizationId}/translations-glossary:
    get:
      operationId: listGlossaryEntries
      summary: List glossary entries
      tags:
      - Glossary
      security:
      - user: []
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/listPage'
      - $ref: '#/components/parameters/listLimit'
      - name: orderBy
        in: query
        description: Sort results by language key
        schema:
          $ref: '#/components/schemas/TranslationLanguage'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/List'
                - type: object
                  required:
                  - items
                  properties:
                    items:
                      type: array
                      items:
                        $ref: '#/components/schemas/GlossaryEntry'
    put:
      operationId: updateGlossaryEntries
      summary: Update glossary entries
      tags:
      - Glossary
      security:
      - user: []
      parameters:
      - $ref: '#/components/parameters/organizationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                operations:
                  type: array
                  items:
                    $ref: '#/components/schemas/GlossaryBatchOperation'
              required:
              - operations
      responses:
        '204':
          description: Glossary entries updated
        '400':
          $ref: '#/components/responses/BadRequestError'
  /orgs/{organizationId}/translations-glossary/{glossaryEntryId}:
    get:
      operationId: getGlossaryEntry
      summary: Get a glossary entry by its ID
      tags:
      - Glossary
      security:
      - user: []
      parameters:
      - $ref: '#/components/parameters/organizationId'
      - $ref: '#/components/parameters/glossaryEntryId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlossaryEntry'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  responses:
    NotFoundError:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    enum:
                    - 404
                  message:
                    type: string
                required:
                - code
                - message
    BadRequestError:
      description: Bad Request
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                    enum:
                    - 400
                  message:
                    type: string
                required:
                - code
                - message
  schemas:
    GlossaryBatchOperation:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - insert
          translations:
            $ref: '#/components/schemas/GlossaryTranslations'
        required:
        - type
        - translations
      - type: object
        properties:
          type:
            type: string
            enum:
            - update
          id:
            type: string
          translations:
            $ref: '#/components/schemas/GlossaryTranslations'
        required:
        - type
        - id
        - translations
      - type: object
        properties:
          type:
            type: string
            enum:
            - delete
          id:
            type: string
        required:
        - type
        - id
    List:
      type: object
      properties:
        next:
          type: object
          properties:
            page:
              type: string
              description: Unique identifier to query the next results page
          required:
          - page
        count:
          type: number
          description: Total count of objects in the list
    EntityId:
      type: string
      pattern: ^[a-zA-Z0-9_-]+$
      description: A unique entity identifier
    GlossaryTranslations:
      type: object
      additionalProperties:
        type: string
        minLength: 1
        maxLength: 255
        pattern: ^[^\n\r]*$
      description: Mapping of language codes to translated terms
    GlossaryEntry:
      type: object
      properties:
        object:
          type: string
          enum:
          - glossary-entry
        id:
          type: string
          description: Unique identifier of the glossary entry
        translations:
          $ref: '#/components/schemas/GlossaryTranslations'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        urls:
          type: object
          properties:
            location:
              type: string
              format: uri
              description: URL of the glossary entry in the API
          required:
          - location
      required:
      - object
      - id
      - translations
      - createdAt
      - updatedAt
      - urls
    TranslationLanguage:
      type: string
      enum:
      - en
      - fr
      - de
      - es
      - it
      - pt
      - pt-br
      - ru
      - ja
      - zh
      - zh-tw
      - yue
      - ko
      - ar
      - hi
      - nl
      - pl
      - tr
      - sv
      - 'no'
      - da
      - fi
      - el
      - cs
      - hu
      - ro
      - th
      - vi
      - id
      - ms
      - he
      - uk
      - sk
      - bg
      - hr
      - lt
      - lv
      - et
      - sl
      - fr-ca
      - es-mx
      - es-419
  parameters:
    glossaryEntryId:
      name: glossaryEntryId
      in: path
      required: true
      description: The unique id of the glossary entry
      schema:
        type: string
    listPage:
      name: page
      in: query
      description: Identifier of the page results to fetch.
      schema:
        type: string
    listLimit:
      name: limit
      in: query
      description: The number of results per page
      schema:
        type: number
        minimum: 0
        maximum: 1000
    organizationId:
      name: organizationId
      in: path
      required: true
      description: The unique id of the organization
      schema:
        $ref: '#/components/schemas/EntityId'
  securitySchemes:
    user:
      type: http
      scheme: bearer
    user-internal:
      type: http
      scheme: bearer
    user-staff:
      type: http
      scheme: bearer
    integration:
      type: http
      scheme: bearer
    integration-installation:
      type: http
      scheme: bearer
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://oauth.gitbook.com/authorize
          tokenUrl: https://oauth.gitbook.com/token
          scopes:
            user:read: Read your GitBook user profile.
            organization:read: Read the organizations you belong to, their settings and metadata, and their AI agent conversations.
            organization:write: Create organizations, and update organization settings and AI agent conversations.
            organization:members:read: Read organization members, teams, invites and link invites.
            organization:members:write: Manage organization members, teams, invites and link invites.
            organization:ask: Ask AI questions across an organization's content.
            organization:search: Search across an organization's content.
            space:read: Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.
            space:write: Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.
            space:permissions:read: Read the users and teams who have access to spaces and collections.
            space:permissions:write: Manage who has access to spaces and collections, including inviting users and teams.
            change-request:merge: Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.
            site:read: Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.
            site:write: Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.
            site:publish: Publish and unpublish sites, controlling their public exposure.
            site:permissions:read: Read the users and teams who have access to sites.
            site:permissions:write: Manage who has access to sites, including inviting users and teams.
            site:auth:read: Read how visitors authenticate on a site and its security configuration, including private share links.
            site:auth:write: Manage how visitors authenticate on a site and its security configuration, including private share links.
            site:insights:read: Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.
            site:ask: Ask AI questions across a site's content.
            site:search: Search across a site's content.
            integration:read: Read integrations, their status and where they are installed.
            integration:installations:read: Read integration installations and their configuration, which can include credentials for third-party services.
            integration:installations:write: Install and configure integrations on an organization, its spaces and its sites.
            integration:publish: Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.
            integration:delete: Unpublish integrations, permanently deleting them and every installation of them.
            openapi:read: Read OpenAPI specifications.
            openapi:write: Create, update and delete OpenAPI specifications.
x-provenance:
  method: harvested
  publisher: GitBook
  source: https://api.gitbook.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)