VA Benefits Intake API — UploadStatus

naftiko: 1.0.0-alpha2
info:
  label: VA Benefits Intake API — UploadStatus
  description: 'VA Benefits Intake API — UploadStatus. 2 operations. Lead operation: Bulk status report for multiple GUIDs.
    Self-contained Naftiko capability covering one Department Of Veterans Affairs business surface.'
  tags:
  - Department Of Veterans Affairs
  - UploadStatus
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    DEPARTMENT_OF_VETERANS_AFFAIRS_API_KEY: DEPARTMENT_OF_VETERANS_AFFAIRS_API_KEY
capability:
  consumes:
  - type: http
    namespace: va-benefits-intake-uploadstatus
    baseUri: https://sandbox-api.va.gov/services/vba_documents/v1
    description: VA Benefits Intake API — UploadStatus business capability. Self-contained, no shared references.
    resources:
    - name: uploads-report
      path: /uploads/report
      operations:
      - name: bulkstatusreport
        method: POST
        description: Bulk status report for multiple GUIDs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: uploads-id
      path: /uploads/{id}
      operations:
      - name: getuploadstatus
        method: GET
        description: Get the status of an upload
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: apikey
      value: '{{env.DEPARTMENT_OF_VETERANS_AFFAIRS_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: va-benefits-intake-uploadstatus-rest
    port: 8080
    description: REST adapter for VA Benefits Intake API — UploadStatus. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/uploads/report
      name: uploads-report
      description: REST surface for uploads-report.
      operations:
      - method: POST
        name: bulkstatusreport
        description: Bulk status report for multiple GUIDs
        call: va-benefits-intake-uploadstatus.bulkstatusreport
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/uploads/{id}
      name: uploads-id
      description: REST surface for uploads-id.
      operations:
      - method: GET
        name: getuploadstatus
        description: Get the status of an upload
        call: va-benefits-intake-uploadstatus.getuploadstatus
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: va-benefits-intake-uploadstatus-mcp
    port: 9090
    transport: http
    description: MCP adapter for VA Benefits Intake API — UploadStatus. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: bulk-status-report-multiple-guids
      description: Bulk status report for multiple GUIDs
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: va-benefits-intake-uploadstatus.bulkstatusreport
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-status-upload
      description: Get the status of an upload
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: va-benefits-intake-uploadstatus.getuploadstatus
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.