Update federation error documentation#1956
Merged
pcapriotti merged 6 commits intodevelopfrom Dec 8, 2021
Merged
Conversation
pcapriotti
force-pushed
the
pcapriotti/federation-error-docs
branch
2 times, most recently
from
15a9329 to
ded7730
Compare
pcapriotti
force-pushed
the
pcapriotti/federation-error-docs
branch
from
16bcfb8 to
0fe676c
Compare
The markdown file is converted to a haskell module by a custom `Setup.hs`.
The federation-denied error is client-visible, since it may be due to errors in the original request. This makes the error propagate to the client with status code 400.
Also change some error labels and status codes to make them more consistent. The authentication error category has been merged with the remote federation error category, and all errors of the same category now have similar status codes.
pcapriotti
force-pushed
the
pcapriotti/federation-error-docs
branch
from
0fe676c to
c6088e8
Compare
smatting
approved these changes
Dec 7, 2021
This was referenced Dec 8, 2021
pcapriotti
added a commit
that referenced
this pull request
Dec 9, 2021
Merged
pcapriotti
added a commit
that referenced
this pull request
May 2, 2022
Since we are using file-embed-lzma to embed swagger definitions in the executable (and servant-swagger itself is using it to embed the swagger frontend), there is no point in maintaining a second way to embed static files into the executable. Therefore, this commit removes the mechanism for loading the swagger description at compile time via a custom `Setup.hs`, introduced in #1956, and simply embeds it using `embedText` from `file-embed-lzma`.
pcapriotti
added a commit
that referenced
this pull request
May 9, 2022
Since we are using file-embed-lzma to embed swagger definitions in the executable (and servant-swagger itself is using it to embed the swagger frontend), there is no point in maintaining a second way to embed static files into the executable. Therefore, this commit removes the mechanism for loading the swagger description at compile time via a custom `Setup.hs`, introduced in #1956, and simply embeds it using `embedText` from `file-embed-lzma`.
pcapriotti
added a commit
that referenced
this pull request
May 9, 2022
* New stab at an API versioning policy * Add some client examples * Add header in version middleware * Add current swagger descriptions for v0 and v1 * Add Servant combinators for versioning * Remove deprecated Brig endpoints in latest version * Extract general version utilities * WIP: federation api versioning * Set up versioning and negotiation for fed API * Fix federator unit tests * fixup! New stab at an API versioning policy * Add API fetch test in federator * Implement remote api-version as a normal RPC * Add API version fetch test * Get rid of api-version special cases in federator * Simplify brig federation client definitions * Fix integration test * Fix API versioning tests * Start galley V2 API * Explain client versioning approach in docs * Start cargohold V2 API * Serve old swagger versions * Replace brig custom setup with file-embed-lzma Since we are using file-embed-lzma to embed swagger definitions in the executable (and servant-swagger itself is using it to embed the swagger frontend), there is no point in maintaining a second way to embed static files into the executable. Therefore, this commit removes the mechanism for loading the swagger description at compile time via a custom `Setup.hs`, introduced in #1956, and simply embeds it using `embedText` from `file-embed-lzma`. * Add API version federation endpoint test * Always run version negotiation on Brig * Update and reformat old swaggers * Add CHANGELOG entry * Fix integration test assertion * Add development field to public API version info * Fix typo in CHANGELOG entry Co-authored-by: fisx <mf@zerobuzz.net> * Small clarification in api versioning docs Co-authored-by: fisx <mf@zerobuzz.net> * Grammar Co-authored-by: fisx <mf@zerobuzz.net> * Note about clients ignoring development versions * Do not advertise development versions by default Also add an option to enable development versions. * Add more CHANGELOG entries Co-authored-by: fisx <mf@zerobuzz.net>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 is about making sure that the documentation of federation errors in the public API is up to date with respect to the changes introduced in #1930.
Tracked by https://wearezeta.atlassian.net/browse/FS-262.
Checklist
changelog.d.