Skip to content

Crawl the openAPI spec to keep our SDK up to date #832

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

Closed
kevinlacaille opened this issue Jan 12, 2023 · 1 comment
Closed

Crawl the openAPI spec to keep our SDK up to date #832

kevinlacaille opened this issue Jan 12, 2023 · 1 comment

Comments

@kevinlacaille
Copy link
Contributor

Is your feature request related to a problem? Please describe.
As described in two recent tickets, #780 and #824, the openAPI spec keeps changing and we are playing this game where we try to keep up with the spec, but we have no indication whether or not something has changed, until a bug bubbles up. In the case of #780 and #824, the spec Harmonization tool kept changing, however we only found out by users telling us our SDK was out of date.

Describe the solution you'd like
Implement a tool which crawls the openAPI spec which would indicate whether or not our SDK aligns with our API's spec.

I do not know web crawlers well, but here are some potential pre-built tools we could consider:
https://brightdata.com/
https://smartbear.com/
https://www.scrapestorm.com/

Describe alternatives you've considered

Additional context

@tbarsballe
Copy link
Contributor

With the organizational changes to the SDK PSC, there is now closer interaction between the API team and the SDK team

We shouldn't be making API-breaking changes in the first place, and if we are, part of that should be updating the SDK.

As such, this is no longer (as much of a) concern

@tbarsballe tbarsballe closed this as not planned Won't fix, can't repro, duplicate, stale Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants