Phrase Strings API Reference — Locale Downloads

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Locale Downloads
  description: 'Phrase Strings API Reference — Locale Downloads. 2 operations. Lead operation: Initiate async download of
    a locale. Self-contained Naftiko capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Locale Downloads
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-locale-downloads
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Locale Downloads business capability. Self-contained, no shared references.
    resources:
    - name: projects-project_id-locales-locale_id-downloads
      path: /projects/{project_id}/locales/{locale_id}/downloads
      operations:
      - name: localedownloadcreate
        method: POST
        description: Initiate async download of a locale
        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-locales-locale_id-downloads-id
      path: /projects/{project_id}/locales/{locale_id}/downloads/{id}
      operations:
      - name: localedownloadshow
        method: GET
        description: Show status of an async locale download
        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-locale-downloads-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Locale Downloads. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/projects/{project-id}/locales/{locale-id}/downloads
      name: projects-project-id-locales-locale-id-downloads
      description: REST surface for projects-project_id-locales-locale_id-downloads.
      operations:
      - method: POST
        name: localedownloadcreate
        description: Initiate async download of a locale
        call: strings-locale-downloads.localedownloadcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/locales/{locale-id}/downloads/{id}
      name: projects-project-id-locales-locale-id-downloads-id
      description: REST surface for projects-project_id-locales-locale_id-downloads-id.
      operations:
      - method: GET
        name: localedownloadshow
        description: Show status of an async locale download
        call: strings-locale-downloads.localedownloadshow
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-locale-downloads-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Locale Downloads. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: initiate-async-download-locale
      description: Initiate async download of a locale
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-locale-downloads.localedownloadcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-status-async-locale-download
      description: Show status of an async locale download
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-locale-downloads.localedownloadshow
      outputParameters:
      - type: object
        mapping: $.