brig: Add endpoints to show real swagger #4367
Draft
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
fisx
reviewed
Dec 10, 2024
Comment on lines
+322
to
+330
| realVersionedSwaggerDocsAPI (VersionNumber V8) = realVersionedSwaggerDocsEndpoints @V8 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V7) = realVersionedSwaggerDocsEndpoints @V7 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V6) = realVersionedSwaggerDocsEndpoints @V6 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V5) = realVersionedSwaggerDocsEndpoints @V5 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V4) = realVersionedSwaggerDocsEndpoints @V4 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V3) = realVersionedSwaggerDocsEndpoints @V3 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V2) = realVersionedSwaggerDocsEndpoints @V2 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V1) = realVersionedSwaggerDocsEndpoints @V1 | ||
| realVersionedSwaggerDocsAPI (VersionNumber V0) = realVersionedSwaggerDocsEndpoints @V0 |
There was a problem hiding this comment.
haskell dependent types, wheeee! :-)
(joking)
| ) | ||
| & S.info . S.title .~ "Wire-Server API" | ||
| & S.info . S.description ?~ $(embedText =<< makeRelativeToProject "docs/swagger.md") | ||
| & S.servers .~ [S.Server ("/" <> toUrlPiece V8) Nothing mempty] |
There was a problem hiding this comment.
Suggested change
| & S.servers .~ [S.Server ("/" <> toUrlPiece V8) Nothing mempty] | |
| & S.servers .~ [S.Server ("/" <> toUrlPiece v) Nothing mempty] |
| @@ -41,6 +42,8 @@ type SwaggerDocsAPIBase = SwaggerSchemaUI "swagger-ui" "swagger.json" | |||
|
|
|||
| type VersionedSwaggerDocsAPI = "api" :> Header VersionHeader VersionNumber :> SwaggerDocsAPIBase | |||
|
|
|||
| type RealVersionedSwaggerDocsAPI = "real-api" :> Header' '[Required, Servant.Strict] VersionHeader VersionNumber :> SwaggerDocsAPIBase | |||
There was a problem hiding this comment.
i like the idea, but i'm wondering if we should then even expose the unreal-api? instead we could move the frozen swagger files to unit tests and make sure things don't change in frozen versions, but always generate them dynamically.
i guess storing the files is faster, but how busy are these end-points?
There was a problem hiding this comment.
also note that real-api will differ from api in old versions because missing lower version bounds.
3 tasks
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 doesn't need to go into release 5.8.)
Checklist
changelog.d