FactSet IRN Configuration API — Subjects

naftiko: 1.0.0-alpha2
info:
  label: FactSet IRN Configuration API — Subjects
  description: 'FactSet IRN Configuration API — Subjects. 2 operations. Lead operation: Factset Get All Subjects. Self-contained
    Naftiko capability covering one Factset business surface.'
  tags:
  - Factset
  - Subjects
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FACTSET_API_KEY: FACTSET_API_KEY
capability:
  consumes:
  - type: http
    namespace: irn-configuration-subjects
    baseUri: https://api.factset.com/research/irn
    description: FactSet IRN Configuration API — Subjects business capability. Self-contained, no shared references.
    resources:
    - name: v1-subjects
      path: /v1/subjects
      operations:
      - name: getsubjects
        method: GET
        description: Factset Get All Subjects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-IRN-Ignore-Permissions
          in: header
          type: boolean
    - name: v1-subjects-subjectId
      path: /v1/subjects/{subjectId}
      operations:
      - name: getsubject
        method: GET
        description: Factset Get Subject Details for the Given Id Provided
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subjectId
          in: path
          type: string
          description: Id
          required: true
        - name: X-IRN-Ignore-Permissions
          in: header
          type: boolean
    authentication:
      type: basic
      username: '{{env.FACTSET_USER}}'
      password: '{{env.FACTSET_PASS}}'
  exposes:
  - type: rest
    namespace: irn-configuration-subjects-rest
    port: 8080
    description: REST adapter for FactSet IRN Configuration API — Subjects. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/subjects
      name: v1-subjects
      description: REST surface for v1-subjects.
      operations:
      - method: GET
        name: getsubjects
        description: Factset Get All Subjects
        call: irn-configuration-subjects.getsubjects
        with:
          X-IRN-Ignore-Permissions: rest.X-IRN-Ignore-Permissions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/subjects/{subjectid}
      name: v1-subjects-subjectid
      description: REST surface for v1-subjects-subjectId.
      operations:
      - method: GET
        name: getsubject
        description: Factset Get Subject Details for the Given Id Provided
        call: irn-configuration-subjects.getsubject
        with:
          subjectId: rest.subjectId
          X-IRN-Ignore-Permissions: rest.X-IRN-Ignore-Permissions
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: irn-configuration-subjects-mcp
    port: 9090
    transport: http
    description: MCP adapter for FactSet IRN Configuration API — Subjects. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: factset-get-all-subjects
      description: Factset Get All Subjects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-subjects.getsubjects
      with:
        X-IRN-Ignore-Permissions: tools.X-IRN-Ignore-Permissions
      outputParameters:
      - type: object
        mapping: $.
    - name: factset-get-subject-details-given
      description: Factset Get Subject Details for the Given Id Provided
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: irn-configuration-subjects.getsubject
      with:
        subjectId: tools.subjectId
        X-IRN-Ignore-Permissions: tools.X-IRN-Ignore-Permissions
      outputParameters:
      - type: object
        mapping: $.