Phrase Strings API Reference — Documents

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Documents
  description: 'Phrase Strings API Reference — Documents. 2 operations. Lead operation: List documents. Self-contained Naftiko
    capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-documents
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Documents business capability. Self-contained, no shared references.
    resources:
    - name: projects-project_id-documents
      path: /projects/{project_id}/documents
      operations:
      - name: documentslist
        method: GET
        description: List documents
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-project_id-documents-id
      path: /projects/{project_id}/documents/{id}
      operations:
      - name: documentdelete
        method: DELETE
        description: Delete document
        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-documents-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{project-id}/documents
      name: projects-project-id-documents
      description: REST surface for projects-project_id-documents.
      operations:
      - method: GET
        name: documentslist
        description: List documents
        call: strings-documents.documentslist
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/documents/{id}
      name: projects-project-id-documents-id
      description: REST surface for projects-project_id-documents-id.
      operations:
      - method: DELETE
        name: documentdelete
        description: Delete document
        call: strings-documents.documentdelete
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Documents. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-documents
      description: List documents
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-documents.documentslist
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-document
      description: Delete document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-documents.documentdelete
      outputParameters:
      - type: object
        mapping: $.