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

Provide a mechanism for automatically updating the OpenAPI spec #11

Open
goshatch opened this issue Jan 15, 2025 · 1 comment
Open

Provide a mechanism for automatically updating the OpenAPI spec #11

goshatch opened this issue Jan 15, 2025 · 1 comment

Comments

@goshatch
Copy link
Owner

Some automation that would pull the latest JSON into our repository.

Ref: https://github.com/bluesky-social/bsky-docs/tree/main/atproto-openapi-types

hierophantos added a commit to hierophantos/atproto-clojure that referenced this issue Jan 20, 2025
Still maintains local backup as fall-back
Will use user supplied values (either in call or as env variables) first
before trying to pull from online source.
@goshatch
Copy link
Owner Author

The solution I'm imagining here is some kind of script outside of the main code base, that would compare the latest spec provided by the Bluesky team with the version we're vendoring, and somehow update it in our own repository.

This could run either locally on a developer's machine, or as part of a CI pipeline (in GitHub Actions for example).

It would need to somehow guard against unexpected changes in the official spec breaking compatibility. This could be done by running some unit tests against the updated spec, or by automatically creating a PR with the changes and letting someone review them.

hierophantos added a commit to hierophantos/atproto-clojure that referenced this issue Jan 25, 2025
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

No branches or pull requests

1 participant