Phrase Strings API Reference — Branches

naftiko: 1.0.0-alpha2
info:
  label: Phrase Strings API Reference — Branches
  description: 'Phrase Strings API Reference — Branches. 9 operations. Lead operation: List branches. Self-contained Naftiko
    capability covering one Phrase business surface.'
  tags:
  - Phrase
  - Branches
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PHRASE_API_KEY: PHRASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: strings-branches
    baseUri: https://api.phrase.com/v2
    description: Phrase Strings API Reference — Branches business capability. Self-contained, no shared references.
    resources:
    - name: projects-project_id-branches
      path: /projects/{project_id}/branches
      operations:
      - name: brancheslist
        method: GET
        description: List branches
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: branchcreate
        method: POST
        description: Create a branch
        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-branches-name
      path: /projects/{project_id}/branches/{name}
      operations:
      - name: branchshow
        method: GET
        description: Get a single branch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: branchupdate
        method: PATCH
        description: Update a branch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: branchdelete
        method: DELETE
        description: Delete a branch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: projects-project_id-branches-name-compare
      path: /projects/{project_id}/branches/{name}/compare
      operations:
      - name: branchcompare
        method: GET
        description: Compare branches
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Name of the branch
      - name: branchcomparisoncreate
        method: POST
        description: Create comparison (async.)
        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-branches-name-merge
      path: /projects/{project_id}/branches/{name}/merge
      operations:
      - name: branchmerge
        method: PATCH
        description: Merge a branch
        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-branches-name-sync
      path: /projects/{project_id}/branches/{name}/sync
      operations:
      - name: branchsync
        method: PATCH
        description: Sync a branch
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.PHRASE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: strings-branches-rest
    port: 8080
    description: REST adapter for Phrase Strings API Reference — Branches. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/projects/{project-id}/branches
      name: projects-project-id-branches
      description: REST surface for projects-project_id-branches.
      operations:
      - method: GET
        name: brancheslist
        description: List branches
        call: strings-branches.brancheslist
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: branchcreate
        description: Create a branch
        call: strings-branches.branchcreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/branches/{name}
      name: projects-project-id-branches-name
      description: REST surface for projects-project_id-branches-name.
      operations:
      - method: GET
        name: branchshow
        description: Get a single branch
        call: strings-branches.branchshow
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: branchupdate
        description: Update a branch
        call: strings-branches.branchupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: branchdelete
        description: Delete a branch
        call: strings-branches.branchdelete
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/branches/{name}/compare
      name: projects-project-id-branches-name-compare
      description: REST surface for projects-project_id-branches-name-compare.
      operations:
      - method: GET
        name: branchcompare
        description: Compare branches
        call: strings-branches.branchcompare
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: branchcomparisoncreate
        description: Create comparison (async.)
        call: strings-branches.branchcomparisoncreate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/branches/{name}/merge
      name: projects-project-id-branches-name-merge
      description: REST surface for projects-project_id-branches-name-merge.
      operations:
      - method: PATCH
        name: branchmerge
        description: Merge a branch
        call: strings-branches.branchmerge
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{project-id}/branches/{name}/sync
      name: projects-project-id-branches-name-sync
      description: REST surface for projects-project_id-branches-name-sync.
      operations:
      - method: PATCH
        name: branchsync
        description: Sync a branch
        call: strings-branches.branchsync
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: strings-branches-mcp
    port: 9090
    transport: http
    description: MCP adapter for Phrase Strings API Reference — Branches. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-branches
      description: List branches
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-branches.brancheslist
      outputParameters:
      - type: object
        mapping: $.
    - name: create-branch
      description: Create a branch
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-branches.branchcreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-branch
      description: Get a single branch
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-branches.branchshow
      outputParameters:
      - type: object
        mapping: $.
    - name: update-branch
      description: Update a branch
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-branches.branchupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-branch
      description: Delete a branch
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: strings-branches.branchdelete
      outputParameters:
      - type: object
        mapping: $.
    - name: compare-branches
      description: Compare branches
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: strings-branches.branchcompare
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: create-comparison-async
      description: Create comparison (async.)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: strings-branches.branchcomparisoncreate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: merge-branch
      description: Merge a branch
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-branches.branchmerge
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sync-branch
      description: Sync a branch
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: strings-branches.branchsync
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.