openapi: 3.0.0
servers:
  - url: https://global.api.greenlake.hpe.com
info:
  title: Workspace Groups Management API
  description: CRUD operations for Workspace Groups Management
  version: 1.0.0-beta
  license:
    name: HPE End User License Agreement
    url: https://www.hpe.com/us/en/software/licensing.html
security:
  - bearerAuth: []
tags:
  - name: Groups
paths:
  /workspaces/v1beta1/groups:
    post:
      tags:
        - Groups
      summary: Create a workspace group
      operationId: createNewGroupV2
      description: |
        Creates a group for various group types
      requestBody:
        description: Create workspace group object
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupV2'
      responses:
        '201':
          description: Group successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMWorkspaceGroupV2'
          headers:
            Location:
              description: URL of the created group
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      tags:
        - Groups
      summary: List of Paginated workspace groups
      operationId: getGroupsV2
      description: Get the paginated list of Groups associated to the workspace
      parameters:
        - in: query
          name: offset
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
          description: The starting offset from which to begin retrieving items
        - description: >-
            Specifies the number of query results to be returned in a query
            response page
          in: query
          name: limit
          required: false
          schema:
            default: 2000
            description: The maximum number of items to retrieve
            maximum: 2000
            minimum: 1
            type: integer
      responses:
        '200':
          description: Return list of workspace groups
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupsListWithWorkspacesCountV2'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /workspaces/v1beta1/groups/{groupId}/group-workspaces:
    post:
      tags:
        - Groups
      summary: Add a workspace to the group
      operationId: addWorkspaceToGroup
      description: Add workspace to a group
      parameters:
        - in: path
          name: groupId
          description: HPE GreenLake unique group ID
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        description: Add workspace to a group
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddRequest'
      responses:
        '201':
          description: Workspace added to the group successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMGroupWorkspace'
          headers:
            Location:
              description: URL of the created group
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    get:
      tags:
        - Groups
      summary: List of paginated workspaces associated with the group ID
      operationId: listGroupWorkspaces
      description: |
        Get the paginated list of workspaces associated with the group ID
      parameters:
        - in: path
          name: groupId
          description: HPE GreenLake group ID
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          schema:
            type: string
            format: uuid
          required: true
        - description: >-
            Specifies the number of query results to be returned in a query
            response page
          in: query
          name: limit
          required: false
          schema:
            default: 200
            description: The maximum number of items to retrieve
            maximum: 500
            minimum: 1
            type: integer
        - in: query
          name: offset
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
          description: The starting offset from which to begin retrieving items
      responses:
        '200':
          description: Return list of workspaces associated with this group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupWorkspacesList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /workspaces/v1beta1/groups/{groupId}/group-workspaces/{groupWorkspaceId}:
    get:
      tags:
        - Groups
      summary: Get the workspace details
      operationId: getGroupWorkspace
      description: |
        Get the workspace details by group ID
      parameters:
        - in: path
          name: groupId
          description: HPE GreenLake unique group ID
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          schema:
            type: string
            format: uuid
          required: true
        - in: path
          name: groupWorkspaceId
          description: >-
            HPE GreenLake unique resource ID for this workspace belonging to the
            group
          example: 119363f3-4408-44c4-840a-99e1c9db64c1
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: Return Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMGroupWorkspace'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    delete:
      tags:
        - Groups
      summary: Remove a workspace from the workspace group
      operationId: deleteWorkspaceFromGroup
      description: Remove workspace from a group
      parameters:
        - in: path
          name: groupId
          description: HPE GreenLake unique group ID
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          schema:
            type: string
            format: uuid
          required: true
        - in: path
          name: groupWorkspaceId
          description: >-
            HPE GreenLake unique resource ID for this workspace belonging to the
            group
          example: 119363f3-4408-44c4-840a-99e1c9db64c1
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '204':
          description: Delete operation from the group performed successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
  /workspaces/v1beta1/groups/{groupId}:
    get:
      tags:
        - Groups
      summary: Get the workspace group details
      operationId: fetchGroupV2
      description: |
        Get the workspace group details by group ID
      parameters:
        - in: path
          name: groupId
          description: HPE GreenLake unique group ID
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: Return Group
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMWorkspaceGroupV2'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    put:
      tags:
        - Groups
      summary: Update workspace group details
      operationId: putGroupV2
      description: |
        Updates group details name and description
      parameters:
        - in: path
          name: groupId
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          description: HPE GreenLake unique group ID
          schema:
            type: string
            format: uuid
          required: true
      requestBody:
        description: Update Group object
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGroupV2'
      responses:
        '200':
          description: Group sucessfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SCIMWorkspaceGroupV2'
          headers:
            Location:
              description: URL of the created group
              schema:
                type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
    delete:
      tags:
        - Groups
      summary: Delete the workspace group
      operationId: removeGroupV2
      description: |
        Delete the existing workspace group from the account
      parameters:
        - in: path
          name: groupId
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          description: HPE GreenLake group ID
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '204':
          description: Group deleted successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    AddRequest:
      type: object
      required:
        - workspaceId
      properties:
        workspaceId:
          type: string
          description: HPE GreenLake unique workspace ID
          example: 5a4af781011e423ba6bd554dc73ae5a5
          format: uuid
        type:
          type: string
          description: Type of the resource
          enum:
            - /workspaces/workspace
    GroupsListWithWorkspacesCount:
      type: object
      required:
        - items
        - count
      properties:
        items:
          type: array
          description: list of group objects
          items:
            $ref: '#/components/schemas/SCIMGroupWithWorkspaceCount'
        offset:
          title: Offset
          type: integer
          description: >-
            The page that should use the offset input to retrieve the set of
            page results
        count:
          title: Count Per Page
          default: 200
          type: integer
        total:
          title: Total Count
          default: 0
          type: integer
    SCIMGroupWithWorkspaceCount:
      type: object
      required:
        - id
        - type
        - name
        - grn
        - groupType
        - generation
        - createdAt
        - updatedAt
        - totalWorkspaces
      properties:
        id:
          type: string
          description: >-
            HPE GreenLake group ID resource identifier randomly generated by the
            system
          readOnly: true
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          format: uuid
        type:
          type: string
          readOnly: true
          example: /workspaces/group
        name:
          type: string
          description: Unique name for the workspace group
          example: Demo Group
        grn:
          type: string
          example: >-
            grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173
        groupType:
          type: string
          description: Type of the group
          example: TenantGroup
        description:
          type: string
          description: Description for the group
          example: Sales admin Group
        generation:
          description: Number of times the resource updated
          title: Number of times the resource updated
          type: integer
        createdAt:
          type: string
          readOnly: true
          example: 2024-01-08 22:59:17.424801 +0000 UTC
        updatedAt:
          type: string
          readOnly: true
          example: 2024-01-08 23:00:22.320646 +0000 UTC
        totalMembers:
          title: Total workspaces present in the group
          default: 0
          type: integer
    SCIMGroup:
      type: object
      required:
        - id
        - type
        - name
        - grn
        - groupType
        - generation
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: >-
            HPE GreenLake group ID resource identifier randomly generated by the
            system
          readOnly: true
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          format: uuid
        type:
          type: string
          readOnly: true
          example: /workspaces/group
        name:
          type: string
          description: unique name for the tenant group
          example: Demo Group
        grn:
          type: string
          example: >-
            grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173
        groupType:
          type: string
          description: Type of the group
          example: TenantGroup
        description:
          type: string
          description: Description for the tenant group
          example: Sales admin Group
        generation:
          description: Number of times the resource updated
          title: Number of times the resource updated
          type: integer
        createdAt:
          type: string
          readOnly: true
          example: 2024-01-08 22:59:17.424801 +0000 UTC
        updatedAt:
          type: string
          readOnly: true
          example: 2024-01-08 23:00:22.320646 +0000 UTC
    CreateGroupV2:
      type: object
      required:
        - name
        - groupType
      properties:
        name:
          type: string
          description: Name of the group
          example: Demo Group
          maxLength: 64
        groupType:
          type: string
          description: Type of the group
          example: TenantGroup
          enum:
            - TenantGroup
        description:
          type: string
          description: Description of the group
          example: Sales admin group
          maxLength: 256
          nullable: true
    UpdateGroupV2:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          description: Name of the group
          example: Demo Group
          maxLength: 64
        description:
          type: string
          description: Description of the group
          example: Sales admin group
          maxLength: 256
          nullable: true
    GroupWorkspacesList:
      type: object
      required:
        - items
        - count
        - total
      properties:
        items:
          type: array
          description: list of member objects
          items:
            $ref: '#/components/schemas/SCIMGroupWorkspace'
        offset:
          title: Offset
          type: integer
          description: The starting offset from which to begin retrieving items
        count:
          title: Count Per Page
          default: 200
          type: integer
        total:
          title: Total Count
          default: 0
          type: integer
    SCIMGroupWorkspace:
      type: object
      required:
        - id
        - type
        - workspace
        - grn
        - generation
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: >-
            HPE GreenLake unique resource ID for this workspace belonging to the
            group
          format: uuid
          readOnly: true
          example: 119363f3-4408-44c4-840a-99e1c9db64c1
        type:
          type: string
          readOnly: true
          example: /workspaces/group/group-workspace
        workspace:
          $ref: '#/components/schemas/SCIMWorkspace'
        grn:
          type: string
          example: >-
            grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173
        generation:
          description: Number of times the resource updated
          title: Number of times the resource updated
          type: integer
        createdAt:
          type: string
          readOnly: true
          example: 2024-01-08 22:59:17.424801 +0000 UTC
        updatedAt:
          type: string
          readOnly: true
          example: 2024-01-08 23:00:22.320646 +0000 UTC
      description: resource metadata
    SCIMWorkspace:
      type: object
      required:
        - id
        - type
        - description
        - name
      properties:
        id:
          type: string
          description: HPE GreenLake global ID unique resource identifier for workspace
          readOnly: true
          example: 5a4af781011e423ba6bd554dc73ae5a5
        type:
          type: string
          readOnly: true
          example: /workspaces/workspace
        description:
          type: string
          description: Description of the workspace
          example: US-E Workspace
        name:
          type: string
          description: name for the workspace
          example: US-E workspace
      description: workspace resource metadata
    SCIMWorkspaceGroupV2:
      type: object
      required:
        - id
        - type
        - name
        - grn
        - groupType
        - generation
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: >-
            HPE GreenLake group ID resource identifier randomly generated by the
            system
          readOnly: true
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          format: uuid
        type:
          type: string
          readOnly: true
          example: /workspaces/group
        name:
          type: string
          description: unique name for the tenant group
          example: Demo Group
        grn:
          type: string
          example: >-
            grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173
        groupType:
          type: string
          description: Type of the group
          example: TenantGroup
        description:
          type: string
          description: Description for the tenant group
          example: Sales admin Group
        generation:
          description: Number of times the resource updated
          title: Number of times the resource updated
          type: integer
        createdAt:
          type: string
          readOnly: true
          example: 2024-01-08 22:59:17.424801 +0000 UTC
        updatedAt:
          type: string
          readOnly: true
          example: 2024-01-08 23:00:22.320646 +0000 UTC
    SCIMGroupWithWorkspaceCountV2:
      type: object
      required:
        - id
        - type
        - name
        - grn
        - groupType
        - generation
        - createdAt
        - updatedAt
        - totalWorkspaces
      properties:
        id:
          type: string
          description: >-
            HPE GreenLake group ID resource identifier randomly generated by the
            system
          readOnly: true
          example: 93313ca9-6a6a-48d3-8f91-da639c0b5173
          format: uuid
        type:
          type: string
          readOnly: true
          example: /workspaces/group
        name:
          type: string
          description: Unique name for the workspace group
          example: Demo Group
        grn:
          type: string
          example: >-
            grn:glp/workspaces/05f0523cfd0347fc981b9c4333a37b60/regions/default/providers/msp/tenant-groups/93313ca9-6a6a-48d3-8f91-da639c0b5173
        groupType:
          type: string
          description: Type of the group
          example: TenantGroup
        description:
          type: string
          description: Description for the group
          example: Sales admin Group
        generation:
          description: Number of times the resource updated
          title: Number of times the resource updated
          type: integer
        createdAt:
          type: string
          readOnly: true
          example: 2024-01-08 22:59:17.424801 +0000 UTC
        updatedAt:
          type: string
          readOnly: true
          example: 2024-01-08 23:00:22.320646 +0000 UTC
        totalWorkspaces:
          title: Total workspaces present in the group
          default: 0
          type: integer
    GroupsListWithWorkspacesCountV2:
      type: object
      required:
        - items
        - count
      properties:
        items:
          type: array
          description: list of group objects
          items:
            $ref: '#/components/schemas/SCIMGroupWithWorkspaceCountV2'
        offset:
          title: Offset
          type: integer
          description: >-
            The page that should use the offset input to retrieve the set of
            page results
        count:
          title: Count Per Page
          default: 200
          type: integer
        total:
          title: Total Count
          default: 0
          type: integer
    BadRequestError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 400
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GROUPS_ERROR_BAD_REQUEST
        message:
          type: string
          description: A user-friendly error message
          example: Invalid input of field 'foo'
        debugId:
          $ref: '#/components/schemas/DebugId'
        errorDetails:
          type: array
          description: Additional detailed information about the error
          items:
            type: object
            required:
              - type
              - issues
            properties:
              type:
                type: string
                description: The type of error details
                example: hpe.greenlake.bad_request
              issues:
                type: array
                description: Array of bad request issues
                items:
                  $ref: '#/components/schemas/BadRequestIssues'
    UnauthorizedError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 401
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GROUPS_ERROR_UNAUTHORIZED
        message:
          type: string
          description: A user-friendly error message
          example: Authentication error
        debugId:
          $ref: '#/components/schemas/DebugId'
    ForbiddenError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 403
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GROUPS_ERROR_FORBIDDEN
        message:
          type: string
          description: A user-friendly error message
          example: User is not authenticated to perform this action
        debugId:
          $ref: '#/components/schemas/DebugId'
    NotFoundError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 404
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GROUPS_ERROR_NOT_FOUND
        message:
          type: string
          description: A user-friendly error message
          example: The resource was not found
        debugId:
          $ref: '#/components/schemas/DebugId'
    ConflictError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 409
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GROUPS_ERROR_CONFLICT
        message:
          type: string
          description: A user-friendly error message
          example: There is a conflict with the current state of the target resource
        debugId:
          $ref: '#/components/schemas/DebugId'
    InternalError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 500
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GROUPS_INTERNAL_SERVER_ERROR
        message:
          type: string
          description: A user-friendly error message
          example: >-
            The server encountered an unexpected condition which prevented it
            from fulfilling the request
        debugId:
          $ref: '#/components/schemas/DebugId'
        errorDetails:
          type: array
          description: Additional detailed information about the error
          items:
            $ref: '#/components/schemas/RetryData'
    ServiceUnavailableError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          description: The HTTP equivalent status code
          example: 503
        errorCode:
          type: string
          description: >-
            A unique machine-friendly identifier for the error from a global
            list of enumerated identifier strings
          example: HPE_GL_ERROR_SERVICE_UNAVAILABLE
        message:
          type: string
          description: A user-friendly error message
          example: The server is not ready to handle the request
        debugId:
          $ref: '#/components/schemas/DebugId'
        errorDetails:
          type: array
          description: Additional detailed information about the error
          items:
            $ref: '#/components/schemas/RetryData'
    RetryData:
      type: object
      required:
        - type
        - retryAfterSeconds
      properties:
        type:
          type: string
          description: The type of error details
          example: hpe.greenlake.retry_info
        retryAfterSeconds:
          type: integer
          description: Seconds to wait before retrying.
          example: 30
    DebugId:
      type: string
      description: A unique identifier for the instance of this error
      example: 12312-123123-123123-1231212
    BadRequestIssues:
      type: object
      required:
        - source
        - subject
      properties:
        source:
          type: string
          description: The part of the request with an issue
          enum:
            - field
            - header
            - query.parameter
          example: field
        subject:
          type: string
          description: The specific issue key
          example: foo.bar
        description:
          type: string
          description: >-
            An elaborate description of the issue. This can be used by
            developers to understand how the failure can be addressed
          example: 'Invalid format: field ''foo'' is incompatible'
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NotFoundError'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConflictError'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
    ServiceUnavailable:
      description: Service Unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceUnavailableError'
