PlanetScale Platform API — Deploy Requests

naftiko: 1.0.0-alpha2
info:
  label: PlanetScale Platform API — Deploy Requests
  description: 'PlanetScale Platform API — Deploy Requests. 10 operations. Lead operation: Get the deploy queue. Self-contained
    Naftiko capability covering one Planetscale business surface.'
  tags:
  - Planetscale
  - Deploy Requests
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PLANETSCALE_API_KEY: PLANETSCALE_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-deploy-requests
    baseUri: https://api.planetscale.com/v1
    description: PlanetScale Platform API — Deploy Requests business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organization-databases-database-deploy-queue
      path: /organizations/{organization}/databases/{database}/deploy-queue
      operations:
      - name: getdeployqueue
        method: GET
        description: Get the deploy queue
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-organization-databases-database-deploy-requests
      path: /organizations/{organization}/databases/{database}/deploy-requests
      operations:
      - name: listdeployrequests
        method: GET
        description: List deploy requests
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdeployrequest
        method: POST
        description: Create a deploy request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organization-databases-database-deploy-requests-deploy_request_num
      path: /organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}
      operations:
      - name: getdeployrequest
        method: GET
        description: Get a deploy request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: closedeployrequest
        method: PATCH
        description: Close a deploy request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organization-databases-database-deploy-requests-deploy_request_num
      path: /organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/complete-revert
      operations:
      - name: completedeployrequestrevert
        method: POST
        description: Complete a revert
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-organization-databases-database-deploy-requests-deploy_request_num
      path: /organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/deploy
      operations:
      - name: queuedeployrequest
        method: POST
        description: Queue a deploy request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-organization-databases-database-deploy-requests-deploy_request_num
      path: /organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/reviews
      operations:
      - name: listdeployrequestreviews
        method: GET
        description: List deploy request reviews
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: reviewdeployrequest
        method: POST
        description: Review a deploy request
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: organizations-organization-databases-database-deploy-requests-deploy_request_num
      path: /organizations/{organization}/databases/{database}/deploy-requests/{deploy_request_number}/skip-revert
      operations:
      - name: skipdeployrequestrevert
        method: POST
        description: Skip revert period
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PLANETSCALE_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-deploy-requests-rest
    port: 8080
    description: REST adapter for PlanetScale Platform API — Deploy Requests. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organization}/databases/{database}/deploy-queue
      name: organizations-organization-databases-database-deploy-queue
      description: REST surface for organizations-organization-databases-database-deploy-queue.
      operations:
      - method: GET
        name: getdeployqueue
        description: Get the deploy queue
        call: platform-deploy-requests.getdeployqueue
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/deploy-requests
      name: organizations-organization-databases-database-deploy-requests
      description: REST surface for organizations-organization-databases-database-deploy-requests.
      operations:
      - method: GET
        name: listdeployrequests
        description: List deploy requests
        call: platform-deploy-requests.listdeployrequests
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createdeployrequest
        description: Create a deploy request
        call: platform-deploy-requests.createdeployrequest
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/deploy-requests/{deploy-request-number}
      name: organizations-organization-databases-database-deploy-requests-deploy-request-num
      description: REST surface for organizations-organization-databases-database-deploy-requests-deploy_request_num.
      operations:
      - method: GET
        name: getdeployrequest
        description: Get a deploy request
        call: platform-deploy-requests.getdeployrequest
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: closedeployrequest
        description: Close a deploy request
        call: platform-deploy-requests.closedeployrequest
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/deploy-requests/{deploy-request-number}/complete-revert
      name: organizations-organization-databases-database-deploy-requests-deploy-request-num
      description: REST surface for organizations-organization-databases-database-deploy-requests-deploy_request_num.
      operations:
      - method: POST
        name: completedeployrequestrevert
        description: Complete a revert
        call: platform-deploy-requests.completedeployrequestrevert
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/deploy-requests/{deploy-request-number}/deploy
      name: organizations-organization-databases-database-deploy-requests-deploy-request-num
      description: REST surface for organizations-organization-databases-database-deploy-requests-deploy_request_num.
      operations:
      - method: POST
        name: queuedeployrequest
        description: Queue a deploy request
        call: platform-deploy-requests.queuedeployrequest
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/deploy-requests/{deploy-request-number}/reviews
      name: organizations-organization-databases-database-deploy-requests-deploy-request-num
      description: REST surface for organizations-organization-databases-database-deploy-requests-deploy_request_num.
      operations:
      - method: GET
        name: listdeployrequestreviews
        description: List deploy request reviews
        call: platform-deploy-requests.listdeployrequestreviews
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: reviewdeployrequest
        description: Review a deploy request
        call: platform-deploy-requests.reviewdeployrequest
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/deploy-requests/{deploy-request-number}/skip-revert
      name: organizations-organization-databases-database-deploy-requests-deploy-request-num
      description: REST surface for organizations-organization-databases-database-deploy-requests-deploy_request_num.
      operations:
      - method: POST
        name: skipdeployrequestrevert
        description: Skip revert period
        call: platform-deploy-requests.skipdeployrequestrevert
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-deploy-requests-mcp
    port: 9090
    transport: http
    description: MCP adapter for PlanetScale Platform API — Deploy Requests. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-deploy-queue
      description: Get the deploy queue
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-deploy-requests.getdeployqueue
      outputParameters:
      - type: object
        mapping: $.
    - name: list-deploy-requests
      description: List deploy requests
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-deploy-requests.listdeployrequests
      outputParameters:
      - type: object
        mapping: $.
    - name: create-deploy-request
      description: Create a deploy request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-deploy-requests.createdeployrequest
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-deploy-request
      description: Get a deploy request
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-deploy-requests.getdeployrequest
      outputParameters:
      - type: object
        mapping: $.
    - name: close-deploy-request
      description: Close a deploy request
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: platform-deploy-requests.closedeployrequest
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: complete-revert
      description: Complete a revert
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-deploy-requests.completedeployrequestrevert
      outputParameters:
      - type: object
        mapping: $.
    - name: queue-deploy-request
      description: Queue a deploy request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-deploy-requests.queuedeployrequest
      outputParameters:
      - type: object
        mapping: $.
    - name: list-deploy-request-reviews
      description: List deploy request reviews
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-deploy-requests.listdeployrequestreviews
      outputParameters:
      - type: object
        mapping: $.
    - name: review-deploy-request
      description: Review a deploy request
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-deploy-requests.reviewdeployrequest
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: skip-revert-period
      description: Skip revert period
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-deploy-requests.skipdeployrequestrevert
      outputParameters:
      - type: object
        mapping: $.