API Reference — subpackage_projects.subpackage_projects/pauses

naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_projects.subpackage_projects/pauses
  description: 'API Reference — subpackage_projects.subpackage_projects/pauses. 5 operations. Lead operation: ✨ List pauses.
    Self-contained Naftiko capability covering one Label Studio business surface.'
  tags:
  - Label Studio
  - subpackage_projects.subpackage_projects/pauses
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LABEL_STUDIO_API_KEY: LABEL_STUDIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: label-studio-subpackage-projects-subpackage-projects-pauses
    baseUri: http://localhost:8000
    description: API Reference — subpackage_projects.subpackage_projects/pauses business capability. Self-contained, no shared
      references.
    resources:
    - name: api-projects-project_pk-members-user_pk-pauses
      path: /api/projects/{project_pk}/members/{user_pk}/pauses/
      operations:
      - name: list
        method: GET
        description: ✨ List pauses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: project_pk
          in: path
          type: integer
          required: true
        - name: user_pk
          in: path
          type: integer
          required: true
        - name: include_deleted
          in: query
          type: boolean
          description: Include deleted pauses.
        - name: ordering
          in: query
          type: string
          description: Which field to use when ordering the results.
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: create
        method: POST
        description: ✨ Create pause
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: project_pk
          in: path
          type: integer
          required: true
        - name: user_pk
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_pk-members-user_pk-pauses-id
      path: /api/projects/{project_pk}/members/{user_pk}/pauses/{id}/
      operations:
      - name: get
        method: GET
        description: ✨ Get pause
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: project_pk
          in: path
          type: integer
          required: true
        - name: user_pk
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: delete
        method: DELETE
        description: ✨ Delete pause
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: project_pk
          in: path
          type: integer
          required: true
        - name: user_pk
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
      - name: update
        method: PATCH
        description: ✨ Update pause
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: project_pk
          in: path
          type: integer
          required: true
        - name: user_pk
          in: path
          type: integer
          required: true
        - name: Authorization
          in: header
          type: string
          description: 'The token (or API key) must be passed as a request header. You can find your user token on the User
            Account page in Label Studio. Example: <br><pre><code class='
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.LABEL_STUDIO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: label-studio-subpackage-projects-subpackage-projects-pauses-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_projects.subpackage_projects/pauses. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/projects/{project-pk}/members/{user-pk}/pauses
      name: api-projects-project-pk-members-user-pk-pauses
      description: REST surface for api-projects-project_pk-members-user_pk-pauses.
      operations:
      - method: GET
        name: list
        description: ✨ List pauses
        call: label-studio-subpackage-projects-subpackage-projects-pauses.list
        with:
          project_pk: rest.project_pk
          user_pk: rest.user_pk
          include_deleted: rest.include_deleted
          ordering: rest.ordering
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: ✨ Create pause
        call: label-studio-subpackage-projects-subpackage-projects-pauses.create
        with:
          project_pk: rest.project_pk
          user_pk: rest.user_pk
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/projects/{project-pk}/members/{user-pk}/pauses/{id}
      name: api-projects-project-pk-members-user-pk-pauses-id
      description: REST surface for api-projects-project_pk-members-user_pk-pauses-id.
      operations:
      - method: GET
        name: get
        description: ✨ Get pause
        call: label-studio-subpackage-projects-subpackage-projects-pauses.get
        with:
          id: rest.id
          project_pk: rest.project_pk
          user_pk: rest.user_pk
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: ✨ Delete pause
        call: label-studio-subpackage-projects-subpackage-projects-pauses.delete
        with:
          id: rest.id
          project_pk: rest.project_pk
          user_pk: rest.user_pk
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: update
        description: ✨ Update pause
        call: label-studio-subpackage-projects-subpackage-projects-pauses.update
        with:
          id: rest.id
          project_pk: rest.project_pk
          user_pk: rest.user_pk
          Authorization: rest.Authorization
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: label-studio-subpackage-projects-subpackage-projects-pauses-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_projects.subpackage_projects/pauses. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-pauses
      description: ✨ List pauses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-pauses.list
      with:
        project_pk: tools.project_pk
        user_pk: tools.user_pk
        include_deleted: tools.include_deleted
        ordering: tools.ordering
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: create-pause
      description: ✨ Create pause
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: label-studio-subpackage-projects-subpackage-projects-pauses.create
      with:
        project_pk: tools.project_pk
        user_pk: tools.user_pk
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pause
      description: ✨ Get pause
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-pauses.get
      with:
        id: tools.id
        project_pk: tools.project_pk
        user_pk: tools.user_pk
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-pause
      description: ✨ Delete pause
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-pauses.delete
      with:
        id: tools.id
        project_pk: tools.project_pk
        user_pk: tools.user_pk
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: update-pause
      description: ✨ Update pause
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: label-studio-subpackage-projects-subpackage-projects-pauses.update
      with:
        id: tools.id
        project_pk: tools.project_pk
        user_pk: tools.user_pk
        Authorization: tools.Authorization
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.