Feature/writable api #50
Merged
Conversation
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
This was referenced Feb 7, 2025
jchate6
approved these changes
Feb 7, 2025
jchate6
left a comment
jchate6
left a comment
There was a problem hiding this comment.
Will this require updates for the LCO observing portal or developers docs?
Member
Author
|
@jchate6 Yes, it would be good to add something to the OCS docs with examples of how to setup configdb via the API. I'll plan to add that. I don't think the developer docs need to be updated since the read API should be returning the same things and apparently we already had ids in those docs even if they weren't being returned before. But maybe it would be worth calling out some of the different field names for the write_only fields for the writable part of the API there too. |
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.
These changes should make all the data structures within configdb fully writable via the API. This was requested from a user in these issues:
observatorycontrolsystem/ocs_example#22
observatorycontrolsystem/ocs_example#24
The only change from the read API is the addition of some id fields to the optical element, optical element group, generic mode, generic mode group, and configuration type properties output. I also updated the simple index page to link to all the data structures API results.