@postman/postman-plugin 0.1.0 → 0.1.2-rc.0

package/skills/ci-integration/SKILL.md

@@ -0,0 +1,121 @@
+---
+name: ci-integration
+description: Common CI integrations that can added as independent pass/fail gates. Use when the user asks to "add Postman to CI," "run this collection on every PR," "fail the build on a governance violation," or "push to the postman cloud workspace after merge to main", "add some api related operation in my Github actions". 
+---
+
+# CI Integration
+
+## Overview
+These are some common workflows that one can add in their CI pipeline leveraging postman cli.
+
+## Run a collection — a gated pipeline step
+
+`postman collection run <path/id>` exits nonzero on a failed `pm.test`
+assertion, which is what makes it a usable gate — see `api-testing` for how
+that exit code actually gets set. What's CI-specific: `-r junit,html` (or
+`--reporter-*-export`) writes a report your CI provider can surface as
+build artifacts or test annotations, instead of leaving the result buried in
+a log. `--bail` stops the run early on the first failure when a fast signal
+matters more than a full report.
+
+## Lint — pick the target that matches the gate you want
+
+Three verbs look interchangeable and aren't — only two of them apply your
+organization's governance rules, and the CLI's own `-h` output is where that
+becomes visible (no assumption below goes further than what it printed):
+
+| Want to check | Command | Applies org governance? |
+| --- | --- | --- |
+| One spec against your rules | `spec lint <spec> --workspace-id <id> -f error` | Yes, via `--workspace-id` |
+| One collection's structure/style | `collection lint <path> -f error` | **No** — this verb takes no `--workspace-id` at all |
+| The whole workspace: every entity plus `.postman/resources.yaml` | `workspace lint --workspace-id <id> -f error` | Yes |
+
+`collection lint` is a schema/style check only — running it and reporting
+"governance passed" overstates what it did. If the ask is "does this
+collection violate our rules," `workspace lint` is the one that actually
+answers it (and covers every collection in the repo in one pass); reach for
+bare `collection lint` only when there's no workspace to fetch rules from
+yet.
+
+## Push to workspace — only after merge
+
+`postman workspace push -y` is the one command in this skill that changes
+shared cloud state, so it belongs behind a merge-to-main trigger, not a PR
+trigger. `-y` skips confirmation prompts a non-interactive job can't answer.
+Leave `--no-prepare` off — the default prepare step is what assigns real IDs
+to entities that are new since the last push; skipping it because a run
+felt slow trades a few seconds for a push that silently fails to create
+anything new.
+
+`--push-strategy force-sync` mirrors the whole workspace, deleting any cloud
+entity with no local counterpart — genuinely destructive, and not the
+default for a reason. See Critical Rules before adding it to a merge job.
+
+## AI readiness threshold
+
+`collection ai-readiness <path> --min-score <n>` and its spec-side
+counterpart `spec ai-readiness <path> --min-score <n>` (see `ai-readiness`
+skill) are a fourth, separate gate — they score AI-agent consumability, not
+test results or governance/structural style. Keep either in its own step:
+folding it into the same step as `run` or one of the `lint` verbs above
+hides which kind of check actually failed when the job goes red. Pick the
+verb that matches what's checked into the repo — `collection ai-readiness`
+for a git-synced collection, `spec ai-readiness` for an OpenAPI spec with no
+collection generated from it yet.
+
+```yaml
+- run: postman collection ai-readiness ./postman/collections/My\ API --min-score 70
+```
+
+## Critical Rules
+
+1. **Never collapse `run`, `lint`, and `ai-readiness` into one step, and
+   never pass `-x`/`--suppress-exit-code` to a CI run.** One combined exit
+   code hides which check broke; a suppressed one hides that anything broke
+   at all.
+2. **Gate `workspace push` to the merge event, never a PR event.** Everything
+   else in this skill is read-only against the cloud; this is the one
+   command that writes to it, so a PR-triggered push ships an unmerged
+   branch's entities to the shared workspace.
+3. **`--push-strategy force-sync` deletes cloud entities absent locally.**
+   Only add it to a job whose explicit job is mirroring the workspace exactly,
+   with that intent confirmed — never as the default merge step, where the
+   default (create/update-only) strategy is the safe choice.
+4. **Authenticate once, non-interactively:**
+   `postman login --with-api-key "$POSTMAN_API_KEY"`, reading the key from
+   the CI provider's secret store. Don't reach for `collection run`'s
+   `--postman-api-key` as the general answer — it's US-region only — and
+   `spec lint`/`workspace push` don't take it at all.
+
+   ```yaml
+   # WRONG — key committed in plain text, and scoped to one command anyway
+   - run: postman collection run api.json --postman-api-key PMAK-abc123...
+
+   # CORRECT — one non-interactive login, key from the provider's secret store
+   - run: postman login --with-api-key "$POSTMAN_API_KEY"
+   - run: postman collection run api.json
+   - run: postman spec lint spec.yaml --workspace-id $WS -f error
+   ```
+5. **Never `newman run` in place of `postman collection run`.** The CLI is
+   the supported runner every other skill here assumes; Newman forks the
+   toolchain and skips whatever reporting/governance depends on the CLI
+   specifically.
+
+## Verification
+
+State each gate that ran and its individual result — not "CI passed," but
+which check ran, what it checked (governance vs. structure per the Lint
+table above, or AI-agent consumability for `ai-readiness`), and its exit
+code. If `workspace push` ran, confirm it was triggered by the merge event
+and not a PR event, state which push strategy was used, and report
+`Created`/`Updated` per entity rather than just "push succeeded." Confirm
+no secret value appears literally in the committed workflow file.
+
+## Reference
+
+- `api-testing` skill — `collection run`'s exit-code semantics and reporter
+  flags in full.
+- `collection-schema-v3` skill — what `workspace push` is actually pushing.
+- `bootstrap` skill — CLI resolution, workspace linking, `.postman/resources.yaml`.
+- `ai-readiness` skill — `collection ai-readiness`, `spec ai-readiness`, and
+  their `--min-score` gate.

package/skills/collection-schema-v3/SKILL.md

@@ -0,0 +1,210 @@
+---
+name: collection-schema-v3
+description: The reference for the git-native v3 collection file format — one YAML file per request/folder/example under postman/collections/, plus postman/environments/. Read before writing, editing, or generating any file in either directory by hand, or before debugging a `collection lint` failure. Covers the HTTP request/example/definition schema, environment schema, and the YAML/naming rules that make files parse — GraphQL, gRPC, WebSocket, Socket.IO, MQTT, MCP, and LLM request schemas are non-HTTP protocols and live in reference/other_protocols.md, read only when a collection actually uses one.
+---
+
+# Collection Schema (v3, Git-Native)
+
+## Overview
+
+A v3 collection is a directory tree under `postman/collections/`, one file
+per entity — every request, every folder's metadata, every saved example is
+its own file. There is no single collection.json to open and edit; the
+directory structure itself *is* the collection.
+
+```text
+postman/collections/
+  bookstore api/
+    .resources/
+      definition.yaml (optional)
+      get all books.resources/
+        examples/
+          200 OK.example.yaml
+          400 Bad Request.example.yaml
+          500 Internal Server Error.example.yaml
+    get all books.request.yaml
+    get-book-by-id.request.yaml
+    add new book.request.yaml
+    authentication/
+      .resources/
+        definition.yaml (optional)
+      signup.request.yaml
+      login.request.yaml
+```
+
+- Every folder under `postman/collections/` is a collection; it can contain
+  subfolders and requests.
+- A folder or collection can have a `.resources/` directory — an optional
+  metadata directory for that scope. `.resources/definition.yaml` holds the
+  collection/folder's own metadata; request examples live under
+  `.resources/<request-name>.resources/examples/`.
+- Never place a request file inside a `.resources/` directory — those are
+  metadata-only.
+
+## Definition file (`.resources/definition.yaml`)
+
+Optional metadata for a collection or folder:
+
+- `$kind: "collection"` — required, even for a folder's definition.
+- `name` — optional, defaults to the filesystem folder name.
+- `description` — optional.
+- `variables` — array of `{key, value, description?, disabled?}`. `value`
+  must be a string; `disabled` a boolean.
+- `auth` — a single auth object `{type, credentials: [{key, value}, ...]}`,
+  or an array for multiAuth: `[{id, name, type, credentials, rules?}, ...]`.
+- `scripts` — array of `{type, code, language: "text/javascript"}`. `type`
+  is one of `http:beforeRequest`, `http:afterResponse`,
+  `graphql:beforeQuery`, `graphql:afterResponse`, `grpc:beforeInvoke`,
+  `grpc:onIncomingMessage`, `grpc:afterResponse`.
+- `order` — number, used for folder ordering.
+
+## HTTP request (`*.request.yaml`)
+
+- `$kind: "http-request"` — required.
+- `name` — optional (see naming rules below for when to include it).
+- `order` — number; only used for relative comparison, so space values out
+  (e.g. multiples of 1000) rather than packing them tight — a later
+  insertion between two requests shouldn't force renumbering every sibling.
+- `url` — string, with `{{varName}}` variable syntax.
+- `method` — `GET|POST|PUT|DELETE|PATCH|HEAD|OPTIONS`.
+- `headers` — array of `{key, value, description?, disabled?}`.
+- `queryParams` — array of `{key, value, description?, disabled?}`.
+- `pathVariables` — array of `{key, value, description?}`.
+- `body` — `{type, content}`; `type` required whenever `body` is present.
+  - Types: `json`, `formdata`, `urlencoded`, `text`, `xml`, `html`,
+    `javascript`, `file`, `none`.
+  - `json`/`text`/`xml`/`html`/`javascript`: `content` is a string.
+  - `formdata`: `content` is an array of
+    `{key, type: "text"|"file", value or src, contentType?, description?}`.
+  - `urlencoded`: `content` is an array of `{key, value, description?}`.
+- `auth` — `{type, credentials}`.
+- `settings` —
+  `{protocolVersion?, strictSSL?, followRedirects?, maxRedirects?, disabledSystemHeaders?}`.
+- `scripts` — array of `{type: "beforeRequest"|"afterResponse", code, language: "text/javascript"}`.
+- `examples` — optional, a relative path to the examples directory, e.g.
+  `./.resources/<request-name>.resources/examples/`.
+
+## HTTP example (`*.example.yaml`)
+
+- `$kind: "http-example"` — required.
+- `name` — optional.
+- `request: {url, method}`.
+- `response: {statusCode, statusText, headers: [{key, value}], body: {type, content}}`.
+- `order` — optional.
+
+Saved examples are what `collection ai-readiness` checks for — a request
+with no examples scores worse for agent consumption even if perfectly
+valid structurally.
+
+## Environments (`postman/environments/*.environment.yaml`)
+
+Environment files are v3 YAML but are not collection entities: they do not use
+`$kind`. Before creating or editing one by hand, read
+[reference/environment.md](reference/environment.md) for the schema, secret
+handling, CLI-first edit commands, and a linted example.
+
+## YAML rules
+
+Invalid YAML breaks parsing silently in confusing ways — when in doubt,
+single-quote it:
+
+1. Single-quote any value containing `{{variables}}`:
+   `url: '{{base_url}}/users'` — never leave it unquoted.
+2. Single-quote values containing `: # & * ! [ ] { } > |`, e.g.
+   `name: 'Health check: v2'`.
+3. Multi-line content (JSON bodies, scripts, queries) uses a `|-` block
+   scalar:
+   ```yaml
+   body:
+     type: json
+     content: |-
+       {
+         "name": "example"
+       }
+   ```
+4. Quote strings that resemble booleans/numbers when a string is intended:
+   `value: "true"`, `value: "123"`.
+5. `order` must be a bare number, never quoted: `order: 1000`.
+6. Single-quote file paths and use forward slashes only:
+   `examples: './.resources/name.resources/examples'`.
+
+## Naming rules
+
+- `<request-name>` (the filename stem before `.request.yaml`) must not
+  contain `/ \ : * ? " < > |` — sanitize to `-`.
+- Include `name` in the file only when it differs from `<request-name>`
+  (e.g. `name: 'Health/check'` inside `Health-check.request.yaml`, since the
+  filename itself can't hold the `/`).
+- Filenames must be unique, case-insensitively, per directory.
+
+## Worked example: "bookstore api"
+
+`postman/collections/bookstore api/get all books.request.yaml`
+```yaml
+$kind: http-request
+method: GET
+url: '{{base_url}}/books'
+order: 1000
+```
+
+`postman/collections/bookstore api/get-book-by-id.request.yaml`
+```yaml
+$kind: http-request
+name: 'get book by :id'
+method: GET
+url: '{{base_url}}/books/:id'
+order: 2000
+pathVariables:
+  - key: id
+    value: '1'
+```
+
+`postman/collections/bookstore api/add new book.request.yaml`
+```yaml
+$kind: http-request
+method: POST
+url: '{{base_url}}/books'
+order: 3000
+headers:
+  - key: Content-Type
+    value: application/json
+body:
+  type: json
+  content: |-
+    {
+      "title": "Example Book",
+      "author": "Jane Doe"
+    }
+```
+
+`postman/collections/bookstore api/.resources/definition.yaml`
+```yaml
+$kind: collection
+name: Bookstore API
+variables:
+  - key: base_url
+    value: 'https://api.bookstore.com/v1'
+```
+
+## Critical Rules
+
+1. **Every entity is its own file — there's no single collection.json to
+   open.** A request, its parent folder's metadata, and its saved examples
+   are three separate files, not sections of one document.
+2. **Unquoted `{{variables}}` or special characters are the most common way
+   a hand-written file fails to parse.** Single-quote per the YAML rules
+   above rather than debugging a cryptic lint error after the fact.
+3. **`order` is relative, not an index.** Don't renumber every sibling file
+   to insert one request — leave headroom (spacing of 1000) from the start.
+4. **This file covers HTTP only.** A collection using GraphQL, gRPC,
+   WebSocket, Socket.IO, MQTT, MCP, or LLM requests needs
+   [reference/other_protocols.md](reference/other_protocols.md) — don't
+   guess those schemas from the HTTP shape above, they diverge in real ways
+   (e.g. gRPC's `methodDescriptor`, LLM's `userPrompts`/`systemPrompts`).
+
+## Reference
+
+- [Other request protocols](reference/other_protocols.md) — GraphQL, gRPC,
+  WebSocket, Socket.IO, MQTT, MCP, and LLM request schemas.
+- [Environment schema](reference/environment.md) — v3 environment filenames,
+  fields, variable types, safe editing commands, and validation.

package/skills/collection-schema-v3/reference/environment.md

@@ -0,0 +1,63 @@
+# Environment Schema (v3)
+
+Read this reference before creating, editing, or debugging files under
+`postman/environments/`.
+
+## Prefer the CLI for ordinary edits
+
+The CLI preserves the schema and avoids leaking secret values into command
+output:
+
+```bash
+postman environment new "Staging EU"
+postman environment var set baseUrl https://staging.example.com \
+  --environment "postman/environments/Staging EU.environment.yaml"
+postman environment var unset oldToken \
+  --environment "postman/environments/Staging EU.environment.yaml"
+postman environment lint postman/environments --fail-severity warning
+```
+
+Use `environment get --show-secrets` only when the user explicitly needs the
+secret value revealed. Do not print, summarize, or commit credentials returned
+by it.
+
+## File and fields
+
+An environment is one YAML file named `<name>.environment.yaml` under
+`postman/environments/`. It has no `$kind` field.
+
+- `name` — required string.
+- `values` — required array; an empty environment uses `values: []`.
+- Each value has:
+  - `key` — required variable name.
+  - `value` — required string. Quote booleans, numbers, empty values, and
+    values containing YAML punctuation or `{{variables}}` so YAML does not
+    coerce them.
+  - `enabled` — boolean. The CLI writes `true` for a newly set variable.
+  - `type` — optional string. Use `default` for ordinary values and `secret`
+    for sensitive values.
+  - `description` — optional string.
+
+Do not add collection-only fields such as `$kind`, `scripts`, `auth`, or
+`variables`. Do not put secrets into an example merely to make it executable;
+leave the value empty or use the team's supported secret source.
+
+## Linted example
+
+```yaml
+name: Staging EU
+values:
+  - key: baseUrl
+    value: 'https://staging.example.com'
+    enabled: true
+    type: default
+    description: API base URL
+  - key: apiToken
+    value: ''
+    enabled: false
+    type: secret
+```
+
+After any hand edit, run `postman environment lint <file-or-directory>`. Use
+`postman workspace lint` when the task is to validate the entire local
+workspace, not just its environments.

package/skills/collection-schema-v3/reference/other_protocols.md

@@ -0,0 +1,86 @@
+# Non-HTTP request schemas (v3)
+
+Read this only when a collection actually contains one of these request
+types — for the common case, the HTTP schema in the parent
+[SKILL.md](../SKILL.md) is the one that applies.
+
+## GraphQL request
+
+- `$kind: "graphql-request"` — required.
+- `url` — string.
+- `order` — optional.
+- `query` — string (the GraphQL query).
+- `variables` — string (a YAML string containing a JSON object).
+- `headers` — array of `{key, value, description?, disabled?}`.
+- `auth` — `{type, credentials}`.
+- `settings` — `{disabledSystemHeaders?}`.
+- `scripts` — array of `{type: "beforeQuery"|"afterResponse", code, language}`.
+
+## gRPC request
+
+- `$kind: "grpc-request"` — required.
+- `url` — string.
+- `order` — optional.
+- `methodPath` — string.
+- `methodDescriptor` — string.
+- `message` — `{content: string (JSON)}`.
+- `metadata` — array of `{key, value, description?}`.
+- `auth` — `{type, credentials}`.
+- `settings` —
+  `{secureConnection?, strictSSL?, maxResponseMessageSize?, includeDefaultFields?, connectionTimeout?}`.
+- `scripts` — array of `{type: "beforeInvoke"|"afterResponse", code, language}`.
+
+## WebSocket request
+
+- `$kind: "websocket-request"` — required.
+- `url` — string.
+- `order` — optional.
+- `headers` — array of `{key, value, description?, disabled?}`.
+- `queryParams` — array of `{key, value, description?, disabled?}`.
+- `settings` — `{handshakeTimeout?, retryCount?, retryDelay?, maxPayload?, strictSSL?}`.
+
+## Socket.IO request
+
+- `$kind: "socket.io-request"` — required.
+- `url` — string.
+- `order` — optional.
+- `headers` — array of `{key, value}`.
+- `queryParams` — array of `{key, value}`.
+- `events` — array of `{name, description?, subscribeOnConnect: boolean}`.
+- `settings` — `{version?, path?, handshakeTimeout?, retryCount?, retryDelay?, strictSSL?}`.
+
+## MQTT request
+
+- `$kind: "mqtt-request"` — required.
+- `url` — string.
+- `order` — optional.
+- `clientId` — string.
+- `version` — `4 | 5`.
+- `topics` — array of
+  `{name, qos: 0|1|2, subscribe: boolean, description?, settings: {noLocal?, retainAsPublished?, retainHandling?, subscriptionIdentifier?}}`.
+- `lastWill` — `{topic, payload, qos, retain, type: "text"|"json", properties: {messageExpiryInterval?, contentType?}}`.
+- `properties` —
+  `{sessionExpiryInterval?, receiveMaximum?, maximumPacketSize?, requestResponseInformation?, userProperties: [{key, value}]}`.
+- `settings` — `{cleanSession?, keepAlive?, autoReconnect?, connectionTimeout?, strictSSL?}`.
+
+## MCP request
+
+- `$kind: "mcp-request"` — required.
+- `transport` — `"sse" | "stdio"`.
+- `order` — optional.
+- SSE shape: `{url, headers?, message, auth?, settings: {strictSSL?, requestTimeout?, sessionTimeout?}}`.
+- STDIO shape: `{command, env: [{key, value}], message, auth?, settings: {requestTimeout?}}`.
+
+## LLM request
+
+- `$kind: "llm-request"` — required.
+- `url` — string.
+- `order` — optional.
+- `config` — `{model, provider}`.
+- `userPrompts` — array of `{id, value, timestamp, active, type: "text"}`.
+- `systemPrompts` — array of `{id, value, timestamp, active, type: "text"}`.
+- `mcpConfig` — optional string (JSON config).
+- `enabledTools` — optional array of strings.
+- `auth` — `{type, credentials}`.
+- `settings` —
+  `{temperature?, maxToken?, streamResponse?, responseFormatJSON?, topP?, presencePenalty?, frequencyPenalty?, maxSteps?, streamTools?}`.