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

Swagger: add Link header to all endpoints that use it for paging #2751

Merged
merged 1 commit into from
Mar 13, 2024

Conversation

VyrCossont
Copy link
Contributor

Description

Adds description of the Link header to Swagger docs for 5 endpoints that use it but which didn't already have that header in the response description. Also fixes a typo preventing correct docs generation for 1 of those endpoints.

Allows use of Link paging with Swagger clients. No code changes.

Checklist

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have not leveraged AI to create the proposed changes.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

@daenney daenney merged commit 13b9fd5 into superseriousbusiness:main Mar 13, 2024
2 checks passed
@VyrCossont VyrCossont deleted the swagger-link-headers branch July 26, 2024 23:32
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

Successfully merging this pull request may close these issues.

2 participants