Postman Inspect Collection Contents

arazzo: 1.0.1
info:
  title: Postman Inspect Collection Contents
  summary: Read a collection's requests, folders, and saved example responses.
  description: >-
    A read-only audit pattern for understanding what a collection contains. The
    workflow fetches the collection definition, then enumerates its requests,
    folders, and saved example responses so callers can build an inventory of
    the collection's structure. Each 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: collectionsApi
  url: ../openapi/postman-collections-api-openapi.yml
  type: openapi
workflows:
- workflowId: inspect-collection-contents
  summary: Enumerate a collection's definition, requests, folders, and responses.
  description: >-
    Reads a collection and then lists its requests, folders, and saved example
    responses for a complete read-only inventory.
  inputs:
    type: object
    required:
    - collectionId
    properties:
      collectionId:
        type: string
        description: The collection's unique ID or UID to inspect.
  steps:
  - stepId: getCollection
    description: >-
      Fetch the full collection definition including metadata and items.
    operationId: getCollection
    parameters:
    - name: collectionId
      in: path
      value: $inputs.collectionId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      name: $response.body#/collection/info/name
  - stepId: listRequests
    description: >-
      List all requests in the collection with their method and URL metadata.
    operationId: getCollectionRequests
    parameters:
    - name: collectionId
      in: path
      value: $inputs.collectionId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      requests: $response.body#/data
  - stepId: listFolders
    description: >-
      List all folders in the collection along with their hierarchy metadata.
    operationId: getCollectionFolders
    parameters:
    - name: collectionId
      in: path
      value: $inputs.collectionId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      folders: $response.body#/data
  - stepId: listResponses
    description: >-
      List all saved example responses in the collection.
    operationId: getCollectionResponses
    parameters:
    - name: collectionId
      in: path
      value: $inputs.collectionId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      responses: $response.body#/data
  outputs:
    name: $steps.getCollection.outputs.name
    requests: $steps.listRequests.outputs.requests
    folders: $steps.listFolders.outputs.folders
    responses: $steps.listResponses.outputs.responses