Adobe PDF Services Auto-tag PDF for Accessibility

arazzo: 1.0.1
info:
  title: Adobe PDF Services Auto-tag PDF for Accessibility
  summary: Upload a PDF, auto-tag it for accessibility, poll the job, and get the tagged output download URI.
  description: >-
    Automatically adds accessibility tags to a PDF to make it compliant with
    PDF/UA and WCAG standards, using the Adobe PDF Services asynchronous job
    model. The workflow registers the source PDF by requesting an upload asset,
    submits an auto-tag operation, polls the operation status until it is done
    or failed, and resolves a temporary download URI for the tagged output.
    Every step spells out its request inline so the flow can be read and
    executed without opening the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: accessibilityApi
  url: ../openapi/adobe-creative-suite-accessibility-api-openapi.yml
  type: openapi
- name: assetsApi
  url: ../openapi/adobe-creative-suite-assets-api-openapi.yml
  type: openapi
- name: operationsApi
  url: ../openapi/adobe-creative-suite-operations-api-openapi.yml
  type: openapi
workflows:
- workflowId: autotag-pdf
  summary: Upload a PDF, auto-tag it for accessibility, and resolve the tagged download URI.
  description: >-
    Registers a source PDF asset, submits an auto-tag operation, polls the job to
    a terminal state, and returns the download URI of the accessibility-tagged
    PDF on success.
  inputs:
    type: object
    properties:
      generateReport:
        type: boolean
        description: Whether to generate an accessibility report alongside the tagged PDF.
      shiftHeadings:
        type: boolean
        description: Whether to shift heading levels for better document structure.
  steps:
  - stepId: createUpload
    description: Request an upload asset for the source PDF to auto-tag.
    operationId: uploadAsset
    requestBody:
      contentType: application/json
      payload:
        mediaType: application/pdf
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      assetID: $response.body#/assetID
      uploadUri: $response.body#/uploadUri
  - stepId: submitAutoTag
    description: >-
      Submit an auto-tag operation against the uploaded PDF asset. The API
      returns a job id for polling.
    operationId: autoTagPDF
    requestBody:
      contentType: application/json
      payload:
        assetID: $steps.createUpload.outputs.assetID
        generateReport: $inputs.generateReport
        shiftHeadings: $inputs.shiftHeadings
    successCriteria:
    - condition: $statusCode == 201
    outputs:
      jobID: $response.body#/jobID
  - stepId: pollOperation
    description: >-
      Poll the auto-tag operation status, repeating while it is in progress and
      branching once it is done or failed.
    operationId: getOperationStatus
    parameters:
    - name: jobId
      in: path
      value: $steps.submitAutoTag.outputs.jobID
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      status: $response.body#/status
      assetID: $response.body#/asset/assetID
    onSuccess:
    - name: operationDone
      type: goto
      stepId: getOutput
      criteria:
      - context: $response.body
        condition: $.status == "done"
        type: jsonpath
    - name: operationFailed
      type: goto
      stepId: reportFailure
      criteria:
      - context: $response.body
        condition: $.status == "failed"
        type: jsonpath
    - name: stillRunning
      type: retry
      stepId: pollOperation
      retryAfter: 5
      retryLimit: 30
      criteria:
      - context: $response.body
        condition: $.status == "in progress"
        type: jsonpath
  - stepId: getOutput
    description: >-
      Retrieve the tagged PDF asset metadata and a fresh temporary download URI
      for the output file.
    operationId: getAsset
    parameters:
    - name: assetID
      in: path
      value: $steps.pollOperation.outputs.assetID
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      downloadUri: $response.body#/downloadUri
      size: $response.body#/size
    onSuccess:
    - name: done
      type: end
  - stepId: reportFailure
    description: Surface the error details from the failed auto-tag operation.
    operationId: getOperationStatus
    parameters:
    - name: jobId
      in: path
      value: $steps.submitAutoTag.outputs.jobID
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      errors: $response.body#/errors
  outputs:
    sourceAssetID: $steps.createUpload.outputs.assetID
    jobID: $steps.submitAutoTag.outputs.jobID
    outputDownloadUri: $steps.getOutput.outputs.downloadUri
    errors: $steps.reportFailure.outputs.errors