FactSet BookBuilder API — Documents

naftiko: 1.0.0-alpha2
info:
  label: FactSet BookBuilder API — Documents
  description: 'FactSet BookBuilder API — Documents. 1 operations. Lead operation: Factset Upload a Custom Document. Self-contained
    Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: bookbuilder-documents
    baseUri: https://api.factset.com/book-builder-api
    description: FactSet BookBuilder API — Documents business capability. Self-contained, no shared references.
    resources:
    - name: v1-upload-custom-document
      path: /v1/upload-custom-document
      operations:
      - name: post
        method: POST
        description: Factset Upload a Custom Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: bookbuilder-documents-rest
    port: 8080
    description: REST adapter for FactSet BookBuilder API — Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/upload-custom-document
      name: v1-upload-custom-document
      description: REST surface for v1-upload-custom-document.
      operations:
      - method: POST
        name: post
        description: Factset Upload a Custom Document
        call: bookbuilder-documents.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: bookbuilder-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet BookBuilder API — Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: factset-upload-custom-document
      description: Factset Upload a Custom Document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: bookbuilder-documents.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.