Prefect Cloud API — Pins

naftiko: 1.0.0-alpha2
info:
  label: Prefect Cloud API — Pins
  description: 'Prefect Cloud API — Pins. 3 operations. Lead operation: Create User Pin. Self-contained Naftiko capability
    covering one Prefect business surface.'
  tags:
  - Prefect
  - Pins
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PREFECT_API_KEY: PREFECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: prefect-pins
    baseUri: ''
    description: Prefect Cloud API — Pins business capability. Self-contained, no shared references.
    resources:
    - name: api-accounts-account_id-workspaces-workspace_id-pins
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/pins/
      operations:
      - name: createuserpinapiaccountsaccountidworkspacesworkspaceidpinspost
        method: POST
        description: Create User Pin
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: x-prefect-api-version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-pins-filter
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/pins/filter
      operations:
      - name: readuserpinsapiaccountsaccountidworkspacesworkspaceidpinsfilterpost
        method: POST
        description: Read User Pins
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: x-prefect-api-version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id-pins-id
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/pins/{id}
      operations:
      - name: deleteuserpinapiaccountsaccountidworkspacesworkspaceidpinsiddelete
        method: DELETE
        description: Delete User Pin
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The pin id
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: x-prefect-api-version
          in: header
          type: string
  exposes:
  - type: rest
    namespace: prefect-pins-rest
    port: 8080
    description: REST adapter for Prefect Cloud API — Pins. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/pins
      name: api-accounts-account-id-workspaces-workspace-id-pins
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-pins.
      operations:
      - method: POST
        name: createuserpinapiaccountsaccountidworkspacesworkspaceidpinspost
        description: Create User Pin
        call: prefect-pins.createuserpinapiaccountsaccountidworkspacesworkspaceidpinspost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          x-prefect-api-version: rest.x-prefect-api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/pins/filter
      name: api-accounts-account-id-workspaces-workspace-id-pins-filter
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-pins-filter.
      operations:
      - method: POST
        name: readuserpinsapiaccountsaccountidworkspacesworkspaceidpinsfilterpost
        description: Read User Pins
        call: prefect-pins.readuserpinsapiaccountsaccountidworkspacesworkspaceidpinsfilterpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          x-prefect-api-version: rest.x-prefect-api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/pins/{id}
      name: api-accounts-account-id-workspaces-workspace-id-pins-id
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-pins-id.
      operations:
      - method: DELETE
        name: deleteuserpinapiaccountsaccountidworkspacesworkspaceidpinsiddelete
        description: Delete User Pin
        call: prefect-pins.deleteuserpinapiaccountsaccountidworkspacesworkspaceidpinsiddelete
        with:
          id: rest.id
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          x-prefect-api-version: rest.x-prefect-api-version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: prefect-pins-mcp
    port: 9090
    transport: http
    description: MCP adapter for Prefect Cloud API — Pins. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-user-pin
      description: Create User Pin
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-pins.createuserpinapiaccountsaccountidworkspacesworkspaceidpinspost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        x-prefect-api-version: tools.x-prefect-api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-user-pins
      description: Read User Pins
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-pins.readuserpinsapiaccountsaccountidworkspacesworkspaceidpinsfilterpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        x-prefect-api-version: tools.x-prefect-api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user-pin
      description: Delete User Pin
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: prefect-pins.deleteuserpinapiaccountsaccountidworkspacesworkspaceidpinsiddelete
      with:
        id: tools.id
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        x-prefect-api-version: tools.x-prefect-api-version
      outputParameters:
      - type: object
        mapping: $.