Harbor Compliance API — Compliance Filings

naftiko: 1.0.0-alpha2
info:
  label: Harbor Compliance API — Compliance Filings
  description: 'Harbor Compliance API — Compliance Filings. 3 operations. Lead operation: Harbor Compliance Get compliance
    status for an entity. Self-contained Naftiko capability covering one Harbor Compliance business surface.'
  tags:
  - Harbor Compliance
  - Compliance Filings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HARBOR_COMPLIANCE_API_KEY: HARBOR_COMPLIANCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: harbor-compliance-compliance-filings
    baseUri: https://api.harborcompliance.com/v1
    description: Harbor Compliance API — Compliance Filings business capability. Self-contained, no shared references.
    resources:
    - name: entities-entityId-compliance
      path: /entities/{entityId}/compliance
      operations:
      - name: getentitycompliance
        method: GET
        description: Harbor Compliance Get compliance status for an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: filings
      path: /filings
      operations:
      - name: listfilings
        method: GET
        description: Harbor Compliance List compliance filings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: entity_id
          in: query
          type: string
          description: Filter filings by entity identifier.
        - name: state
          in: query
          type: string
          description: Filter filings by state jurisdiction.
        - name: status
          in: query
          type: string
          description: Filter by filing status.
        - name: due_before
          in: query
          type: string
          description: Filter filings due before this date (ISO 8601 date).
    - name: filings-filingId
      path: /filings/{filingId}
      operations:
      - name: getfiling
        method: GET
        description: Harbor Compliance Get a compliance filing
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.HARBOR_COMPLIANCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: harbor-compliance-compliance-filings-rest
    port: 8080
    description: REST adapter for Harbor Compliance API — Compliance Filings. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/entities/{entityid}/compliance
      name: entities-entityid-compliance
      description: REST surface for entities-entityId-compliance.
      operations:
      - method: GET
        name: getentitycompliance
        description: Harbor Compliance Get compliance status for an entity
        call: harbor-compliance-compliance-filings.getentitycompliance
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/filings
      name: filings
      description: REST surface for filings.
      operations:
      - method: GET
        name: listfilings
        description: Harbor Compliance List compliance filings
        call: harbor-compliance-compliance-filings.listfilings
        with:
          entity_id: rest.entity_id
          state: rest.state
          status: rest.status
          due_before: rest.due_before
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/filings/{filingid}
      name: filings-filingid
      description: REST surface for filings-filingId.
      operations:
      - method: GET
        name: getfiling
        description: Harbor Compliance Get a compliance filing
        call: harbor-compliance-compliance-filings.getfiling
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: harbor-compliance-compliance-filings-mcp
    port: 9090
    transport: http
    description: MCP adapter for Harbor Compliance API — Compliance Filings. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: harbor-compliance-get-compliance-status
      description: Harbor Compliance Get compliance status for an entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance-compliance-filings.getentitycompliance
      outputParameters:
      - type: object
        mapping: $.
    - name: harbor-compliance-list-compliance-filings
      description: Harbor Compliance List compliance filings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance-compliance-filings.listfilings
      with:
        entity_id: tools.entity_id
        state: tools.state
        status: tools.status
        due_before: tools.due_before
      outputParameters:
      - type: object
        mapping: $.
    - name: harbor-compliance-get-compliance-filing
      description: Harbor Compliance Get a compliance filing
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance-compliance-filings.getfiling
      outputParameters:
      - type: object
        mapping: $.