Bytebase Sheet Service API

openapi: 3.2.0
info:
  title: Bytebase API Reference Sheet Service API
  description: API reference for Bytebase. Every endpoint is served by your own Bytebase instance.
  version: 1.0.0
security: []
tags:
- name: SheetService
  description: SheetService manages SQL scripts and saved queries.
paths:
  /v1/projects/{project}/sheets:
    post:
      tags:
      - SheetService
      summary: CreateSheet
      description: 'Creates a new SQL sheet.

        Permissions required: bb.sheets.create'
      operationId: SheetService_CreateSheet
      parameters:
      - name: project
        in: path
        description: The project id.
        required: true
        schema:
          type: string
      requestBody:
        description: The sheet to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/bytebase.v1.Sheet'
              title: sheet
              description: The sheet to create.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.Sheet'
  /v1/projects/{project}/sheets/{sheet}:
    get:
      tags:
      - SheetService
      summary: GetSheet
      description: 'Retrieves a SQL sheet by name.

        Permissions required: bb.sheets.get'
      operationId: SheetService_GetSheet
      parameters:
      - name: project
        in: path
        description: The project id.
        required: true
        schema:
          type: string
      - name: sheet
        in: path
        description: The sheet id.
        required: true
        schema:
          type: string
      - name: raw
        in: query
        description: By default, the content of the sheet is cut off, set the `raw` to true to retrieve the full content.
        schema:
          type: boolean
          title: raw
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.Sheet'
  /v1/projects/{project}/sheets:batchCreate:
    post:
      tags:
      - SheetService
      summary: BatchCreateSheets
      description: 'Creates multiple SQL sheets in a single operation.

        Permissions required: bb.sheets.create'
      operationId: SheetService_BatchCreateSheets
      parameters:
      - name: project
        in: path
        description: The project id.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                requests:
                  type: array
                  items:
                    $ref: '#/components/schemas/bytebase.v1.CreateSheetRequest'
                  title: requests
              title: BatchCreateSheetsRequest
              required:
              - requests
              additionalProperties: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bytebase.v1.BatchCreateSheetsResponse'
components:
  schemas:
    bytebase.v1.BatchCreateSheetsResponse:
      type: object
      properties:
        sheets:
          type: array
          items:
            $ref: '#/components/schemas/bytebase.v1.Sheet'
          title: sheets
      title: BatchCreateSheetsResponse
      additionalProperties: false
    bytebase.v1.CreateSheetRequest:
      type: object
      properties:
        parent:
          type: string
          title: parent
          description: "The parent resource where this sheet will be created.\n Format: projects/{project}"
        sheet:
          allOf:
          - $ref: '#/components/schemas/bytebase.v1.Sheet'
          title: sheet
          description: The sheet to create.
      title: CreateSheetRequest
      required:
      - parent
      - sheet
      additionalProperties: false
    bytebase.v1.Sheet:
      type: object
      properties:
        name:
          type: string
          title: name
          description: "(IMMUTABLE) The name of the sheet resource.\n Format: projects/{project}/sheets/{sheet}\n The sheet ID is generated by the server on creation and cannot be changed."
        content:
          type: string
          title: content
          format: byte
          description: "The content of the sheet.\n By default, it will be cut off, if it doesn't match the `content_size`, you can\n set the `raw` to true in GetSheet request to retrieve the full content."
        contentSize:
          type: string
          title: content_size
          format: int64
          description: content_size is the full size of the content, may not match the size of the `content` field.
          readOnly: true
      title: Sheet
      required:
      - name
      - content
      additionalProperties: false
x-provenance:
  method: harvested
  publisher: Bytebase
  source: https://api.bytebase.com/openapi.yaml
  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)