FactSet Portfolio Metadata API — Returns

naftiko: 1.0.0-alpha2
info:
  label: FactSet Portfolio Metadata API — Returns
  description: 'FactSet Portfolio Metadata API — Returns. 2 operations. Lead operation: Returns. Self-contained Naftiko capability
    covering one Factset business surface.'
  tags:
  - Factset
  - Returns
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: portfolio-metadata-returns
    baseUri: https://api.factset.com/analytics/portfolio-metadata/v1
    description: FactSet Portfolio Metadata API — Returns business capability. Self-contained, no shared references.
    resources:
    - name: returns-composite-id
      path: /returns-composite/{id}
      operations:
      - name: readreturnscomposite
        method: GET
        description: Read a returns composite
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the returns composite to be read
          required: true
    - name: returns-id
      path: /returns/{id}
      operations:
      - name: readreturns
        method: GET
        description: Read a returns
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Unique identifier of the returns to be read
          required: true
    authentication:
      type: bearer
      token: '{{env.FACTSET_API_KEY}}'
  exposes:
  - type: rest
    namespace: portfolio-metadata-returns-rest
    port: 8080
    description: REST adapter for FactSet Portfolio Metadata API — Returns. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/returns-composite/{id}
      name: returns-composite-id
      description: REST surface for returns-composite-id.
      operations:
      - method: GET
        name: readreturnscomposite
        description: Read a returns composite
        call: portfolio-metadata-returns.readreturnscomposite
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/returns/{id}
      name: returns-id
      description: REST surface for returns-id.
      operations:
      - method: GET
        name: readreturns
        description: Read a returns
        call: portfolio-metadata-returns.readreturns
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portfolio-metadata-returns-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet Portfolio Metadata API — Returns. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: read-returns-composite
      description: Read a returns composite
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portfolio-metadata-returns.readreturnscomposite
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: read-returns
      description: Read a returns
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portfolio-metadata-returns.readreturns
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.