internal endpoints swagger additional endpoints #3007
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zebot
added
the
ok-to-test
supersven
force-pushed
the
sventennie/internal-endpoints-swagger_additional_endpoints
branch
from
4dafe4c to
161475e
Compare
supersven
force-pushed
the
sventennie/internal-endpoints-swagger_additional_endpoints
branch
2 times, most recently
from
2950e48 to
4eba89f
Compare
Start the ToSchema party with brig and cannon Remove unnecessary module qualifier Fix type error Fix Create instance `ToSchema List1` Add swagger tags (resulting in sections) Replace over with %~ Introduce SwaggerTag combinator Use lens Add some documentation text Test RawJson FromJSON/ToJSON Cleanup Delete unused endpoint Align title with cannon's swagger title Delete Won't-do ToDos Add changelog Remove superfluous comment Add docs about Swagger Describe the swagger URL pattern better Use versions in swagger endpoint Update docs Move example section Fix typo Update swagger.md Old Swagger is now gone. Update services/brig/src/Brig/API/Public.hs Co-authored-by: fisx <mf@zerobuzz.net> Update services/brig/docs/swagger-internal-endpoints.md Co-authored-by: fisx <mf@zerobuzz.net> Update changelog.d/2-features/internal-endpoints-swagger Co-authored-by: fisx <mf@zerobuzz.net> Update libs/wire-api/src/Wire/API/SwaggerServant.hs Co-authored-by: fisx <mf@zerobuzz.net> Update libs/wire-api/test/unit/Test/Wire/API/Roundtrip/Aeson.hs Co-authored-by: fisx <mf@zerobuzz.net> Remove redundant constraint Simplify operations tagging with allOperations Traversal Use LText as data store of RawJson Replace ToSchema instance with function Increase lazy-ness of ToSchema RawJson instance Remove ToSchema for internal data structures Swagger docs for internal endpoints of Legalhold and Cargohold Move galley's internal endpoint to wire-api Swagger for internal Galley endpoints Add spar's internal endpoints
supersven
force-pushed
the
sventennie/internal-endpoints-swagger_additional_endpoints
branch
from
f59abbf to
13e157a
Compare
battermann
approved these changes
Feb 17, 2023
| Displayed paths are prefixed by the service name (e.g. `/<brig>`). This is | ||
| necessary because Swagger does not expect more than one endpoint for a given | ||
| path and method. Though, some paths (e.g. `/i/status`) exist on more than one | ||
| service. To use the a path, remove the prefix. |
There was a problem hiding this comment.
Alternatively, we could expose the internal swagger UI for each service on their own page?
Is it possible to use the swagger UI to call those endpoints, the way it is implemented now?
There was a problem hiding this comment.
Thanks for the inspiration! I was more focused on the overview over all endpoints. However, being able to use the endpoints is pretty appealing, too.
As this should be possible with a kubectl port-forward, I'll give it a shot.
There was a problem hiding this comment.
maybe different PR, though?
@fisx , Sounds good 👍
supersven
deleted the
sventennie/internal-endpoints-swagger_additional_endpoints
branch
2 tasks
This was referenced Mar 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds internal Servant endpoints to the Swagger docs for internal endpoints. (
brigandcannonendpoints were already there.)To have them available I had to move some types from
galley-typestowire-api.sparandgalleyinternal API definitions haven been moved there, too.Follow up to #3003
Rendered
Checklist
changelog.d