Amazon Well-Architected Tool List Milestone Snapshots

arazzo: 1.0.1
info:
  title: Amazon Well-Architected Tool List Milestone Snapshots
  summary: List a workload's milestones and read the most recent one in detail.
  description: >-
    Review the milestone history of a workload by paginating the milestone
    summaries and then drilling into the most recent snapshot. The workflow
    lists the milestone summaries for the workload and retrieves the full
    milestone for the supplied milestone number. 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: wellArchitectedApi
  url: ../openapi/amazon-well-architected-tool-openapi-original.yaml
  type: openapi
workflows:
- workflowId: list-milestone-snapshots
  summary: List milestone summaries for a workload and fetch one in detail.
  description: >-
    Lists the milestone summaries recorded against a workload and then retrieves
    the full milestone for the supplied milestone number so its review state can
    be inspected.
  inputs:
    type: object
    required:
    - WorkloadId
    - MilestoneNumber
    properties:
      WorkloadId:
        type: string
        description: The 32-character workload ID.
      MilestoneNumber:
        type: integer
        description: The milestone number to retrieve in detail.
      MaxResults:
        type: integer
        description: The maximum number of milestone summaries to return.
  steps:
  - stepId: listMilestones
    description: >-
      List the milestone summaries recorded against the workload to review its
      snapshot history.
    operationId: ListMilestones
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    requestBody:
      contentType: application/json
      payload:
        MaxResults: $inputs.MaxResults
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      milestoneSummaries: $response.body#/MilestoneSummaries
  - stepId: getMilestone
    description: >-
      Retrieve the full milestone for the supplied milestone number to inspect
      its captured review state.
    operationId: GetMilestone
    parameters:
    - name: WorkloadId
      in: path
      value: $inputs.WorkloadId
    - name: MilestoneNumber
      in: path
      value: $inputs.MilestoneNumber
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      milestone: $response.body#/Milestone
  outputs:
    milestoneSummaries: $steps.listMilestones.outputs.milestoneSummaries
    milestone: $steps.getMilestone.outputs.milestone