Phrase Strings API Reference — Projects

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Projects
  description: 'Phrase Strings API Reference — Projects. 5 operations. Lead operation: List projects. Self-contained Naftiko
    capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Projects
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-projects
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Projects business capability. Self-contained, no shared references.
    resources:
    - name: projects
      path: /projects
      operations:
      - name: projectslist
        method: GET
        description: List projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sort_by
          in: query
          type: string
          description: Sort projects. Valid options are "name_asc", "name_desc", "updated_at_asc", "updated_at_desc", "space_asc"
            and "space_desc".
        - name: filters
          in: query
          type: array
          description: Filter projects. Valid options are ["favorites"].
      - name: projectcreate
        method: POST
        description: Create a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-id
      path: /projects/{id}
      operations:
      - name: projectshow
        method: GET
        description: Get a single project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: projectupdate
        method: PATCH
        description: Update a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: projectdelete
        method: DELETE
        description: Delete a project
        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-projects-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Projects. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects
      name: projects
      description: REST surface for projects.
      operations:
      - method: GET
        name: projectslist
        description: List projects
        call: strings-projects.projectslist
        with:
          sort_by: rest.sort_by
          filters: rest.filters
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: projectcreate
        description: Create a project
        call: strings-projects.projectcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{id}
      name: projects-id
      description: REST surface for projects-id.
      operations:
      - method: GET
        name: projectshow
        description: Get a single project
        call: strings-projects.projectshow
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: projectupdate
        description: Update a project
        call: strings-projects.projectupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: projectdelete
        description: Delete a project
        call: strings-projects.projectdelete
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-projects-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Projects. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-projects
      description: List projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-projects.projectslist
      with:
        sort_by: tools.sort_by
        filters: tools.filters
      outputParameters:
      - type: object
        mapping: $.
    - name: create-project
      description: Create a project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-projects.projectcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-project
      description: Get a single project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-projects.projectshow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-project
      description: Update a project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-projects.projectupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-project
      description: Delete a project
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-projects.projectdelete
      outputParameters:
      - type: object
        mapping: $.