Harbor Compliance API — Entities

naftiko: 1.0.0-alpha2
info:
  label: Harbor Compliance API — Entities
  description: 'Harbor Compliance API — Entities. 5 operations. Lead operation: Harbor Compliance List business entities.
    Self-contained Naftiko capability covering one Harbor Compliance business surface.'
  tags:
  - Harbor Compliance
  - Entities
  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-entities
    baseUri: https://api.harborcompliance.com/v1
    description: Harbor Compliance API — Entities business capability. Self-contained, no shared references.
    resources:
    - name: entities
      path: /entities
      operations:
      - name: listentities
        method: GET
        description: Harbor Compliance List business entities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: state
          in: query
          type: string
          description: Filter entities by state of formation (two-letter state code).
        - name: entity_type
          in: query
          type: string
          description: Filter by entity type.
        - name: status
          in: query
          type: string
          description: Filter by entity status.
      - name: createentity
        method: POST
        description: Harbor Compliance Create a business entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: entities-entityId
      path: /entities/{entityId}
      operations:
      - name: getentity
        method: GET
        description: Harbor Compliance Get a business entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateentity
        method: PATCH
        description: Harbor Compliance Update a business entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - 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: $.
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.HARBOR_COMPLIANCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: harbor-compliance-entities-rest
    port: 8080
    description: REST adapter for Harbor Compliance API — Entities. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/entities
      name: entities
      description: REST surface for entities.
      operations:
      - method: GET
        name: listentities
        description: Harbor Compliance List business entities
        call: harbor-compliance-entities.listentities
        with:
          state: rest.state
          entity_type: rest.entity_type
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createentity
        description: Harbor Compliance Create a business entity
        call: harbor-compliance-entities.createentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/entities/{entityid}
      name: entities-entityid
      description: REST surface for entities-entityId.
      operations:
      - method: GET
        name: getentity
        description: Harbor Compliance Get a business entity
        call: harbor-compliance-entities.getentity
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateentity
        description: Harbor Compliance Update a business entity
        call: harbor-compliance-entities.updateentity
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - 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-entities.getentitycompliance
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: harbor-compliance-entities-mcp
    port: 9090
    transport: http
    description: MCP adapter for Harbor Compliance API — Entities. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: harbor-compliance-list-business-entities
      description: Harbor Compliance List business entities
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance-entities.listentities
      with:
        state: tools.state
        entity_type: tools.entity_type
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: harbor-compliance-create-business-entity
      description: Harbor Compliance Create a business entity
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: harbor-compliance-entities.createentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: harbor-compliance-get-business-entity
      description: Harbor Compliance Get a business entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: harbor-compliance-entities.getentity
      outputParameters:
      - type: object
        mapping: $.
    - name: harbor-compliance-update-business-entity
      description: Harbor Compliance Update a business entity
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: harbor-compliance-entities.updateentity
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - 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-entities.getentitycompliance
      outputParameters:
      - type: object
        mapping: $.