Add versioned endpoints #92
Open
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
This also has the added effect of separating the API docs to /api/docs, /api/v0/docs and /api/v1alpha/docs. The default ETOS API version shall be served on /api Also removed some unecessary code and routers and moved the selftest to /api/etos/ping and /api/version/etos/ping so that we can start doing a few checks when the client pings ETOS. The old /selftest/ping endpoint still exists, but redirects to the default API version/ping
Moved code around in routers so that the actual routes are at the top and moved some functions to the utilities file.
t-persson
requested review from
fredjn and
andmat900
and removed request for
a team
andmat900
reviewed
Nov 22, 2024
andmat900
reviewed
Nov 22, 2024
andmat900
reviewed
Nov 22, 2024
andmat900
approved these changes
Nov 25, 2024
fredjn
reviewed
Nov 25, 2024
| @@ -55,7 +55,7 @@ | |||
| trace.set_tracer_provider(PROVIDER) | |||
|
|
|||
| FastAPIInstrumentor().instrument_app( | |||
| APP, tracer_provider=PROVIDER, excluded_urls="selftest/.*,logs/.*" | |||
| APP, tracer_provider=PROVIDER, excluded_urls=".*/etos/ping" | |||
There was a problem hiding this comment.
Won't this make all the requests to selftest show up in OTEL signals? Sure there is a redirect but the request from the older clients are still to the older urls, or have I got it all backwards?
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.
Applicable Issues
Preparing for: eiffel-community/etos#303
Description of the Change
Split up ETOS API into v0 and v1alpha
This also has the added effect of separating the API docs to /api/docs, /api/v0/docs and /api/v1alpha/docs.
The default ETOS API version shall be served on /api
Also removed some unecessary code and routers and moved the selftest to /api/etos/ping and /api/version/etos/ping so that we can start doing a few checks when the client pings ETOS.
The old /selftest/ping endpoint still exists, but redirects to the default API version/ping
Alternate Designs
Possible Drawbacks
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Tobias Persson [email protected]