naftiko: 1.0.0-alpha2
info:
  label: "Ironclad Public API \u2014 Obligations"
  description: "Ironclad Public API \u2014 Obligations. 4 operations across 2 resource paths. Self-contained Naftiko capability\
    \ covering the Ironclad Obligations business surface."
  tags:
  - Ironclad
  - Obligations
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    IRONCLAD_ACCESS_TOKEN: IRONCLAD_ACCESS_TOKEN
capability:
  consumes:
  - type: http
    namespace: obligations
    baseUri: https://na1.ironcladapp.com/public/api/v1
    description: Ironclad Obligations business capability.
    resources:
    - name: obligations
      path: /obligations
      operations: &id001
      - name: list-all-obligations
        method: GET
        description: List All Obligations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters: []
      - name: create-an-obligation
        method: POST
        description: Create an Obligation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: obligations-id
      path: /obligations/{id}
      operations: &id002
      - name: retrieve-an-obligation
        method: GET
        description: Retrieve an Obligation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID or Ironclad ID of the Obligation to fetch.
          required: true
      - name: update-an-obligation
        method: PATCH
        description: Update an Obligation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID or Ironclad ID of the Obligation to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: Bearer {{env.IRONCLAD_ACCESS_TOKEN}}
      placement: header
  exposes:
  - type: rest
    namespace: obligations-rest
    port: 8080
    description: REST adapter for Ironclad Obligations. One resource per consumed operation.
    resources:
    - name: obligations
      path: /v1/obligations
      operations: *id001
    - name: obligations-id
      path: /v1/obligations/{id}
      operations: *id002