openapi: 3.2.0
info:
  description: 'WARNING: This API is unstable and is meant for experimentation only. Do not

    use this API in production. The endpoints and schemas referenced in this

    documentation will be changed or removed without notice and without any

    backwards compatibility guarantee. Note that even though this API is unstable,

    it is still connected to production data, so use with caution.'
  title: Config Unstable Noop Entity API
  version: UNSTABLE
tags:
- name: NoopEntity
paths:
  /api/unstable/config/noop-entities:
    post:
      operationId: CreateNoopEntity
      responses:
        '200':
          description: A successful response containing the created NoopEntity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configunstableCreateNoopEntityResponse'
        '400':
          description: Cannot create the NoopEntity because the request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '409':
          description: Cannot create the NoopEntity because there is a conflict with an existing NoopEntity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
      tags:
      - NoopEntity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configunstableCreateNoopEntityRequest'
        required: true
      summary: Create noop entity
      x-summary-source: derived
  /api/unstable/config/noop-entities/{slug}:
    delete:
      operationId: DeleteNoopEntity
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configunstableDeleteNoopEntityResponse'
        '400':
          description: Cannot delete the NoopEntity because it is in use.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '404':
          description: Cannot delete the NoopEntity because the slug does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
      tags:
      - NoopEntity
      summary: Delete noop entity
      x-summary-source: derived
    get:
      operationId: ReadNoopEntity
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configunstableReadNoopEntityResponse'
        '404':
          description: Cannot read the NoopEntity because the slug does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
      tags:
      - NoopEntity
      summary: Read noop entity
      x-summary-source: derived
    put:
      operationId: UpdateNoopEntity
      parameters:
      - in: path
        name: slug
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response containing the updated NoopEntity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/configunstableUpdateNoopEntityResponse'
        '400':
          description: Cannot update the NoopEntity because the request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '404':
          description: Cannot update the NoopEntity because the slug does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '409':
          description: Cannot update the NoopEntity because there is a conflict with an existing NoopEntity.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        '500':
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiError'
        default:
          description: An undefined error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/genericError'
      tags:
      - NoopEntity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigUnstableUpdateNoopEntityBody'
        required: true
      summary: Update noop entity
      x-summary-source: derived
components:
  schemas:
    configunstableDeleteNoopEntityResponse:
      properties:
        not_hidden:
          type: boolean
      type: object
    NoopEntityNestedEnum:
      enum:
      - ENABLED
      type: string
    configunstableUpdateNoopEntityResponse:
      properties:
        noop_entity:
          $ref: '#/components/schemas/configunstableNoopEntity'
      type: object
    configunstableNoopEntity:
      properties:
        slug:
          description: The unique identifier of the NoopEntity. If a `slug` isn't provided, one is generated based on the `name` field. You can't modify this field after the NoopEntity is created.
          type: string
        name:
          description: The name of the NoopEntity. You can modify this value after the NoopEntity is created.
          type: string
        created_at:
          description: Timestamp of when the NoopEntity was created. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
        updated_at:
          description: Timestamp of when the NoopEntity was last updated. Cannot be set by clients.
          format: date-time
          readOnly: true
          type: string
        nested_enum:
          $ref: '#/components/schemas/NoopEntityNestedEnum'
        enum:
          $ref: '#/components/schemas/configunstableNoopEnum'
      type: object
    configunstableCreateNoopEntityResponse:
      properties:
        noop_entity:
          $ref: '#/components/schemas/configunstableNoopEntity'
      type: object
    apiError:
      properties:
        code:
          description: An optional private error code whose values are undefined.
          format: int32
          type: integer
        message:
          description: An error message describing what went wrong.
          type: string
      type: object
    configunstableReadNoopEntityResponse:
      properties:
        noop_entity:
          $ref: '#/components/schemas/configunstableNoopEntity'
      type: object
    configunstableCreateNoopEntityRequest:
      properties:
        noop_entity:
          $ref: '#/components/schemas/configunstableNoopEntity'
      type: object
    ConfigUnstableUpdateNoopEntityBody:
      properties:
        noop_entity:
          $ref: '#/components/schemas/configunstableNoopEntity'
        create_if_missing:
          description: If `true`, the NoopEntity will be created if it does not already exist, identified by `slug`. If `false`, an error will be returned if the NoopEntity does not already exist.
          type: boolean
      type: object
    genericError:
      additionalProperties: true
      type: object
    configunstableNoopEnum:
      enum:
      - ACTIVE
      type: string