Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(openapi): keep public and private API docs in sync with main branch #270

Conversation

jvallesm
Copy link
Collaborator

@jvallesm jvallesm commented Feb 13, 2024

Because

  • OpenAPI changes require manual uploads in ReadMe.com
  • We have no staging docs

This commit

  • Syncs the main branch with the public and private version of the API
    • Changes in main branch update the staging docs
    • Version changes in main branch update the public docs

Notes

I created a playground environment to test the GitHub actions:

✅ This PR will need:

  • Changes in ReadMe.com to have a staging version + adapt existing version to the naming introduced in this one.
  • An update in the workflow to match the staging API reference IDs to those in the Instill AI organization.
  • A README_API_KEY repository variable.

@jvallesm jvallesm self-assigned this Feb 13, 2024
@jvallesm jvallesm force-pushed the jvalles/ins-3596-update-api-docs-in-staging-and-production-environments-sync branch from 46435e0 to beb7878 Compare February 13, 2024 21:44
@jvallesm jvallesm marked this pull request as ready for review February 13, 2024 22:57
⚠️ This is a WIP commit. I created a playground environment to test the
GitHub actions. The workflow file has been copied from
https://github.com/jvallesm/instill-protobufs and references API IDs
that don't belong to the Instill AI organisation.

We should update the API doc IDs and introduce a `README_API_KEY`
repository variable.

- Changes in main branch update the staging docs
- Version changes in main branch update the public docs
Avoids version limit in ReadMe.com
@jvallesm jvallesm force-pushed the jvalles/ins-3596-update-api-docs-in-staging-and-production-environments-sync branch from bf358d4 to 7cad6f9 Compare February 15, 2024 09:07
@jvallesm jvallesm merged commit 36c13f8 into main Feb 15, 2024
1 check passed
@jvallesm jvallesm deleted the jvalles/ins-3596-update-api-docs-in-staging-and-production-environments-sync branch February 15, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: 👋 Done
Development

Successfully merging this pull request may close these issues.

1 participant