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

Improve Playground API stability #301

Open
FelixTJDietrich opened this issue Jun 20, 2024 · 2 comments
Open

Improve Playground API stability #301

FelixTJDietrich opened this issue Jun 20, 2024 · 2 comments
Assignees
Labels
playground Pull requests that update the playground

Comments

@FelixTJDietrich
Copy link
Collaborator

Is your feature request related to a problem?

Playground has some stability issues.

Describe the solution you'd like

Use Athena's OpenAPI spec in Playground to ensure a CI/CD Typescript error if something is changing in the spec

Describe the alternatives you've considered

No response

Additional context

No response

@FelixTJDietrich FelixTJDietrich added the playground Pull requests that update the playground label Jun 20, 2024
@dmytropolityka dmytropolityka self-assigned this Jul 3, 2024
@maximiliansoelch
Copy link
Member

@FelixTJDietrich Do you mean a GitHub action that checks the requests made from the playground to Athena against the Athena OpenAPI spec?

@FelixTJDietrich
Copy link
Collaborator Author

For instance, in Hephaestus I generate a TypeScript OpenAPI from the specs and use that. I have a GitHub action that generates the specs and checks if there are any changes in the api client that are not committed.

This way if someone changes anything in the API on the Athena side the playground is not broken if they are not checking that particular feature on the playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
playground Pull requests that update the playground
Projects
None yet
Development

No branches or pull requests

3 participants