PlanetScale Platform API — Passwords

naftiko: 1.0.0-alpha2
info:
  label: PlanetScale Platform API — Passwords
  description: 'PlanetScale Platform API — Passwords. 5 operations. Lead operation: List passwords. Self-contained Naftiko
    capability covering one Planetscale business surface.'
  tags:
  - Planetscale
  - Passwords
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PLANETSCALE_API_KEY: PLANETSCALE_API_KEY
capability:
  consumes:
  - type: http
    namespace: platform-passwords
    baseUri: https://api.planetscale.com/v1
    description: PlanetScale Platform API — Passwords business capability. Self-contained, no shared references.
    resources:
    - name: organizations-organization-databases-database-branches-branch-passwords
      path: /organizations/{organization}/databases/{database}/branches/{branch}/passwords
      operations:
      - name: listpasswords
        method: GET
        description: List passwords
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createpassword
        method: POST
        description: Create a password
        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-branches-branch-passwords-password
      path: /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password_id}
      operations:
      - name: getpassword
        method: GET
        description: Get a password
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletepassword
        method: DELETE
        description: Delete a password
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: organizations-organization-databases-database-branches-branch-passwords-password
      path: /organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password_id}/renew
      operations:
      - name: renewpassword
        method: POST
        description: Renew a password
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PLANETSCALE_API_KEY}}'
  exposes:
  - type: rest
    namespace: platform-passwords-rest
    port: 8080
    description: REST adapter for PlanetScale Platform API — Passwords. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/organizations/{organization}/databases/{database}/branches/{branch}/passwords
      name: organizations-organization-databases-database-branches-branch-passwords
      description: REST surface for organizations-organization-databases-database-branches-branch-passwords.
      operations:
      - method: GET
        name: listpasswords
        description: List passwords
        call: platform-passwords.listpasswords
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpassword
        description: Create a password
        call: platform-passwords.createpassword
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password-id}
      name: organizations-organization-databases-database-branches-branch-passwords-password
      description: REST surface for organizations-organization-databases-database-branches-branch-passwords-password.
      operations:
      - method: GET
        name: getpassword
        description: Get a password
        call: platform-passwords.getpassword
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepassword
        description: Delete a password
        call: platform-passwords.deletepassword
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{password-id}/renew
      name: organizations-organization-databases-database-branches-branch-passwords-password
      description: REST surface for organizations-organization-databases-database-branches-branch-passwords-password.
      operations:
      - method: POST
        name: renewpassword
        description: Renew a password
        call: platform-passwords.renewpassword
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: platform-passwords-mcp
    port: 9090
    transport: http
    description: MCP adapter for PlanetScale Platform API — Passwords. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-passwords
      description: List passwords
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-passwords.listpasswords
      outputParameters:
      - type: object
        mapping: $.
    - name: create-password
      description: Create a password
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-passwords.createpassword
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-password
      description: Get a password
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: platform-passwords.getpassword
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-password
      description: Delete a password
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: platform-passwords.deletepassword
      outputParameters:
      - type: object
        mapping: $.
    - name: renew-password
      description: Renew a password
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: platform-passwords.renewpassword
      outputParameters:
      - type: object
        mapping: $.