Add api_prefix to public API#339
Merged
Merged
Conversation
Barecheck - Code coverage reportTotal: 96.86%Your code coverage diff: 0.00% ▴ Uncovered files and lines
|
rwb27
force-pushed
the
api-prefix-in-api
branch
2 times, most recently
from
3a0a2bb to
027a616
Compare
I've removed the leading `_` from `ThingServer.api_prefix` in line with `settings_folder` and `application_config`. I have added all three of those properties, as well as `things`, to the Public API page of the docs. In so doing, I've discovered the docstring for ThingServer.things is out of date, so it's updated too.
Collaborator
Author
|
@julianstirling I've removed the backwards-compatibility as discussed. Unfortunately as OFM now uses |
julianstirling
approved these changes
May 13, 2026
Contributor
julianstirling
left a comment
julianstirling
left a comment
There was a problem hiding this comment.
Thanks for the update
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.
I've removed the leading
_fromThingServer.api_prefixin line withsettings_folderandapplication_config, both of which are also taken fromThingServer._config. I have added all three of those properties, as well asthingsanddebugto the Public API page of the docs.In so doing, I've discovered the docstring for ThingServer.things is out of date, so it's updated too.
I realise
_api_prefixis in the release candidate and used by the OFM, so I've left that symbol in with aDeprecationWarning. I'm equally happy to just get rid of it, if that doesn't complicate things - it's only inv0.2.0-rc1.OFM Feature Branch: v3-labthings-rename-api-prefix