Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

LIMS-1138: Update Swagger spec #723

Merged
merged 2 commits into from
Feb 7, 2024
Merged

LIMS-1138: Update Swagger spec #723

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b38f64b
LIMS-1138: Update Swagger spec
Feb 5, 2024
f066d7a
LIMS-1138: Use dccid for data collection comment id
Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 33 additions & 51 deletions api/docs/dist/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,9 +260,6 @@
},
{
"$ref": "#/parameters/SortOrderParam"
},
{
"$ref": "#/parameters/ProposalParam"
}
],
"responses": {
Expand Down Expand Up @@ -492,6 +489,9 @@
],
"summary": "Get a single visit",
"parameters": [
{
"$ref": "#/parameters/ProposalParam"
},
{
"name": "visit",
"in": "path",
Expand Down Expand Up @@ -519,6 +519,9 @@
],
"summary": "Update a visit, pass one Visit property",
"parameters": [
{
"$ref": "#/parameters/ProposalParam"
},
{
"name": "visit",
"in": "path",
Expand Down Expand Up @@ -2859,7 +2862,7 @@
}
}
},
"/dc/id/{id}": {
"/dc/{id}": {
"get": {
"security": [
{
Expand All @@ -2874,6 +2877,9 @@
"parameters": [
{
"$ref": "#/parameters/DCIDPathParam"
},
{
"$ref": "#/parameters/ProposalParam"
}
],
"responses": {
Expand All @@ -2889,38 +2895,7 @@
}
}
},
"/dc/t/{type}/id/{id}": {
"get": {
"security": [
{
"Bearer": []
}
],
"tags": [
"datacollections"
],
"summary": "Get a particular beamline event",
"description": "Returns array",
"parameters": [
{
"$ref": "#/parameters/DCIDPathParam"
},
{
"$ref": "#/parameters/DCTypePathParam"
}
],
"responses": {
"200": {
"description": "Array containing single beamline event",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/DataCollections"
}
}
}
}
},
"/dc/single/t/{type}/{id}": {
"patch": {
"security": [
{
Expand Down Expand Up @@ -3008,7 +2983,20 @@
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/DataCollectionComment"
"properties": {
"DATACOLLECTIONID": {
"type": "number",
"example": 593
},
"PERSONID": {
"type": "number",
"example": 593
},
"COMMENTS": {
"type": "string",
"example": "a new comment"
}
}
}
}
],
Expand All @@ -3028,7 +3016,7 @@
}
}
},
"/dc/comments/{dccid}": {
"/dc/comments/{dcid}": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't dccid stand for data collection comment ID in this case, and therefore we should keep it? (These abbreviations/acronyms are immensely confusing...)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

"get": {
"security": [
{
Expand All @@ -3041,7 +3029,7 @@
"summary": "Get a single data collection comment",
"parameters": [
{
"name": "dccid",
"name": "dcid",
"in": "path",
"description": "Data collection comment id",
"type": "number",
Expand Down Expand Up @@ -3087,7 +3075,7 @@
}
}
},
"/dc/aps": {
"/processing/status": {
"post": {
"security": [
{
Expand Down Expand Up @@ -3227,7 +3215,7 @@
}
}
},
"/dc/ap/{id}": {
"/processing/{id}": {
"get": {
"security": [
{
Expand Down Expand Up @@ -7168,16 +7156,10 @@
"type": "string",
"pattern": "\\w+",
"enum": [
"dc",
"sc",
"fc",
"gr",
"data",
"grid",
"edge",
"mca",
"rb",
"ac",
"flag",
"ap"
"mca"
]
},
"DCIDsBodyParam": {
Expand Down Expand Up @@ -7205,4 +7187,4 @@
}
}
}
}
}
Loading