Postman · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Postman Mocks API

14 actions 14 updates phrasing extends openapi/postman-mocks-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 14

$.info
$.paths['/mocks'].get
$.paths['/mocks'].post
$.paths['/mocks/{mockId}'].get
$.paths['/mocks/{mockId}'].put
$.paths['/mocks/{mockId}'].delete
$.paths['/mocks/{mockId}/call-logs'].get
$.paths['/mocks/{mockId}/publish'].post
$.paths['/mocks/{mockId}/unpublish'].delete
$.paths['/mocks/{mockId}/server-responses'].get
$.paths['/mocks/{mockId}/server-responses'].post
$.paths['/mocks/{mockId}/server-responses/{serverResponseId}'].get
$.paths['/mocks/{mockId}/server-responses/{serverResponseId}'].put
$.paths['/mocks/{mockId}/server-responses/{serverResponseId}'].delete

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 Mocks API
  version: 1.0.0
extends: openapi/postman-mocks-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: 13
- target: $.paths['/mocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List mock servers
      effect: read
      questions:
      - Which mock servers are currently active?
      - Can I list only the mock servers in one workspace or team?
      instructions:
      - text: List my active mock servers.
      - text: List the mock servers in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Show the mock servers belonging to team {teamId}.
        slots:
          teamId: query.teamId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a mock server for a collection
      effect: write
      questions:
      - How do I spin up a mock server from a collection?
      - Can I create a mock for a collection that's attached to an API definition?
      instructions:
      - text: Create a mock server in workspace {workspace}.
        slots:
          workspace: query.workspace
      - text: Create mock server {mock} in workspace {workspace}.
        slots:
          mock: requestBody.mock
          workspace: query.workspace
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mock server
      effect: read
      questions:
      - What's the URL and configuration of a particular mock server?
      - Can I look up which collection a mock server is based on?
      instructions:
      - text: Get mock server {mockId}.
        slots:
          mockId: path.mockId
      - text: Show the settings of mock {mockId}.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a mock server
      effect: write
      questions:
      - Can I rename a mock server or point it at a different collection?
      - How do I change a mock server's settings?
      instructions:
      - text: Update mock server {mockId} with {mock}.
        slots:
          mockId: path.mockId
          mock: requestBody.mock
      - text: Rename mock server {mockId}.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a mock server
      effect: destructive
      questions:
      - How do I get rid of a mock server I don't use anymore?
      - Can I delete a mock server through the API?
      instructions:
      - text: Delete mock server {mockId}.
        slots:
          mockId: path.mockId
      - text: Remove the mock {mockId} permanently.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/call-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a mock server's call logs
      effect: read
      questions:
      - What requests has my mock server received and what did it return?
      - Can I filter mock call logs by status code, method or path?
      - How many call logs come back in one call?
      instructions:
      - text: Show the call logs for mock server {mockId}.
        slots:
          mockId: path.mockId
      - text: Show mock {mockId} calls that returned status {responseStatusCode}.
        slots:
          mockId: path.mockId
          responseStatusCode: query.responseStatusCode
      - text: List {requestMethod} calls to path {requestPath} on mock {mockId}.
        slots:
          requestMethod: query.requestMethod
          requestPath: query.requestPath
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a mock server public
      effect: write
      questions:
      - How do I make a mock server publicly accessible?
      - What does publishing a mock server change in its access control?
      instructions:
      - text: Publish mock server {mockId}.
        slots:
          mockId: path.mockId
      - text: Set the access control of mock {mockId} to public.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/unpublish'].delete
  update:
    x-apievangelist-phrasing:
      intent: Make a mock server private
      effect: destructive
      questions:
      - Can I make a public mock server private again?
      - How do I stop a mock server from being publicly reachable?
      instructions:
      - text: Unpublish mock server {mockId}.
        slots:
          mockId: path.mockId
      - text: Switch mock {mockId} access control back to private.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/server-responses'].get
  update:
    x-apievangelist-phrasing:
      intent: List a mock server's simulated server errors
      effect: read
      questions:
      - What simulated 5xx server responses are set up on this mock?
      - Can I list every server response configured for a mock server?
      instructions:
      - text: List the server responses on mock {mockId}.
        slots:
          mockId: path.mockId
      - text: Show all simulated server errors configured for mock {mockId}.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/server-responses'].post
  update:
    x-apievangelist-phrasing:
      intent: Simulate a 5xx error on a mock server
      effect: write
      questions:
      - Can a mock server simulate a 500 or 503 outage?
      - How do I test how my app handles server-level errors with a mock?
      instructions:
      - text: Add a server response {serverResponse} to mock {mockId}.
        slots:
          serverResponse: requestBody.serverResponse
          mockId: path.mockId
      - text: Make mock {mockId} simulate a 503 server error.
        slots:
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/server-responses/{serverResponseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one simulated server response
      effect: read
      questions:
      - How do I see the details of one simulated server response on a mock?
      - Which status code does a given mock server response return?
      instructions:
      - text: Get server response {serverResponseId} on mock {mockId}.
        slots:
          serverResponseId: path.serverResponseId
          mockId: path.mockId
      - text: Show the status code of server response {serverResponseId} in mock {mockId}.
        slots:
          serverResponseId: path.serverResponseId
          mockId: path.mockId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/server-responses/{serverResponseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a simulated server response
      effect: write
      questions:
      - Can I change the status code of an existing simulated server error?
      - How do I edit a server response already set on a mock?
      instructions:
      - text: Update server response {serverResponseId} on mock {mockId} with {serverResponse}.
        slots:
          serverResponseId: path.serverResponseId
          mockId: path.mockId
          serverResponse: requestBody.serverResponse
      - text: Change mock {mockId}'s server response {serverResponseId} to return a 500.
        slots:
          mockId: path.mockId
          serverResponseId: path.serverResponseId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mocks/{mockId}/server-responses/{serverResponseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a simulated server response
      effect: destructive
      questions:
      - How do I stop a mock from returning a simulated server error?
      - Can I delete one server response from a mock server?
      instructions:
      - text: Delete server response {serverResponseId} from mock {mockId}.
        slots:
          serverResponseId: path.serverResponseId
          mockId: path.mockId
      - text: Remove the simulated error {serverResponseId} on mock {mockId}.
        slots:
          serverResponseId: path.serverResponseId
          mockId: path.mockId
      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-mocks-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.