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

SQSERVICES-1529 Swagger docs and endpoint deprecation for API version V2 #2492

Merged
merged 6 commits into from
Jun 20, 2022

Conversation

battermann
Copy link
Contributor

@battermann battermann commented Jun 16, 2022

https://wearezeta.atlassian.net/browse/SQSERVICES-1529

The API changes in this PR were also added here: https://wearezeta.atlassian.net/wiki/spaces/ENGINEERIN/pages/603095166/API+changes+v1+v2

Checklist

  • The PR Title explains the impact of the change.
  • The PR description provides context as to why the change should occur and what the code contributes to that effect. This could also be a link to a JIRA ticket or a Github issue, if there is one.
  • changelog.d contains the following bits of information (details):
    • A file with the changelog entry in one or more suitable sub-sections. The sub-sections are marked by directories inside changelog.d.r?

@battermann battermann temporarily deployed to cachix June 16, 2022 15:25 Inactive
@battermann battermann temporarily deployed to cachix June 16, 2022 15:27 Inactive
@battermann battermann requested a review from fisx June 16, 2022 15:28
@battermann battermann temporarily deployed to cachix June 16, 2022 15:46 Inactive
Base automatically changed from smatting/simplify-feature-configs to develop June 16, 2022 15:46
@battermann battermann force-pushed the SQSERVICES-1529-remove-redundant-endpoints-2 branch from ef54775 to b8a02e4 Compare June 16, 2022 15:49
@battermann battermann temporarily deployed to cachix June 16, 2022 15:49 Inactive
Copy link
Contributor

@fisx fisx left a comment

Choose a reason for hiding this comment

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

Looks good to merge to me!

The only two clients of internal end-points outside wire-server/services are ibis and stern. We could check these, document the findings, and that would allow us to remove the deprecated internal end-points soon(ish).

@dkovacevic what internal end-points are you using for feature configuration

libs/wire-api/src/Wire/API/Routes/Public/Galley.hs Outdated Show resolved Hide resolved
Co-authored-by: fisx <mf@zerobuzz.net>
@battermann battermann temporarily deployed to cachix June 20, 2022 06:45 Inactive
@battermann battermann temporarily deployed to cachix June 20, 2022 08:08 Inactive
@battermann
Copy link
Contributor Author

@fisx by adding Until 'V2 to the endpoint types they will no longer be published to the current swagger UI. I think it is good to keep the documentation anyway and I also added everything here: https://wearezeta.atlassian.net/wiki/spaces/ENGINEERIN/pages/603095166/API+changes+v1+v2

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.

None yet

2 participants