Update to Postman
Snapshot Oct 24, 2026 · 12:56 UTC · version 0.4.0
Collection source: downloaded plugin package. These snapshots do not have a confirmed matching collection source. Differences in file lists alone do not establish changes to the package.
Instructions updated for api-documentation
Full description — Now says: Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation...
Observed in instructions or declared skills. Runtime behavior has not been tested.
Up to 3 plugins free · no card required.
All fields and original values.
Full description
Sep 30, 2026 · 23:09 UTC
Generate filesystem-first agent friendly api documentation that you can share with your teammates without hassle. Use when the user asks to "publish API docs," "generate documentation for this API," "put this on the API Network," "share ...
Oct 24, 2026 · 12:56 UTC
Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and...
Skill instructions
Sep 30, 2026 · 23:09 UTC
Generate filesystem-first agent friendly api documentation that you can share with your teammates without hassle. Use when the user asks to "publish API docs," "generate documentation for this API," "put this on the API Network," "share ...
Oct 24, 2026 · 12:56 UTC
Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and...
Compare saved observations
Download comparison JSONSKILL.md text changes
− removed · + added
--- before +++ after @@ -1,34 +1,47 @@ --- name: api-documentation -description: Generate filesystem-first agent friendly api documentation that you can share with your teammates without hassle. Use when the user asks to "publish API docs," "generate documentation for this API," "put this on the API Network," "share a docs link for this collection or spec," or "why do my docs look empty." +description: Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and mocks. Use for requests such as "publish API docs". --- -The bootstrap skill is a precursor to this one — it scaffolds the project with the directories documentation is stored in. # API Documentation -When working on any API task, the first step is to establish and capture the contract. -API documentation can be done in two predominant ways: -1. through a Postman collection, -2. with an OpenAPI spec -It is recommended to create both. They serve different, complementary use cases, and it takes only one command to convert from one to another. Start with creating a Postman collection in v3 format, **collection-schema-v3**. -Postman collections are very human-friendly and offer other capabilities like creating an API mock, monitor, SDK, or spec. - -Specs are vendor-neutral, stay in your repo, and can be linted against governance rules (if any) set by your organization. - -## Good practices for API design - -See [reference/rest-api-best-practices.md](reference/rest-api-best-practices.md) -for the practices well-documented APIs tend to already follow: resource -naming, HTTP method/status-code usage, error response shape, versioning, -pagination, filtering, auth, idempotency, and backward compatibility. A -spec or collection that already follows these renders documentation with -nothing left to fix. - -### Examples -Examples (in a Postman collection) are an excellent way to capture sample API responses. They are helpful because: -1. anyone can look at them to see how your API behaves, -2. they can be used to generate a mock from your collection in a single command. - -## Workflow -1. Establish the contract - refer to best practices. Don't just accept the user's ask - fight for the right API design. -2. Choose the instrument - Postman collection / OpenAPI spec - or both. Recommend using both to the user. Start with the Postman collection. +A maintained contract gives callers enough information to integrate without +reading the implementation. Keeping descriptions and examples beside the API +artifacts lets the same knowledge support documentation, tests, and mocks, +with changes reviewable alongside code. + +1. Start from the existing source of truth. An OpenAPI spec describes the + interface for tooling; a Postman collection adds runnable requests, + examples, and assertions. Maintain both when both uses matter, with an + explicit direction of generation or synchronization so they do not become + competing definitions. Local edits need **bootstrap** only when setup or + bindings are unresolved. +2. When the spec is authoritative, reuse its operations with + `postman spec generate collection <spec-path-or-id> -n "<collection-name>"`. + Inspect the generated result before replacing an existing collection: + maintained scripts and examples carry knowledge beyond endpoint shapes. +3. Describe what changes a caller's decision: required versus optional inputs, + auth and scopes, response guarantees, pagination, retryable failures, and + side effects. Derive guarantees from the agreed contract or verified + behavior; label unresolved design choices instead of inventing them. + Use [REST design guidance](reference/rest-api-best-practices.md) when a + design choice affects usability or compatibility, not to redesign an + unrelated interface while filling a documentation gap. +4. Save examples that clarify consequential cases, including relevant errors. + Examples become inputs for mocks as well as explanations for readers; + a success-only example can hide the failure path callers must handle. + Use **collection-schema-v3** for local collection edits and **variables** + to keep credentials out of reusable requests and examples. +5. Choose delivery by audience. Local artifacts support Git review; + publishing to the bound workspace makes them available to teammates with + access (see **bootstrap**). A workspace push does not itself publish a + public docs page or change permissions. For a public documentation link, + use **postman-mcp-server**'s documentation workflow and the available + publishing tool; establish the intended audience before public exposure. + +## Verification + +Check that the edited artifact parses and its examples agree with the +contract. For a publication, inspect the resulting page and report its actual +link and visibility; a successful upload alone does not show readers usable +documentation. State any behavior that remains undocumented or unverified.
Full technical diff · 2 changed fields
changed /description
"Generate filesystem-first agent friendly api documentation that you can share with your teammates without hassle. Use when the user asks to \"publish API docs,\" \"generate documentation for this API,\" \"put this on the API Network,\" \"share a docs link for this collection or spec,\" or \"why do my docs look empty.\""
"Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and mocks. Use for requests such as \"publish API docs\"."
changed /skill_md_contents
"---\nname: api-documentation\ndescription: Generate filesystem-first agent friendly api documentation that you can share with your teammates without hassle. Use when the user asks to \"publish API docs,\" \"generate documentation for this API,\" \"put this on the API Network,\" \"share a docs link for this collection or spec,\" or \"why do my docs look empty.\" \n---\nThe bootstrap skill is a precursor to this one — it scaffolds the project with the directories documentation is stored in.\n\n# API Documentation\nWhen working on any API task, the first step is to establish and capture the contract.\nAPI documentation can be done in two predominant ways:\n1. through a Postman collection,\n2. with an OpenAPI spec\n\nIt is recommended to create both. They serve different, complementary use cases, and it takes only one command to convert from one to another. Start with creating a Postman collection in v3 format, **collection-schema-v3**.\nPostman collections are very human-friendly and offer other capabilities like creating an API mock, monitor, SDK, or spec.\n\nSpecs are vendor-neutral, stay in your repo, and can be linted against governance rules (if any) set by your organization.\n\n## Good practices for API design\n\nSee [reference/rest-api-best-practices.md](reference/rest-api-best-practices.md)\nfor the practices well-documented APIs tend to already follow: resource\nnaming, HTTP method/status-code usage, error response shape, versioning,\npagination, filtering, auth, idempotency, and backward compatibility. A\nspec or collection that already follows these renders documentation with\nnothing left to fix.\n\n### Examples\nExamples (in a Postman collection) are an excellent way to capture sample API responses. They are helpful because:\n1. anyone can look at them to see how your API behaves,\n2. they can be used to generate a mock from your collection in a single command.\n\n## Workflow\n1. Establish the contract - refer to best practices. Don't just accept the user's ask - fight for the right API design.\n2. Choose the instrument - Postman collection / OpenAPI spec - or both. Recommend using both to the user. Start with the Postman collection.\n"
"---\nname: api-documentation\ndescription: Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and mocks. Use for requests such as \"publish API docs\".\n---\n\n# API Documentation\n\nA maintained contract gives callers enough information to integrate without\nreading the implementation. Keeping descriptions and examples beside the API\nartifacts lets the same knowledge support documentation, tests, and mocks,\nwith changes reviewable alongside code.\n\n1. Start from the existing source of truth. An OpenAPI spec describes the\n interface for tooling; a Postman collection adds runnable requests,\n examples, and assertions. Maintain both when both uses matter, with an\n explicit direction of generation or synchronization so they do not become\n competing definitions. Local edits need **bootstrap** only when setup or\n bindings are unresolved.\n2. When the spec is authoritative, reuse its operations with\n `postman spec generate collection <spec-path-or-id> -n \"<collection-name>\"`.\n Inspect the generated result before replacing an existing collection:\n maintained scripts and examples carry knowledge beyond endpoint shapes.\n3. Describe what changes a caller's decision: required versus optional inputs,\n auth and scopes, response guarantees, pagination, retryable failures, and\n side effects. Derive guarantees from the agreed contract or verified\n behavior; label unresolved design choices instead of inventing them.\n Use [REST design guidance](reference/rest-api-best-practices.md) when a\n design choice affects usability or compatibility, not to redesign an\n unrelated interface while filling a documentation gap.\n4. Save examples that clarify consequential cases, including relevant errors.\n Examples become inputs for mocks as well as explanations for readers;\n a success-only example can hide the failure path callers must handle.\n Use **collection-schema-v3** for local collection edits and **variables**\n to keep credentials out of reusable requests and examples.\n5. Choose delivery by audience. Local artifacts support Git review;\n publishing to the bound workspace makes them available to teammates with\n access (see **bootstrap**). A workspace push does not itself publish a\n public docs page or change permissions. For a public documentation link,\n use **postman-mcp-server**'s documentation workflow and the available\n publishing tool; establish the intended audience before public exposure.\n\n## Verification\n\nCheck that the edited artifact parses and its examples agree with the\ncontract. For a publication, inspect the resulting page and report its actual\nlink and visibility; a successful upload alone does not show readers usable\ndocumentation. State any behavior that remains undocumented or unverified.\n"
Full snapshot data
{
"description": "Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and mocks. Use for requests such as \"publish API docs\".",
"included_files": [
{
"relative_path": "reference/rest-api-best-practices.md",
"size_in_bytes": 2995
}
],
"name": "api-documentation",
"skill_md_contents": "---\nname: api-documentation\ndescription: Use when defining or improving an API contract, generating documentation from a collection or OpenAPI spec, publishing API docs, or sharing a documentation link. Makes auth, inputs, responses, and examples reusable by callers, tests, and mocks. Use for requests such as \"publish API docs\".\n---\n\n# API Documentation\n\nA maintained contract gives callers enough information to integrate without\nreading the implementation. Keeping descriptions and examples beside the API\nartifacts lets the same knowledge support documentation, tests, and mocks,\nwith changes reviewable alongside code.\n\n1. Start from the existing source of truth. An OpenAPI spec describes the\n interface for tooling; a Postman collection adds runnable requests,\n examples, and assertions. Maintain both when both uses matter, with an\n explicit direction of generation or synchronization so they do not become\n competing definitions. Local edits need **bootstrap** only when setup or\n bindings are unresolved.\n2. When the spec is authoritative, reuse its operations with\n `postman spec generate collection <spec-path-or-id> -n \"<collection-name>\"`.\n Inspect the generated result before replacing an existing collection:\n maintained scripts and examples carry knowledge beyond endpoint shapes.\n3. Describe what changes a caller's decision: required versus optional inputs,\n auth and scopes, response guarantees, pagination, retryable failures, and\n side effects. Derive guarantees from the agreed contract or verified\n behavior; label unresolved design choices instead of inventing them.\n Use [REST design guidance](reference/rest-api-best-practices.md) when a\n design choice affects usability or compatibility, not to redesign an\n unrelated interface while filling a documentation gap.\n4. Save examples that clarify consequential cases, including relevant errors.\n Examples become inputs for mocks as well as explanations for readers;\n a success-only example can hide the failure path callers must handle.\n Use **collection-schema-v3** for local collection edits and **variables**\n to keep credentials out of reusable requests and examples.\n5. Choose delivery by audience. Local artifacts support Git review;\n publishing to the bound workspace makes them available to teammates with\n access (see **bootstrap**). A workspace push does not itself publish a\n public docs page or change permissions. For a public documentation link,\n use **postman-mcp-server**'s documentation workflow and the available\n publishing tool; establish the intended audience before public exposure.\n\n## Verification\n\nCheck that the edited artifact parses and its examples agree with the\ncontract. For a publication, inspect the resulting page and report its actual\nlink and visibility; a successful upload alone does not show readers usable\ndocumentation. State any behavior that remains undocumented or unverified.\n"
}SHA-256 of public snapshot: 6d77df1f0214e140f1111ca8688f474501cfd442edd426eddc3d5d94413da083