LIMS-1138: Update Swagger spec #723
Merged
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
gfrn
reviewed
Feb 7, 2024
api/docs/dist/spec.json
Outdated
| @@ -3028,7 +3016,7 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/dc/comments/{dccid}": { | |||
| "/dc/comments/{dcid}": { | |||
There was a problem hiding this comment.
Wouldn't dccid stand for data collection comment ID in this case, and therefore we should keep it? (These abbreviations/acronyms are immensely confusing...)
There was a problem hiding this comment.
Yep, I got confused by the fact that in the Synchweb code it is called dcid (https://github.com/DiamondLightSource/SynchWeb/blob/master/api/src/Page/DC.php#L1673) but it is still a data collection comment id.
gfrn
approved these changes
Feb 7, 2024
gfrn
pushed a commit
that referenced
this pull request
Feb 26, 2024
* LIMS-1138: Update Swagger spec * LIMS-1138: Use dccid for data collection comment id --------- Co-authored-by: Mark Williams <[email protected]>
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.
JIRA ticket: LIMS-1138
Summary:
The docs for the Synchweb API are outdated in a few places, this PR is to update them. As first reported in #217.
Changes:
To test: