Google Docs Documents API

Operations on Google Docs documents

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-document-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-document-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-document-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-tab-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-tab-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-document-tab-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-body-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-structural-element-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-paragraph-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-paragraph-element-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-text-run-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-text-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-paragraph-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-document-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-named-styles-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-named-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-header-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-footer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-footnote-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-section-break-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-section-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-section-column-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-row-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-cell-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-cell-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-cell-border-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-cell-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-column-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-row-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-style-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-of-contents-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-table-range-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-batch-update-document-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-batch-update-document-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-write-control-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-range-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-end-of-segment-location-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-text-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-inline-image-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-inline-image-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-inline-sheets-chart-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-page-break-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-section-break-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-table-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-table-row-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-insert-table-column-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-content-range-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-footer-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-header-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-named-range-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-paragraph-bullets-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-positioned-object-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-table-column-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-delete-table-row-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-header-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-header-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-footer-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-footer-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-footnote-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-footnote-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-named-range-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-named-range-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-create-paragraph-bullets-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-replace-all-text-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-replace-all-text-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-replace-image-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-replace-named-range-content-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-document-style-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-paragraph-style-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-section-style-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-table-cell-style-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-table-column-properties-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-table-row-style-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-update-text-style-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-merge-table-cells-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-unmerge-table-cells-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-pin-table-header-rows-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-link-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-linked-content-reference-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-named-range-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-named-ranges-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-inline-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-inline-object-element-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-inline-object-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-embedded-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-embedded-object-border-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-image-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-positioned-object-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-positioned-object-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-positioned-object-positioning-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-crop-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-size-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-dimension-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-color-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-rgb-color-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-optional-color-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-weighted-font-family-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-paragraph-border-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-shading-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-background-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-tab-stop-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-tabs-criteria-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-nesting-level-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-list-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-list-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-bullet-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-auto-text-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-column-break-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-equation-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-horizontal-rule-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-page-break-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-footnote-reference-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-person-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-person-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-rich-link-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-rich-link-properties-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-sheets-chart-reference-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-substring-match-criteria-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-suggestions-view-mode-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/json-schema/google-docs-v1-error-schema.json

Other Resources

OpenAPI Specification

google-docs-documents-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Docs Documents API
  description: The Google Docs API lets you create, read, and edit Google Docs documents. You can use it to programmatically create and modify documents, apply formatting, insert content, and manage document structure including paragraphs, tables, headers, footers, and inline objects.
  version: v1
  termsOfService: https://developers.google.com/terms
  contact:
    name: Google
    url: https://developers.google.com/docs/api/support
  license:
    name: Creative Commons Attribution 4.0
    url: https://creativecommons.org/licenses/by/4.0/
  x-logo:
    url: https://www.gstatic.com/images/branding/product/2x/docs_48dp.png
servers:
- url: https://docs.googleapis.com
  description: Google Docs API production server
security:
- oauth2: []
tags:
- name: Documents
  description: Operations on Google Docs documents
paths:
  /v1/documents:
    post:
      operationId: docs.documents.create
      summary: Google Docs Create a Document
      description: Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored.
      tags:
      - Documents
      requestBody:
        description: The document to create. Only the title field is used.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDocumentRequest'
            examples:
              DocsDocumentsCreateRequestExample:
                summary: Default docs.documents.create request
                x-microcks-default: true
                value:
                  title: Example Title
      responses:
        '200':
          description: Successful response containing the newly created document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
              examples:
                DocsDocumentsCreate200Example:
                  summary: Default docs.documents.create 200 response
                  x-microcks-default: true
                  value:
                    documentId: '500123'
                    title: Example Title
                    tabs:
                    - childTabs: {}
                    revisionId: '500123'
                    suggestionsViewMode: DEFAULT_FOR_CURRENT_ACCESS
                    body:
                      content:
                      - {}
                    headers: example_value
                    footers: example_value
                    footnotes: example_value
                    documentStyle:
                      defaultHeaderId: '500123'
                      defaultFooterId: '500123'
                      evenPageHeaderId: '500123'
                      evenPageFooterId: '500123'
                      firstPageHeaderId: '500123'
                      firstPageFooterId: '500123'
                      useFirstPageHeaderFooter: true
                      useEvenPageHeaderFooter: true
                      pageNumberStart: 10
                      useCustomHeaderFooterMargins: true
                      flipPageOrientation: true
                    suggestedDocumentStyleChanges: example_value
                    namedStyles:
                      styles:
                      - {}
                    suggestedNamedStylesChanges: example_value
                    lists: example_value
                    namedRanges: example_value
                    inlineObjects: example_value
                    positionedObjects: example_value
        '400':
          description: Bad request. The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsCreate400Example:
                  summary: Default docs.documents.create 400 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '401':
          description: Unauthorized. Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsCreate401Example:
                  summary: Default docs.documents.create 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '403':
          description: Forbidden. The caller does not have permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsCreate403Example:
                  summary: Default docs.documents.create 403 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
      security:
      - oauth2:
        - https://www.googleapis.com/auth/documents
      - oauth2:
        - https://www.googleapis.com/auth/drive
      - oauth2:
        - https://www.googleapis.com/auth/drive.file
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/documents/{documentId}:
    get:
      operationId: docs.documents.get
      summary: Google Docs Get a Document
      description: Gets the latest version of the specified document. Returns the full document resource including content, styling, and metadata.
      tags:
      - Documents
      parameters:
      - name: documentId
        in: path
        required: true
        description: The ID of the document to retrieve.
        schema:
          type: string
        example: '500123'
      - name: suggestionsViewMode
        in: query
        required: false
        description: The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, collapsed, or only previewing suggestions accepted or rejected. If not specified, defaults to DEFAULT_FOR_CURRENT_ACCESS.
        schema:
          $ref: '#/components/schemas/SuggestionsViewMode'
        example: example_value
      - name: includeTabsContent
        in: query
        required: false
        description: Whether to populate the Document.tabs field instead of the text content fields like body, documentStyle, headers, etc. When true, content is returned in Document.tabs. When false, content from the first tab populates the legacy content fields.
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: Successful response containing the requested document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
              examples:
                DocsDocumentsGet200Example:
                  summary: Default docs.documents.get 200 response
                  x-microcks-default: true
                  value:
                    documentId: '500123'
                    title: Example Title
                    tabs:
                    - childTabs: {}
                    revisionId: '500123'
                    suggestionsViewMode: DEFAULT_FOR_CURRENT_ACCESS
                    body:
                      content:
                      - {}
                    headers: example_value
                    footers: example_value
                    footnotes: example_value
                    documentStyle:
                      defaultHeaderId: '500123'
                      defaultFooterId: '500123'
                      evenPageHeaderId: '500123'
                      evenPageFooterId: '500123'
                      firstPageHeaderId: '500123'
                      firstPageFooterId: '500123'
                      useFirstPageHeaderFooter: true
                      useEvenPageHeaderFooter: true
                      pageNumberStart: 10
                      useCustomHeaderFooterMargins: true
                      flipPageOrientation: true
                    suggestedDocumentStyleChanges: example_value
                    namedStyles:
                      styles:
                      - {}
                    suggestedNamedStylesChanges: example_value
                    lists: example_value
                    namedRanges: example_value
                    inlineObjects: example_value
                    positionedObjects: example_value
        '401':
          description: Unauthorized. Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsGet401Example:
                  summary: Default docs.documents.get 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '403':
          description: Forbidden. The caller does not have permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsGet403Example:
                  summary: Default docs.documents.get 403 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '404':
          description: Not found. The specified document does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsGet404Example:
                  summary: Default docs.documents.get 404 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
      security:
      - oauth2:
        - https://www.googleapis.com/auth/documents
      - oauth2:
        - https://www.googleapis.com/auth/documents.readonly
      - oauth2:
        - https://www.googleapis.com/auth/drive
      - oauth2:
        - https://www.googleapis.com/auth/drive.readonly
      - oauth2:
        - https://www.googleapis.com/auth/drive.file
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/documents/{documentId}:batchUpdate:
    post:
      operationId: docs.documents.batchUpdate
      summary: Google Docs Batch Update a Document
      description: Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches the order of requests.
      tags:
      - Documents
      parameters:
      - name: documentId
        in: path
        required: true
        description: The ID of the document to update.
        schema:
          type: string
        example: '500123'
      requestBody:
        description: The batch update request containing one or more document updates.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdateDocumentRequest'
            examples:
              DocsDocumentsBatchupdateRequestExample:
                summary: Default docs.documents.batchUpdate request
                x-microcks-default: true
                value:
                  requests:
                  - {}
                  writeControl:
                    requiredRevisionId: '500123'
                    targetRevisionId: '500123'
      responses:
        '200':
          description: Successful response containing the document ID, ordered replies for each request, and updated write control information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUpdateDocumentResponse'
              examples:
                DocsDocumentsBatchupdate200Example:
                  summary: Default docs.documents.batchUpdate 200 response
                  x-microcks-default: true
                  value:
                    documentId: '500123'
                    replies:
                    - {}
                    writeControl:
                      requiredRevisionId: '500123'
                      targetRevisionId: '500123'
        '400':
          description: Bad request. One or more of the update requests were invalid. Nothing was applied to the document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsBatchupdate400Example:
                  summary: Default docs.documents.batchUpdate 400 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '401':
          description: Unauthorized. Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsBatchupdate401Example:
                  summary: Default docs.documents.batchUpdate 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '403':
          description: Forbidden. The caller does not have permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsBatchupdate403Example:
                  summary: Default docs.documents.batchUpdate 403 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '404':
          description: Not found. The specified document does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                DocsDocumentsBatchupdate404Example:
                  summary: Default docs.documents.batchUpdate 404 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
      security:
      - oauth2:
        - https://www.googleapis.com/auth/documents
      - oauth2:
        - https://www.googleapis.com/auth/drive
      - oauth2:
        - https://www.googleapis.com/auth/drive.file
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Request:
      type: object
      description: A single update to apply to a document. Exactly one field must be set.
      properties:
        insertText:
          $ref: '#/components/schemas/InsertTextRequest'
        deleteContentRange:
          $ref: '#/components/schemas/DeleteContentRangeRequest'
        insertInlineImage:
          $ref: '#/components/schemas/InsertInlineImageRequest'
        insertTable:
          $ref: '#/components/schemas/InsertTableRequest'
        insertTableRow:
          $ref: '#/components/schemas/InsertTableRowRequest'
        insertTableColumn:
          $ref: '#/components/schemas/InsertTableColumnRequest'
        deleteTableRow:
          $ref: '#/components/schemas/DeleteTableRowRequest'
        deleteTableColumn:
          $ref: '#/components/schemas/DeleteTableColumnRequest'
        insertPageBreak:
          $ref: '#/components/schemas/InsertPageBreakRequest'
        insertSectionBreak:
          $ref: '#/components/schemas/InsertSectionBreakRequest'
        deletePositionedObject:
          $ref: '#/components/schemas/DeletePositionedObjectRequest'
        updateTextStyle:
          $ref: '#/components/schemas/UpdateTextStyleRequest'
        updateParagraphStyle:
          $ref: '#/components/schemas/UpdateParagraphStyleRequest'
        updateTableCellStyle:
          $ref: '#/components/schemas/UpdateTableCellStyleRequest'
        updateTableRowStyle:
          $ref: '#/components/schemas/UpdateTableRowStyleRequest'
        updateTableColumnProperties:
          $ref: '#/components/schemas/UpdateTableColumnPropertiesRequest'
        updateDocumentStyle:
          $ref: '#/components/schemas/UpdateDocumentStyleRequest'
        updateSectionStyle:
          $ref: '#/components/schemas/UpdateSectionStyleRequest'
        replaceAllText:
          $ref: '#/components/schemas/ReplaceAllTextRequest'
        createNamedRange:
          $ref: '#/components/schemas/CreateNamedRangeRequest'
        deleteNamedRange:
          $ref: '#/components/schemas/DeleteNamedRangeRequest'
        replaceNamedRangeContent:
          $ref: '#/components/schemas/ReplaceNamedRangeContentRequest'
        createParagraphBullets:
          $ref: '#/components/schemas/CreateParagraphBulletsRequest'
        deleteParagraphBullets:
          $ref: '#/components/schemas/DeleteParagraphBulletsRequest'
        createHeader:
          $ref: '#/components/schemas/CreateHeaderRequest'
        createFooter:
          $ref: '#/components/schemas/CreateFooterRequest'
        createFootnote:
          $ref: '#/components/schemas/CreateFootnoteRequest'
        deleteHeader:
          $ref: '#/components/schemas/DeleteHeaderRequest'
        deleteFooter:
          $ref: '#/components/schemas/DeleteFooterRequest'
        replaceImage:
          $ref: '#/components/schemas/ReplaceImageRequest'
        mergeTableCells:
          $ref: '#/components/schemas/MergeTableCellsRequest'
        unmergeTableCells:
          $ref: '#/components/schemas/UnmergeTableCellsRequest'
        pinTableHeaderRows:
          $ref: '#/components/schemas/PinTableHeaderRowsRequest'
    List:
      type: object
      description: A List represents the list attributes for a group of paragraphs that all belong to the same list.
      properties:
        listProperties:
          $ref: '#/components/schemas/ListProperties'
        suggestedListPropertiesChanges:
          type: object
          additionalProperties:
            type: object
          example: example_value
        suggestedInsertionId:
          type: string
          example: '500123'
        suggestedDeletionIds:
          type: array
          items:
            type: string
          example: []
    PositionedObjectPositioning:
      type: object
      description: The positioning of a PositionedObject.
      properties:
        layout:
          type: string
          description: The layout of this positioned object.
          enum:
          - POSITIONED_OBJECT_LAYOUT_UNSPECIFIED
          - WRAP_TEXT
          - BREAK_LEFT
          - BREAK_RIGHT
          - BREAK_LEFT_RIGHT
          - IN_FRONT_OF_TEXT
          - BEHIND_TEXT
          example: POSITIONED_OBJECT_LAYOUT_UNSPECIFIED
        leftOffset:
          $ref: '#/components/schemas/Dimension'
        topOffset:
          $ref: '#/components/schemas/Dimension'
    DeleteNamedRangeRequest:
      type: object
      description: Deletes a NamedRange.
      properties:
        namedRangeId:
          type: string
          description: The ID of the named range to delete.
          example: '500123'
        name:
          type: string
          description: The name of the range to delete. All named ranges with the given name will be deleted.
          example: Example Title
        tabsCriteria:
          $ref: '#/components/schemas/TabsCriteria'
    ParagraphElement:
      type: object
      description: A ParagraphElement describes content within a paragraph.
      properties:
        startIndex:
          type: integer
          description: The zero-based start index of this paragraph element.
          example: 10
        endIndex:
          type: integer
          description: The zero-based end index of this paragraph element, exclusive.
          example: 10
        textRun:
          $ref: '#/components/schemas/TextRun'
        autoText:
          $ref: '#/components/schemas/AutoText'
        pageBreak:
          $ref: '#/components/schemas/PageBreak'
        columnBreak:
          $ref: '#/components/schemas/ColumnBreak'
        footnoteReference:
          $ref: '#/components/schemas/FootnoteReference'
        horizontalRule:
          $ref: '#/components/schemas/HorizontalRule'
        equation:
          $ref: '#/components/schemas/Equation'
        inlineObjectElement:
          $ref: '#/components/schemas/InlineObjectElement'
        person:
          $ref: '#/components/schemas/Person'
        richLink:
          $ref: '#/components/schemas/RichLink'
    ReplaceAllTextResponse:
      type: object
      description: The result of replacing text.
      properties:
        occurrencesChanged:
          type: integer
          description: The number of occurrences changed.
          example: 10
    SectionStyle:
      type: object
      description: The style of a section, influencing the layout of the section's content.
      properties:
        columnProperties:
          type: array
          description: The section's columns properties. If empty, the section contains one column with the default properties.
          items:
            $ref: '#/components/schemas/SectionColumnProperties'
          example: []
        columnSeparatorStyle:
          type: string
          description: The style of column separators.
          enum:
          - COLUMN_SEPARATOR_STYLE_UNSPECIFIED
          - NONE
          - BETWEEN_EACH_COLUMN
          example: COLUMN_SEPARATOR_STYLE_UNSPECIFIED
        contentDirection:
          type: string
          description: The content direction of this section.
          enum:
          - CONTENT_DIRECTION_UNSPECIFIED
          - LEFT_TO_RIGHT
          - RIGHT_TO_LEFT
          example: CONTENT_DIRECTION_UNSPECIFIED
        sectionType:
          type: string
          description: The type of section.
          enum:
          - SECTION_TYPE_UNSPECIFIED
          - CONTINUOUS
          - NEXT_PAGE
          example: SECTION_TYPE_UNSPECIFIED
        defaultHeaderId:
          type: string
          example: '500123'
        defaultFooterId:
          type: string
          example: '500123'
        evenPageHeaderId:
          type: string
          example: '500123'
        evenPageFooterId:
          type: string
          example: '500123'
        firstPageHeaderId:
          type: string
          example: '500123'
        firstPageFooterId:
          type: string
          example: '500123'
        useFirstPageHeaderFooter:
          type: boolean
          example: true
        marginTop:
          $ref: '#/components/schemas/Dimension'
        marginBottom:
          $ref: '#/components/schemas/Dimension'
        marginRight:
          $ref: '#/components/schemas/Dimension'
        marginLeft:
          $ref: '#/components/schemas/Dimension'
        marginHeader:
          $ref: '#/components/schemas/Dimension'
        marginFooter:
          $ref: '#/components/schemas/Dimension'
        pageNumberStart:
          type: integer
          example: 10
        flipPageOrientation:
          type: boolean
          example: true
    RichLink:
      type: object
      description: A link to a Google resource such as a file in Drive, a YouTube video, or a Calendar event.
      properties:
        richLinkId:
          type: string
          description: Output only. The ID of this link.
          readOnly: true
          example: '500123'
        richLinkProperties:
          $ref: '#/components/schemas/RichLinkProperties'
        suggestedInsertionIds:
          type: array
          items:
            type: string
          example: []
        suggestedDeletionIds:
          type: array
          items:
            type: string
          example: []
        suggestedTextStyleChanges:
          type: object
          additionalProperties:
            type: object
          example: example_value
        textStyle:
          $ref: '#/components/schemas/TextStyle'
    TableCellBorder:
      type: object
      description: A border around a table cell.
      properties:
        color:
          $ref: '#/components/schemas/OptionalColor'
        width:
          $ref: '#/components/schemas/Dimension'
        dashStyle:
          type: string
          enum:
          - DASH_STYLE_UNSPECIFIED
          - SOLID
          - DOT
          - DASH
          example: DASH_STYLE_UNSPECIFIED
    TableOfContents:
      type: object
      description: A StructuralElement representing a table of contents.
      properties:
        content:
          type: array
          description: The content of the table of contents.
          items:
            $ref: '#/components/schemas/StructuralElement'
          example: []
        suggestedInsertionIds:
          type: array
          items:
            type: string
          example: []
        suggestedDeletionIds:
          type: array
          items:
            type: string
          example: []
    SectionColumnProperties:
      type: object
      description: Properties that apply to a section's column.
      properties:
        width:
          $ref: '#/components/schemas/Dimension'
        paddingEnd:
          $ref: '#/components/schemas/Dimension'
    CreateFootnoteRequest:
      type: object
      description: Creates a Footnote segment and inserts a new FootnoteReference.
      properties:
        location:
          $ref: '#/components/schemas/Location'
        endOfSegmentLocation:
          $ref: '#/components/schemas/EndOfSegmentLocation'
    DeleteTableRowRequest:
      type: object
      description: Deletes a row from a table.
      properties:
        tableCellLocation:
          $ref: '#/components/schemas/TableCellLocation'
      required:
      - tableCellLocation
    InsertPageBreakRequest:
      type: object
      description: Inserts a page break at the given location.
      properties:
        location:
          $ref: '#/components/schemas/Location'
        endOfSegmentLocation:
          $ref: '#/components/schemas/EndOfSegmentLocation'
    Header:
      type: object
      description: A document header.
      properties:
        headerId:
          type: string
          description: Output only. The ID of the header.
          readOnly: true
          example: '500123'
        content:
          type: array
          description: The contents of the header.
          items:
            $ref: '#/components/schemas/StructuralElement'
          example: []
    Location:
      type: object
      description: A particular location in the document.
      properties:
        segmentId:
          type: string
          description: The ID of the header, footer, or footnote the location is in. An empty segment ID signifies the document body.
          example: '500123'
        index:
          type: integer
          description: The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segmentId.
          example: 10
        tabId:
          type: string
          description: The tab that the location is in.
          example: '500123'
    CreateNamedRangeRequest:
      type: object
      description: Creates a NamedRange referencing the given range.
      properties:
        name:
          type: string
          description: The name of the NamedRange. Names do not need to be unique.
          example: Example Title
        range:
          $ref: '#/components/schemas/Range'
      required:
      - name
      - range
    WriteControl:
      type: object
      description: Provides control over how write requests are executed. When set on a request, it provides a way to detect conflicts.
      properties:
        requiredRevisionId:
          type: string
          description: The optional revision ID of the document the write request is applied to. If this is not the latest revision of the document, the request is not processed and returns a 400 bad request error.
          example: '500123'
        targetRevisionId:
          type: string
          description: The optional target revision ID of the document the write request is applied to. If collaborator changes have occurred after the document was read using the API, the changes produced by this write request are applied against the collaborator changes. This results in a resolved document.
          example: '500123'
    TableColumnProperties:
      type: object
      description: The properties of a column in a table.
      properties:
        widthType:
          type: string
          description: The width type of the column.
          enum:
          - WIDTH_TYPE_UNSPECIFIED
          - EVENLY_DISTRIBUTED
          - FIXED_WIDTH
          example: WIDTH_TYPE_UNSPECIFIED
        width:
          $ref: '#/components/schemas/Dimension'
    NamedRanges:
      type: object
      description: A collection of all the NamedRanges in the document that share a given name.
      properties:
        name:
          type: string
          description: The name that all the named ranges share.
          example: Example Title
        namedRanges:
          type: array
          description: The named ranges that share the same name.
          items:
            $ref: '#/components/schemas/NamedRange'
          example: []
    UpdateSectionStyleRequest:
      type: object
      description: Updates the SectionStyle.
      properties:
        range:
          $ref: '#/components/schemas/Range'
        sectionStyle:
          $ref: '#/components/schemas/SectionStyle'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
      required:
      - range
      - sectionStyle
      - fields
    TableCellLocation:
      type: object
      description: Location of a single cell within a table.
      properties:
        tableStartLocation:
          $ref: '#/components/schemas/Location'
        rowIndex:
          type: integer
          description: The zero-based row index.
          example: 10
        columnIndex:
          type: integer
          description: The zero-based column index.
          example: 10
    PageBreak:
      type: object
      description: A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page.
      properties:
        suggestedInsertionIds:
          type: array
          items:
            type: string
          example: []
        suggestedDeletionIds:
          type: array
          items:
            type: string
          example: []
        suggestedTextStyleChanges:
          type: object
          additionalProperties:
            type: object
          example: example_value
        textStyle:
          $ref: '#/components/schemas/TextStyle'
    InsertInlineImageRequest:
      type: object
      description: Inserts an InlineObject containing an image at the given locati

# --- truncated at 32 KB (96 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google-docs/refs/heads/main/openapi/google-docs-documents-api-openapi.yml