Skip to content

[codex] align SDK API documentation workflow - #1

Merged
KazanderDad merged 11 commits into
devfrom
feature/globalpayto-resolver-migration
Jun 28, 2026
Merged

[codex] align SDK API documentation workflow#1
KazanderDad merged 11 commits into
devfrom
feature/globalpayto-resolver-migration

Conversation

@KazanderDad

Copy link
Copy Markdown
Contributor

What changed

  • Renamed the SDK surface to MyPayTag and aligned public protocol/docs with the current resolver direction.
  • Added OpenAPI 3.1 as the public API source of truth at api/openapi.yaml.
  • Added generated Postman collection support at api/postman_collection.json.
  • Added CI/release handling for OpenAPI validation and Postman collection artifacts.
  • Stabilized Postman generation so rerunning the generator does not create noisy random diffs.

Why

Developers need one maintainable API documentation source, interactive docs on the site, and a downloadable Postman collection without adding heavier doc platforms or package publishing changes in this stage.

Validation

  • pnpm test
  • pnpm api:validate
  • pnpm api:postman
  • double-generation diff check for api/postman_collection.json
  • git diff --check

@KazanderDad
KazanderDad marked this pull request as ready for review June 28, 2026 00:34
@KazanderDad

Copy link
Copy Markdown
Contributor Author

@codex review

@KazanderDad
KazanderDad merged commit 4a9573c into dev Jun 28, 2026
1 check passed
@KazanderDad
KazanderDad deleted the feature/globalpayto-resolver-migration branch June 28, 2026 03: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.

1 participant