Skip to content

feat: add OpenAPI preview workflow#1726

Draft
julia-rabello wants to merge 2 commits into
masterfrom
feat/openapi-preview-workflow
Draft

feat: add OpenAPI preview workflow#1726
julia-rabello wants to merge 2 commits into
masterfrom
feat/openapi-preview-workflow

Conversation

@julia-rabello

Copy link
Copy Markdown
Contributor

Adds a GitHub Actions workflow that posts preview links for changed JSON specs as a PR comment, updating it on each push. Depends on https://github.com/vtex/admin-docs/pull/51

Types of changes

  • New content (endpoints, descriptions or fields from scratch)
  • Improvement (make an endpoint's title or description even better)
  • Spelling and grammar accuracy (self-explanatory)

Changelog

Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?

  • Yes, I already created a release note about this change.
  • Not yet, but I'm going to.
  • No, it's just a fix.

Adds a GitHub Actions workflow that posts preview links for changed JSON specs as a PR comment, updating it on each push.
@julia-rabello julia-rabello self-assigned this Jun 17, 2026
@github-actions

Copy link
Copy Markdown

Thanks for your contribution. The .json file will be checked now with Spectral.

@julia-rabello julia-rabello changed the title feat: add OpenAPI preview workflow and document it in README feat: add OpenAPI preview workflow Jun 18, 2026
@vtex-pr-sentinel

Copy link
Copy Markdown

🛡️ SDD Check — action required

I couldn't detect an SDD in this PR. Please check one option below (requires write access to the repo):

  • SDD lives in another PR — paste the SDD PR URL here:
  • This PR doesn't need an SDD
  • SDD applies, but I'm not adopting it in this PR

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