Phrase Strings API Reference — Blacklisted Keys

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Blacklisted Keys
  description: 'Phrase Strings API Reference — Blacklisted Keys. 5 operations. Lead operation: List blocked keys. Self-contained
    Naftiko capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Blacklisted Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-blacklisted-keys
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Blacklisted Keys business capability. Self-contained, no shared references.
    resources:
    - name: projects-project_id-blacklisted_keys
      path: /projects/{project_id}/blacklisted_keys
      operations:
      - name: blacklistedkeyslist
        method: GET
        description: List blocked keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: branch
          in: query
          type: string
          description: specify the branch to use
      - name: blacklistedkeycreate
        method: POST
        description: Create a blocked key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-project_id-blacklisted_keys-id
      path: /projects/{project_id}/blacklisted_keys/{id}
      operations:
      - name: blacklistedkeyshow
        method: GET
        description: Get a single blocked key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: blacklistedkeyupdate
        method: PATCH
        description: Update a blocked key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: blacklistedkeydelete
        method: DELETE
        description: Delete a blocked key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.PHRASE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: strings-blacklisted-keys-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Blacklisted Keys. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/projects/{project-id}/blacklisted-keys
      name: projects-project-id-blacklisted-keys
      description: REST surface for projects-project_id-blacklisted_keys.
      operations:
      - method: GET
        name: blacklistedkeyslist
        description: List blocked keys
        call: strings-blacklisted-keys.blacklistedkeyslist
        with:
          branch: rest.branch
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: blacklistedkeycreate
        description: Create a blocked key
        call: strings-blacklisted-keys.blacklistedkeycreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/blacklisted-keys/{id}
      name: projects-project-id-blacklisted-keys-id
      description: REST surface for projects-project_id-blacklisted_keys-id.
      operations:
      - method: GET
        name: blacklistedkeyshow
        description: Get a single blocked key
        call: strings-blacklisted-keys.blacklistedkeyshow
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: blacklistedkeyupdate
        description: Update a blocked key
        call: strings-blacklisted-keys.blacklistedkeyupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: blacklistedkeydelete
        description: Delete a blocked key
        call: strings-blacklisted-keys.blacklistedkeydelete
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-blacklisted-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Blacklisted Keys. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-blocked-keys
      description: List blocked keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-blacklisted-keys.blacklistedkeyslist
      with:
        branch: tools.branch
      outputParameters:
      - type: object
        mapping: $.
    - name: create-blocked-key
      description: Create a blocked key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-blacklisted-keys.blacklistedkeycreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-blocked-key
      description: Get a single blocked key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-blacklisted-keys.blacklistedkeyshow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-blocked-key
      description: Update a blocked key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-blacklisted-keys.blacklistedkeyupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-blocked-key
      description: Delete a blocked key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-blacklisted-keys.blacklistedkeydelete
      outputParameters:
      - type: object
        mapping: $.