FOSSology API — info

naftiko: 1.0.0-alpha2
info:
  label: FOSSology API — info
  description: 'FOSSology API — info. 4 operations. Lead operation: Get the Banner message. Self-contained Naftiko capability
    covering one Fossology business surface.'
  tags:
  - Fossology
  - info
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FOSSOLOGY_API_KEY: FOSSOLOGY_API_KEY
capability:
  consumes:
  - type: http
    namespace: fossology-info
    baseUri: http://localhost/repo/api/v1
    description: FOSSology API — info business capability. Self-contained, no shared references.
    resources:
    - name: customise-banner
      path: /customise/banner
      operations:
      - name: getbannermessage
        method: GET
        description: Get the Banner message
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: health
      path: /health
      operations:
      - name: gethealth
        method: GET
        description: Get the status of API service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: info
      path: /info
      operations:
      - name: getinfo
        method: GET
        description: Get the current API information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: openapi
      path: /openapi
      operations:
      - name: getopenapi
        method: GET
        description: Get the current openapi.yaml file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.FOSSOLOGY_API_KEY}}'
  exposes:
  - type: rest
    namespace: fossology-info-rest
    port: 8080
    description: REST adapter for FOSSology API — info. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/customise/banner
      name: customise-banner
      description: REST surface for customise-banner.
      operations:
      - method: GET
        name: getbannermessage
        description: Get the Banner message
        call: fossology-info.getbannermessage
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/health
      name: health
      description: REST surface for health.
      operations:
      - method: GET
        name: gethealth
        description: Get the status of API service
        call: fossology-info.gethealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/info
      name: info
      description: REST surface for info.
      operations:
      - method: GET
        name: getinfo
        description: Get the current API information
        call: fossology-info.getinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/openapi
      name: openapi
      description: REST surface for openapi.
      operations:
      - method: GET
        name: getopenapi
        description: Get the current openapi.yaml file
        call: fossology-info.getopenapi
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fossology-info-mcp
    port: 9090
    transport: http
    description: MCP adapter for FOSSology API — info. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-banner-message
      description: Get the Banner message
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-info.getbannermessage
      outputParameters:
      - type: object
        mapping: $.
    - name: get-status-api-service
      description: Get the status of API service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-info.gethealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-current-api-information
      description: Get the current API information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-info.getinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: get-current-openapi-yaml-file
      description: Get the current openapi.yaml file
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fossology-info.getopenapi
      outputParameters:
      - type: object
        mapping: $.