Skip to content

fix: correct swagger description for Insights API #13442

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 3, 2024
Merged

fix: correct swagger description for Insights API #13442

merged 1 commit into from
Jun 3, 2024

Conversation

mtojek
Copy link
Member

@mtojek mtojek commented Jun 3, 2024 •
edited
Loading

Fixes: #12036

Screenshot 2024-06-03 at 15 23 16 Screenshot 2024-06-03 at 15 27 36

@mtojek mtojek self-assigned this Jun 3, 2024
@mtojek mtojek marked this pull request as ready for review June 3, 2024 13:45
@mtojek mtojek requested a review from dannykopping June 3, 2024 13:45
dannykopping
dannykopping approved these changes Jun 3, 2024
View reviewed changes
Copy link
Contributor

@dannykopping dannykopping left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Did you update this manually or with a script?
If the latter, I'd suggest adding a linter so we can prevent a reoccurrence.

@mtojek
Copy link
Member Author

mtojek commented Jun 3, 2024

Did you update this manually or with a script?

Manually in // @Param comments, we generate docs and swagger.json out of them. Unfortunately, there is no generator that understands our request params/body/headers. Maybe one day...

@mtojek mtojek merged commit bf98b0d into main Jun 3, 2024
32 checks passed
@mtojek mtojek deleted the 12036-insights branch June 3, 2024 13:48
@github-actions github-actions bot locked and limited conversation to collaborators Jun 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dannykopping dannykopping dannykopping approved these changes

Assignees

@mtojek mtojek

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Insights API has incorrect swagger documentation
2 participants
@mtojek @dannykopping