Account Management OpenAPI Specification — Allowance Compliance

naftiko: 1.0.0-alpha2
info:
  label: Account Management OpenAPI Specification — Allowance Compliance
  description: 'Allowance Compliance. 3 operations. Lead operation: operations. Self-contained Naftiko capability covering one EPA business surface.'
  tags:
    - EPA
    - Allowance Compliance
  created: '2026-05-29'
  modified: '2026-05-29'
binds:
  - namespace: env
    keys:
      EPA_APIKEY_KEY: EPA_APIKEY_KEY
capability:
  consumes:
    - type: http
      namespace: cam-account-allowance-compliance
      baseUri: https://api.epa.gov/easey
      description: Account Management OpenAPI Specification — Allowance Compliance business capability. Self-contained, no shared references.
      authentication:
        type: apikey
        key: x-api-key
        value: '{{env.EPA_APIKEY_KEY}}'
        placement: header
      resources:
        - name: account-mgmt-allowance-compliance
          path: /account-mgmt/allowance-compliance
          operations:
            - name: allowanceComplianceControllergetAllowanceCompliance
              method: GET
              description: allowanceComplianceControllergetAllowanceCompliance
              inputParameters:
                - name: stateCode
                  in: query
                  type: array
                  required: false
                  description: Two letter abbreviation for the State.
                - name: facilityId
                  in: query
                  type: array
                  required: false
                  description: The Facility ID code assigned by the Department of Energy's Energy Information Administration. The Energy Information Administration Plant ID code is also referred to as the "ORIS code", "ORISPL code"
                - name: ownerOperator
                  in: query
                  type: array
                  required: false
                  description: The name of any company that owns an allowance account or an affected unit.The name of any company that operates an affected unit.
                - name: programCodeInfo
                  in: query
                  type: array
                  required: false
                  description: Statutory or regulatory based options for tracking and reducing air pollution emissions.
                - name: year
                  in: query
                  type: array
                  required: false
                  description: The calendar year during which activity occurred.
                - name: page
                  in: query
                  type: number
                  required: true
                  description: Page number of data being requested.
                - name: perPage
                  in: query
                  type: number
                  required: true
                  description: Number of results per page.
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: account-mgmt-allowance-compliance-attributes-applicable
          path: /account-mgmt/allowance-compliance/attributes/applicable
          operations:
            - name: allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes
              method: GET
              description: allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes
              inputParameters: []
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
        - name: account-mgmt-allowance-compliance-owner-operators
          path: /account-mgmt/allowance-compliance/owner-operators
          operations:
            - name: allowanceComplianceControllergetAllOwnerOperators
              method: GET
              description: allowanceComplianceControllergetAllOwnerOperators
              inputParameters: []
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
  exposes:
    - type: rest
      namespace: cam-account-allowance-compliance-rest
      port: 8080
      description: REST adapter for Account Management OpenAPI Specification — Allowance Compliance. One Spectral-compliant resource per consumed operation, prefixed with /v1.
      resources:
        - path: /v1/account-mgmt/allowance-compliance
          name: account-mgmt-allowance-compliance
          description: REST surface for allowanceComplianceControllergetAllowanceCompliance.
          operations:
            - method: GET
              name: allowanceComplianceControllergetAllowanceCompliance
              description: allowanceComplianceControllergetAllowanceCompliance
              call: cam-account-allowance-compliance.allowanceComplianceControllergetAllowanceCompliance
              with:
                stateCode: rest.stateCode
                facilityId: rest.facilityId
                ownerOperator: rest.ownerOperator
                programCodeInfo: rest.programCodeInfo
                year: rest.year
                page: rest.page
                perPage: rest.perPage
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/account-mgmt/allowance-compliance/attributes/applicable
          name: account-mgmt-allowance-compliance-attributes-applicable
          description: REST surface for allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes.
          operations:
            - method: GET
              name: allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes
              description: allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes
              call: cam-account-allowance-compliance.allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes
              with: {}
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/account-mgmt/allowance-compliance/owner-operators
          name: account-mgmt-allowance-compliance-owner-operators
          description: REST surface for allowanceComplianceControllergetAllOwnerOperators.
          operations:
            - method: GET
              name: allowanceComplianceControllergetAllOwnerOperators
              description: allowanceComplianceControllergetAllOwnerOperators
              call: cam-account-allowance-compliance.allowanceComplianceControllergetAllOwnerOperators
              with: {}
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: cam-account-allowance-compliance-mcp
      port: 9090
      transport: http
      description: MCP adapter for Account Management OpenAPI Specification — Allowance Compliance. One tool per consumed operation, routed inline through this capability's consumes block.
      tools:
        - name: allowancecompliancecontroller-getallowancecompliance
          description: allowancecompliancecontroller-getallowancecompliance
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: cam-account-allowance-compliance.allowanceComplianceControllergetAllowanceCompliance
          with:
            stateCode: tools.stateCode
            facilityId: tools.facilityId
            ownerOperator: tools.ownerOperator
            programCodeInfo: tools.programCodeInfo
            year: tools.year
            page: tools.page
            perPage: tools.perPage
          outputParameters:
            - type: object
              mapping: $.
        - name: allowancecompliancecontroller-getallapplicableallowancecomplianceattributes
          description: allowancecompliancecontroller-getallapplicableallowancecomplianceattributes
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: cam-account-allowance-compliance.allowanceComplianceControllergetAllApplicableAllowanceComplianceAttributes
          with: {}
          outputParameters:
            - type: object
              mapping: $.
        - name: allowancecompliancecontroller-getallowneroperators
          description: allowancecompliancecontroller-getallowneroperators
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: cam-account-allowance-compliance.allowanceComplianceControllergetAllOwnerOperators
          with: {}
          outputParameters:
            - type: object
              mapping: $.