openapi: 3.0.1
info:
  title: GoodData Cloud Dashboards Workspaces API
  description: REST API for GoodData Cloud, covering the Entity API (/api/v1/entities), the Declarative / Layout API (/api/v1/layout), and the Action API (/api/v1/actions). The API manages workspaces, data sources, the logical data model, metrics, visualizations, dashboards, AFM executions, users, and permissions. Authentication uses a Bearer API token in the Authorization header.
  termsOfService: https://www.gooddata.com/legal/
  contact:
    name: GoodData Support
    url: https://support.gooddata.com
  version: '1.0'
servers:
- url: https://{domain}.gooddata.com
  description: GoodData Cloud organization host
  variables:
    domain:
      default: your-organization
      description: Your GoodData Cloud organization subdomain.
security:
- bearerAuth: []
tags:
- name: Workspaces
paths:
  /api/v1/entities/workspaces:
    get:
      operationId: getWorkspaces
      tags:
      - Workspaces
      summary: List all workspaces in the organization.
      parameters:
      - $ref: '#/components/parameters/Size'
      - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: A collection of workspaces.
    post:
      operationId: createWorkspace
      tags:
      - Workspaces
      summary: Create a new workspace.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Workspace'
      responses:
        '201':
          description: The created workspace.
  /api/v1/entities/workspaces/{workspaceId}:
    parameters:
    - $ref: '#/components/parameters/WorkspaceId'
    get:
      operationId: getWorkspace
      tags:
      - Workspaces
      summary: Get a single workspace by id.
      responses:
        '200':
          description: The requested workspace.
    put:
      operationId: updateWorkspace
      tags:
      - Workspaces
      summary: Update a workspace.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Workspace'
      responses:
        '200':
          description: The updated workspace.
    delete:
      operationId: deleteWorkspace
      tags:
      - Workspaces
      summary: Delete a workspace.
      responses:
        '204':
          description: Workspace deleted.
components:
  parameters:
    Page:
      name: page
      in: query
      description: The zero-based pagination index of the collection set to return.
      schema:
        type: integer
        default: 0
    Size:
      name: size
      in: query
      description: The number of objects to return. The default is 20.
      schema:
        type: integer
        default: 20
    WorkspaceId:
      name: workspaceId
      in: path
      required: true
      description: The id of the workspace.
      schema:
        type: string
  schemas:
    Workspace:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
              example: workspace
            attributes:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'GoodData Cloud API token passed as ''Authorization: Bearer <API_TOKEN>''.'