Open
Conversation
It's now possible to configure an API prefix, which affects all LabThings-generated URLs. I've also switched a couple of places from passing the app around to creating an APIRouter, which feels much cleaner. So far, tests pass but I've not tried to set a prefix.
The previous commit laid the groundwork but failed to actually set the API prefix. This is now fixed. The API prefix is tested in a couple of places: validation is tested in `test_server_config_model`, and the endpoints are checked in `test_server` explicitly, and `test_thing_client` implicitly (because we use a prefix for the thing that's tested).
I'd accidentally modified these endpoints (and deleted `things`) when I changed the function that added them. I've now added tests for these endpoints, and fixed the URL generation in `things`.
Barecheck - Code coverage reportTotal: 96.55%Your code coverage diff: 0.05% ▴ |
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
1 participant
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 a configuration parameter for the API prefix. This will allow us to have things visible at, for example,
/api/v3/stage.The prefix applies to LabThings endpoints too, for example
/thing_descriptions/would become/api/v3/thing_descriptions.I've added tests for
app.routes)test_thing_client).If the config parameter is not used, nothing changes.
In doing this, I've swapped functions where I pass the
apparound for ones that useAPIRouterto pass the routes in a nicer way. I have not tackledThing.add_to_fastapibecause that will be a more involved change.I added some tests for the
/things/and/thing_descriptions/endpoints, and in so doing discovered I needed to fix/things/. I've done this by adding an endpoint name for the thing description of each thing: it's now namedthings.{name}, which means we can get its URL withurl_for. It would be nice to do this for all endpoints, but that's a job for another time.Closes #264