Amazon Well-Architected Tool Annotate Lens Review

arazzo: 1.0.1
info:
  title: Amazon Well-Architected Tool Annotate Lens Review
  summary: Read a lens review and record lens-level and pillar-level notes on it.
  description: >-
    Add reviewer commentary to a lens review on a workload. The workflow opens
    the lens review to confirm it is reviewable and then updates it with
    lens-level notes and per-pillar notes, returning the annotated review. 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: workloadsApi
  url: ../openapi/amazon-well-architected-tool-workloads-api-openapi.yml
  type: openapi
workflows:
- workflowId: annotate-lens-review
  summary: Fetch a lens review and update its notes.
  description: >-
    Reads the lens review for a workload and updates it with lens-level notes
    and per-pillar notes, returning the annotated lens review.
  inputs:
    type: object
    required:
    - WorkloadId
    - LensAlias
    properties:
      WorkloadId:
        type: string
        description: The 32-character workload ID.
      LensAlias:
        type: string
        description: The alias or ARN of the lens being reviewed.
      LensNotes:
        type: string
        description: The lens-level notes to record on the review.
      PillarNotes:
        type: object
        description: A map of pillar ID to notes for per-pillar commentary.
  steps:
  - stepId: getLensReview
    description: >-
      Open the lens review for the workload to confirm the lens is applied and
      reviewable.
    operationId: GetLensReview
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    - name: LensAlias
      in: path
      value: $inputs.LensAlias
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      lensReview: $response.body#/LensReview
  - stepId: updateLensReview
    description: >-
      Record lens-level notes and per-pillar notes on the lens review, returning
      the annotated review.
    operationId: UpdateLensReview
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    - name: LensAlias
      in: path
      value: $inputs.LensAlias
    requestBody:
      contentType: application/json
      payload:
        LensNotes: $inputs.LensNotes
        PillarNotes: $inputs.PillarNotes
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      lensReview: $response.body#/LensReview
  outputs:
    lensReview: $steps.updateLensReview.outputs.lensReview