Postman · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postman Components API

10 actions 10 updates phrasing extends openapi/postman-components-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Postman's API. It is a proposal applied on top of the contract, not a document Postman publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/components'].get
$.paths['/components'].post
$.paths['/components/{componentId}'].get
$.paths['/components/{componentId}'].patch
$.paths['/components/{componentId}/drafts'].get
$.paths['/components/{componentId}/drafts'].patch
$.paths['/components/{componentId}/versions'].get
$.paths['/components/{componentId}/versions'].post
$.paths['/components/{componentId}/versions/{versionId}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Postman Components API
  version: 1.0.0
extends: openapi/postman-components-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List components in the team library
      effect: read
      questions:
      - What reusable components are in my team's component library?
      - Can I list only archived components, or only ones with published versions?
      instructions:
      - text: List all components in the team library.
      - text: Show {type} components with status {status}.
        slots:
          type: query.type
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reusable component
      effect: write
      questions:
      - How do I add a reusable schema component to the team library?
      - Is a new component published right away or does it start as a draft?
      instructions:
      - text: Create a {type} component named {name} with content {content}.
        slots:
          type: requestBody.type
          name: requestBody.name
          content: requestBody.content
      - text: Add component {name} of type {type} in {format} format containing {content}.
        slots:
          name: requestBody.name
          type: requestBody.type
          format: requestBody.format
          content: requestBody.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a component
      effect: read
      questions:
      - What is the status and latest published version of a component?
      - Can I expand a component to include whether it has versions?
      instructions:
      - text: Get component {componentId}.
        slots:
          componentId: path.componentId
      - text: Show component {componentId} expanded with {expand}.
        slots:
          componentId: path.componentId
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename, archive or reactivate a component
      effect: write
      questions:
      - How do I archive a component that is no longer used?
      - Can I rename a component that has been archived?
      instructions:
      - text: Archive component {componentId}.
        slots:
          componentId: path.componentId
      - text: Reactivate archived component {componentId}.
        slots:
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}/drafts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a component's unpublished draft
      effect: read
      questions:
      - What unpublished edits are sitting in a component's working draft?
      - How does a component's draft differ from its last published version?
      instructions:
      - text: Show the current draft of component {componentId}.
        slots:
          componentId: path.componentId
      - text: Get the unpublished working copy of component {componentId}.
        slots:
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}/drafts'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a component's draft
      effect: write
      questions:
      - How do I change a component's content before publishing a new version?
      - Can I edit the draft of an archived component?
      instructions:
      - text: Update the draft of component {componentId} with content {content}.
        slots:
          componentId: path.componentId
          content: requestBody.content
      - text: Save {content} as {format} in component {componentId}'s draft.
        slots:
          content: requestBody.content
          format: requestBody.format
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a component's published versions
      effect: read
      questions:
      - Which versions of a component have been published?
      - Can I see the release history of one reusable component?
      instructions:
      - text: List the published versions of component {componentId}.
        slots:
          componentId: path.componentId
      - text: Show the version history of component {componentId}.
        slots:
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a component version from its draft
      effect: write
      questions:
      - How do I publish the current draft of a component as a new version?
      - Can I publish a version of an archived component?
      instructions:
      - text: Publish component {componentId} as version {label}.
        slots:
          componentId: path.componentId
          label: requestBody.label
      - text: Release the draft of component {componentId} labelled {label}.
        slots:
          componentId: path.componentId
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/components/{componentId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one published component version
      effect: read
      questions:
      - What did a specific published version of a component contain?
      - Can I fetch an older component version by its ID?
      instructions:
      - text: Get version {versionId} of component {componentId}.
        slots:
          versionId: path.versionId
          componentId: path.componentId
      - text: Show the content of component {componentId} at published version {versionId}.
        slots:
          componentId: path.componentId
          versionId: path.versionId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/postman-components-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.