feat: MakesFederatedCall servant combinator #2
Conversation
| @@ -175,10 +175,10 @@ userAPI = | |||
| :<|> deleteLocale | |||
| :<|> getDefaultUserLocale | |||
|
|
|||
| authAPI :: (Member GalleyProvider r, CallsFed 'Brig "on-user-deleted-connections") => ServerT BrigIRoutes.AuthAPI (Handler r) | |||
| authAPI :: (Member GalleyProvider r) => ServerT BrigIRoutes.AuthAPI (Handler r) | |||
There was a problem hiding this comment.
This PR lets us safely eliminate this CallsFed constraint.
| toSwagger (Proxy @api) | ||
| & applyTags | ||
| [ Tag | ||
| "x-wire-makes-federated-call-to" |
There was a problem hiding this comment.
i just built this branch and tried this out, but came up empty:
$ curl -q http://localhost:8082/api/swagger.json | jq . | grep x-wire-makes-federated-call-to
am i holding it wrong?
There was a problem hiding this comment.
I'm not sure how to run the server, but dumping the output of Wire.API.Routes.Internal.Brig.swaggerDoc gives me the following output:
which gives the following output
$ cat /tmp/swagger.json.txt| jq . | grep x-wire-makes-federated-call-to
"x-wire-makes-federated-call-to"
"x-wire-makes-federated-call-to"
"name": "x-wire-makes-federated-call-to"
But upon viewing this in a swagger viewer, it looks like tags might be the wrong place for this information:
|
Resultant swagger for brig after this change: |
|
could you push this branch to wireapp/wire-server and make a PR from there (either rewire this one or create a new one)? then we can have the CI take a look at things. it would be interesting to understand where the output you're working with goes, and what goes into |
| @@ -172,6 +172,13 @@ let | |||
| sha256 = "1w23yz2iiayniymk7k4g8gww7268187cayw0c8m3bz2hbnvbyfbc"; | |||
| }; | |||
| }; | |||
| swagger2 = { | |||
There was a problem hiding this comment.
Why do we need exactly this version of swagger2?
There was a problem hiding this comment.
@mdimjasevic asked the same thing. The swagger specification supports extensions, but swagger2 doesn't. Julia and I decided to patch swagger2 with the functionality and have upstreamed it, but it's unclear if the library is maintained.
| @@ -172,6 +172,13 @@ let | |||
| sha256 = "1w23yz2iiayniymk7k4g8gww7268187cayw0c8m3bz2hbnvbyfbc"; | |||
| }; | |||
| }; | |||
| swagger2 = { | |||
There was a problem hiding this comment.
Why this Swagger2 pin? I suppose it provides something that currently doesn't exist in the version that is used.
will do!
After investigating, this PR currently only changes an internal brig endpoint's definition, and the internal API's swagger isn't served anywhere. |
|
Reopened at wireapp#2950 |
Checklist
changelog.d