From c812c4d7286e93d7289a760508732902b315d7a4 Mon Sep 17 00:00:00 2001 From: Philip de Nier Date: Wed, 24 Jul 2024 12:19:03 +0100 Subject: [PATCH 1/4] api: describe Flow/Source tag PUT as a 'create or update' --- api/TimeAddressableMediaStore.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml index e642a34..fa2819b 100644 --- a/api/TimeAddressableMediaStore.yaml +++ b/api/TimeAddressableMediaStore.yaml @@ -428,8 +428,8 @@ paths: "404": description: The requested Source or tag does not exist. put: - summary: Set Source Tag - description: Set the Source tag + summary: Create or Update Source Tag + description: Create or update the Source tag operationId: PUT_sources-sourceId-tags-name tags: - Sources @@ -443,7 +443,7 @@ paths: required: true responses: "204": - description: No content. The tag has been updated. + description: No content. The tag has been created or updated. "400": description: Bad request. Invalid Source tag value. "404": @@ -999,8 +999,8 @@ paths: "404": description: The requested flow or tag does not exist. put: - summary: Set Flow Tag - description: Create or modify the tag. + summary: Create or Update Flow Tag + description: Create or update the tag. operationId: PUT_flows-flowId-tags-name tags: - Flows @@ -1014,7 +1014,7 @@ paths: required: true responses: "204": - description: No content. The tag has been updated. + description: No content. The tag has been created or updated. "400": description: Bad request. Invalid flow tag value. "403": From b1d0fc655b3edf1c9fe7a6da1b48dfb0f032f57a Mon Sep 17 00:00:00 2001 From: Philip de Nier Date: Wed, 24 Jul 2024 12:24:00 +0100 Subject: [PATCH 2/4] api: describe PUT of description/label as create or update Given that there is a DELETE method. This aligns it with the wording used for tags. --- api/TimeAddressableMediaStore.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml index fa2819b..d6a1b1f 100644 --- a/api/TimeAddressableMediaStore.yaml +++ b/api/TimeAddressableMediaStore.yaml @@ -496,8 +496,8 @@ paths: "404": description: The requested Source does not exist. put: - summary: Set Source Description - description: Create or modify the description property. + summary: Create or Update Source Description + description: Create or update the description property. operationId: PUT_sources-sourceId-description tags: - Sources @@ -511,7 +511,7 @@ paths: required: true responses: "204": - description: No content. The description has been updated. + description: No content. The description has been created or updated. "400": description: Bad request. Invalid Source description. "404": @@ -564,8 +564,8 @@ paths: "404": description: The requested Source does not exist, or does not have a label set. put: - summary: Set Source Label - description: Create or modify the label property. + summary: Create or Update Source Label + description: Create or update the label property. operationId: PUT_sources-sourceId-label tags: - Sources @@ -579,7 +579,7 @@ paths: required: true responses: "204": - description: No content. The label has been updated. + description: No content. The label has been created or updated. "400": description: Bad request. Invalid Source label. "404": @@ -1069,8 +1069,8 @@ paths: "404": description: The requested flow does not exist. put: - summary: Set Flow Description - description: Create or modify the description property. + summary: Create or Update Flow Description + description: Create or update the description property. operationId: PUT_flows-flowId-description tags: - Flows @@ -1084,7 +1084,7 @@ paths: required: true responses: "204": - description: No content. The description has been updated. + description: No content. The description has been created or updated. "400": description: Bad request. Invalid flow description. "403": From 2119bfde1c8d2188ea9fae4c0b3c54f4ead6216a Mon Sep 17 00:00:00 2001 From: Philip de Nier Date: Wed, 24 Jul 2024 12:26:43 +0100 Subject: [PATCH 3/4] api: consistently describe PUT of flow read_only as a set The read_only property is always present, i.e. can't be DELETEd --- api/TimeAddressableMediaStore.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml index d6a1b1f..85b965c 100644 --- a/api/TimeAddressableMediaStore.yaml +++ b/api/TimeAddressableMediaStore.yaml @@ -1154,7 +1154,7 @@ paths: required: true responses: "204": - description: No content. The read_only property has been updated. + description: No content. The read_only property has been set. "400": description: Bad request. Invalid flow description. "404": From 42c73f1e2ba52b34d4ab506bbd8a76a4dd83f3c8 Mon Sep 17 00:00:00 2001 From: Philip de Nier Date: Wed, 24 Jul 2024 16:58:48 +0100 Subject: [PATCH 4/4] reviewcomment: expand set to set to given value Co-authored-by: Sam Mesterton-Gibbons --- api/TimeAddressableMediaStore.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/TimeAddressableMediaStore.yaml b/api/TimeAddressableMediaStore.yaml index 85b965c..47c4604 100644 --- a/api/TimeAddressableMediaStore.yaml +++ b/api/TimeAddressableMediaStore.yaml @@ -1154,7 +1154,7 @@ paths: required: true responses: "204": - description: No content. The read_only property has been set. + description: No content. The read_only property has been set to the given value. "400": description: Bad request. Invalid flow description. "404":