From 52ebcf3277cbcaa466320e6c39130a0576784fbf Mon Sep 17 00:00:00 2001 From: Jakob Warkotsch Date: Wed, 18 Sep 2024 16:19:58 +0200 Subject: [PATCH] REST: Capitalize Wikibase domain terms in OAS Change-Id: Ia8e3eb7b26e5393f0bfc9a065fa96b55a33e29ac --- repo/rest-api/specs/global/parameters.json | 2 +- repo/rest-api/specs/global/request-parts.json | 2 +- repo/rest-api/specs/global/responses.json | 10 ++--- repo/rest-api/specs/resources/index.json | 4 +- .../specs/resources/sitelinks/list.json | 4 +- .../specs/resources/sitelinks/responses.json | 2 +- .../specs/resources/sitelinks/single.json | 6 +-- .../specs/resources/statements/responses.json | 8 ++-- repo/rest-api/src/RouteHandlers/openapi.json | 38 +++++++++---------- 9 files changed, 38 insertions(+), 38 deletions(-) diff --git a/repo/rest-api/specs/global/parameters.json b/repo/rest-api/specs/global/parameters.json index fd2e3164dbd..c89789d8ca3 100644 --- a/repo/rest-api/specs/global/parameters.json +++ b/repo/rest-api/specs/global/parameters.json @@ -126,7 +126,7 @@ "PropertyFilter": { "in": "query", "name": "property", - "description": "Single property ID to filter statements by.", + "description": "Single Property ID to filter Statements by.", "required": false, "schema": { "type": "string", diff --git a/repo/rest-api/specs/global/request-parts.json b/repo/rest-api/specs/global/request-parts.json index 879f4e4d7e1..00de8b65eff 100644 --- a/repo/rest-api/specs/global/request-parts.json +++ b/repo/rest-api/specs/global/request-parts.json @@ -255,7 +255,7 @@ "example": "replace" }, "path": { - "description": "A JSON Pointer for the property to manipulate", + "description": "A JSON Pointer for the Property to manipulate", "type": "string" }, "value": { diff --git a/repo/rest-api/specs/global/responses.json b/repo/rest-api/specs/global/responses.json index a9bdaa2e536..edacc388e49 100644 --- a/repo/rest-api/specs/global/responses.json +++ b/repo/rest-api/specs/global/responses.json @@ -349,7 +349,7 @@ } }, "InvalidPatchedItem": { - "description": "Applying the provided JSON Patch results in an invalid property", + "description": "Applying the provided JSON Patch results in an invalid Property", "content": { "application/json": { "schema": { "$ref": "./response-parts.json#/Error" }, @@ -379,7 +379,7 @@ } }, "InvalidPatchedProperty": { - "description": "Applying the provided JSON Patch results in an invalid property", + "description": "Applying the provided JSON Patch results in an invalid Property", "content": { "application/json": { "schema": { "$ref": "./response-parts.json#/Error" }, @@ -484,7 +484,7 @@ } }, "InvalidPatchedStatement": { - "description": "Applying the provided JSON Patch results in an invalid statement", + "description": "Applying the provided JSON Patch results in an invalid Statement", "content": { "application/json": { "schema": { @@ -561,7 +561,7 @@ } }, "Sitelinks": { - "description": "A list of sitelinks by item id", + "description": "A list of Sitelinks by Item id", "headers": { "Last-Modified": { "schema": { @@ -591,7 +591,7 @@ } }, "Sitelink": { - "description": "A sitelink by item id", + "description": "A Sitelink by Item id", "headers": { "Last-Modified": { "schema": { diff --git a/repo/rest-api/specs/resources/index.json b/repo/rest-api/specs/resources/index.json index ea2093a0182..2b6601c774e 100644 --- a/repo/rest-api/specs/resources/index.json +++ b/repo/rest-api/specs/resources/index.json @@ -31,10 +31,10 @@ "get": { "operationId": "getPropertyDataTypes", "tags": [ "Property data types" ], - "summary": "Retrieve the map of property data types to value types", + "summary": "Retrieve the map of Property data types to value types", "responses": { "200": { - "description": "The map of property data types to value types", + "description": "The map of Property data types to value types", "content": { "application/json": { "schema": { diff --git a/repo/rest-api/specs/resources/sitelinks/list.json b/repo/rest-api/specs/resources/sitelinks/list.json index a157be2269b..b1226c3f695 100644 --- a/repo/rest-api/specs/resources/sitelinks/list.json +++ b/repo/rest-api/specs/resources/sitelinks/list.json @@ -2,7 +2,7 @@ "get": { "operationId": "getSitelinks", "tags": [ "sitelinks" ], - "summary": "Retrieve an Item's sitelinks", + "summary": "Retrieve an Item's Sitelinks", "parameters": [ { "$ref": "../../global/parameters.json#/ItemId" }, { "$ref": "../../global/parameters.json#/IfNoneMatch" }, @@ -24,7 +24,7 @@ "patch": { "operationId": "patchSitelinks", "tags": [ "sitelinks" ], - "summary": "Change an Item's sitelinks", + "summary": "Change an Item's Sitelinks", "parameters": [ { "$ref": "../../global/parameters.json#/ItemId" }, { "$ref": "../../global/parameters.json#/IfMatch" }, diff --git a/repo/rest-api/specs/resources/sitelinks/responses.json b/repo/rest-api/specs/resources/sitelinks/responses.json index e022d81a235..3590417c596 100644 --- a/repo/rest-api/specs/resources/sitelinks/responses.json +++ b/repo/rest-api/specs/resources/sitelinks/responses.json @@ -1,6 +1,6 @@ { "InvalidPatchedItemSitelinks": { - "description": "Applying the provided JSON Patch results in invalid sitelinks", + "description": "Applying the provided JSON Patch results in invalid Sitelinks", "content": { "application/json": { "schema": { "$ref": "../../global/response-parts.json#/Error" }, diff --git a/repo/rest-api/specs/resources/sitelinks/single.json b/repo/rest-api/specs/resources/sitelinks/single.json index 80446222835..feebb2416ba 100644 --- a/repo/rest-api/specs/resources/sitelinks/single.json +++ b/repo/rest-api/specs/resources/sitelinks/single.json @@ -2,7 +2,7 @@ "get": { "operationId": "getSitelink", "tags": [ "sitelinks" ], - "summary": "Retrieve an Item's sitelink", + "summary": "Retrieve an Item's Sitelink", "parameters": [ { "$ref": "../../global/parameters.json#/ItemId" }, { "$ref": "../../global/parameters.json#/SiteId" }, @@ -25,7 +25,7 @@ "put": { "operationId": "setSitelink", "tags": [ "sitelinks" ], - "summary": "Add / Replace an item's sitelink", + "summary": "Add / Replace an Item's Sitelink", "parameters": [ { "$ref": "../../global/parameters.json#/ItemId" }, { "$ref": "../../global/parameters.json#/SiteId" }, @@ -56,7 +56,7 @@ "delete": { "operationId": "deleteSitelink", "tags": [ "sitelinks" ], - "summary": "Delete an Item's sitelink", + "summary": "Delete an Item's Sitelink", "parameters": [ { "$ref": "../../global/parameters.json#/ItemId" }, { "$ref": "../../global/parameters.json#/SiteId" }, diff --git a/repo/rest-api/specs/resources/statements/responses.json b/repo/rest-api/specs/resources/statements/responses.json index e1b97b2f442..f78ee5b40c8 100644 --- a/repo/rest-api/specs/resources/statements/responses.json +++ b/repo/rest-api/specs/resources/statements/responses.json @@ -85,7 +85,7 @@ "schema": { "type": "string" }, - "description": "The URI of the newly created statement" + "description": "The URI of the newly created Statement" } }, "content": { @@ -97,7 +97,7 @@ } }, "ItemStatements": { - "description": "The statements of an Item", + "description": "The Statements of an Item", "headers": { "Last-Modified": { "schema": { @@ -279,7 +279,7 @@ "schema": { "type": "string" }, - "description": "The URI of the newly created statement" + "description": "The URI of the newly created Statement" } }, "content": { @@ -294,7 +294,7 @@ } }, "PropertyStatements": { - "description": "The statements of a Property", + "description": "The Statements of a Property", "headers": { "Last-Modified": { "schema": { diff --git a/repo/rest-api/src/RouteHandlers/openapi.json b/repo/rest-api/src/RouteHandlers/openapi.json index c53527add5d..145730c8fa9 100644 --- a/repo/rest-api/src/RouteHandlers/openapi.json +++ b/repo/rest-api/src/RouteHandlers/openapi.json @@ -50,10 +50,10 @@ "tags": [ "Property data types" ], - "summary": "Retrieve the map of property data types to value types", + "summary": "Retrieve the map of Property data types to value types", "responses": { "200": { - "description": "The map of property data types to value types", + "description": "The map of Property data types to value types", "content": { "application/json": { "schema": { @@ -271,7 +271,7 @@ "tags": [ "sitelinks" ], - "summary": "Retrieve an Item's sitelinks", + "summary": "Retrieve an Item's Sitelinks", "parameters": [ { "$ref": "#/components/parameters/ItemId" @@ -321,7 +321,7 @@ "tags": [ "sitelinks" ], - "summary": "Change an Item's sitelinks", + "summary": "Change an Item's Sitelinks", "parameters": [ { "$ref": "#/components/parameters/ItemId" @@ -356,7 +356,7 @@ "$ref": "#/components/responses/PreconditionFailedError" }, "422": { - "description": "Applying the provided JSON Patch results in invalid sitelinks", + "description": "Applying the provided JSON Patch results in invalid Sitelinks", "content": { "application/json": { "schema": { @@ -405,7 +405,7 @@ "tags": [ "sitelinks" ], - "summary": "Retrieve an Item's sitelink", + "summary": "Retrieve an Item's Sitelink", "parameters": [ { "$ref": "#/components/parameters/ItemId" @@ -478,7 +478,7 @@ "tags": [ "sitelinks" ], - "summary": "Add / Replace an item's sitelink", + "summary": "Add / Replace an Item's Sitelink", "parameters": [ { "$ref": "#/components/parameters/ItemId" @@ -574,7 +574,7 @@ "tags": [ "sitelinks" ], - "summary": "Delete an Item's sitelink", + "summary": "Delete an Item's Sitelink", "parameters": [ { "$ref": "#/components/parameters/ItemId" @@ -1345,7 +1345,7 @@ ], "responses": { "200": { - "description": "The statements of an Item", + "description": "The Statements of an Item", "headers": { "Last-Modified": { "schema": { @@ -1483,7 +1483,7 @@ "schema": { "type": "string" }, - "description": "The URI of the newly created statement" + "description": "The URI of the newly created Statement" } }, "content": { @@ -2817,7 +2817,7 @@ ], "responses": { "200": { - "description": "The statements of a Property", + "description": "The Statements of a Property", "headers": { "Last-Modified": { "schema": { @@ -2952,7 +2952,7 @@ "schema": { "type": "string" }, - "description": "The URI of the newly created statement" + "description": "The URI of the newly created Statement" } }, "content": { @@ -3721,7 +3721,7 @@ "PropertyFilter": { "in": "query", "name": "property", - "description": "Single property ID to filter statements by.", + "description": "Single Property ID to filter Statements by.", "required": false, "schema": { "type": "string", @@ -3932,7 +3932,7 @@ "example": "replace" }, "path": { - "description": "A JSON Pointer for the property to manipulate", + "description": "A JSON Pointer for the Property to manipulate", "type": "string" }, "value": { @@ -4945,7 +4945,7 @@ } }, "InvalidPatchedItem": { - "description": "Applying the provided JSON Patch results in an invalid property", + "description": "Applying the provided JSON Patch results in an invalid Property", "content": { "application/json": { "schema": { @@ -4995,7 +4995,7 @@ } }, "InvalidPatchedProperty": { - "description": "Applying the provided JSON Patch results in an invalid property", + "description": "Applying the provided JSON Patch results in an invalid Property", "content": { "application/json": { "schema": { @@ -5158,7 +5158,7 @@ } }, "InvalidPatchedStatement": { - "description": "Applying the provided JSON Patch results in an invalid statement", + "description": "Applying the provided JSON Patch results in an invalid Statement", "content": { "application/json": { "schema": { @@ -5278,7 +5278,7 @@ } }, "Sitelinks": { - "description": "A list of sitelinks by item id", + "description": "A list of Sitelinks by Item id", "headers": { "Last-Modified": { "schema": { @@ -5308,7 +5308,7 @@ } }, "Sitelink": { - "description": "A sitelink by item id", + "description": "A Sitelink by Item id", "headers": { "Last-Modified": { "schema": {