Skip to content

feat(cli): add support command; improve Postman request titles and docs sync#7

Merged
Statsly-org merged 3 commits into
mainfrom
feat/postman-doc-title
Apr 26, 2026
Merged

feat(cli): add support command; improve Postman request titles and docs sync#7
Statsly-org merged 3 commits into
mainfrom
feat/postman-doc-title

Conversation

@Statsly-org
Copy link
Copy Markdown
Owner

Summary

  • Add pman support CLI command that prints the Discord invite (https://discord.gg/4FBYAMxwdk) and show it in pman help
  • Improve Postman request naming: prefer schema['x-pman-name'] / schema['x-name'] (emitted to OpenAPI by @fastify/swagger) instead of long summary strings
  • Generate request documentation with summary as the first paragraph, plus auto-generated route metadata
  • Write docs to the fields Postman actually uses in Collection v2.1: item.request.description (and item.description for compatibility)
  • Update README + playground example + tests

Why

  • OpenAPI summary is often too long to be a good Postman request title
  • @fastify/swagger does not emit plain schema.name into OpenAPI; OpenAPI x-… extensions work reliably
  • Postman’s “Docs” view for requests is backed by the request description, not just the top-level item description

Test plan

  • npm run lint
  • npm test
  • npm run build && node examples/playground.mjs (verify Postman shows short titles + filled Docs)

Notes

  • Suggested next manual check in Postman Desktop: open a request and confirm Name, Description/Docs, and that baseUrl still works

Checklist

  • No secrets committed
  • User-facing text is English (README)

Closes #6

@Statsly-org Statsly-org self-assigned this Apr 26, 2026
@Statsly-org Statsly-org merged commit efce592 into main Apr 26, 2026
2 checks passed
@Statsly-org Statsly-org deleted the feat/postman-doc-title branch April 26, 2026 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(merge): drive Postman request name from a dedicated name field; put summary in description

1 participant