Skip to content

Commit c4e2c77

Browse files
committed
CRUD: Improve language fallback OAS docs
* split long summaries across `summary` and `description` Change-Id: I5e505fed730861e9d02554c43f0a528bbf65bbbe
1 parent e792c0c commit c4e2c77

File tree

7 files changed

+32
-24
lines changed

7 files changed

+32
-24
lines changed

repo/domains/crud/specs/resources/descriptions/description-with-fallback-for-item.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"get": {
33
"operationId": "getItemDescriptionWithFallback",
44
"tags": [ "descriptions" ],
5-
"summary": "Retrieve an Item's description in a specific language, with language fallback. If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description",
5+
"summary": "Retrieve an Item's description in a specific language, with language fallback",
6+
"description": "If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description.",
67
"parameters": [
78
{ "$ref": "../../global/parameters.json#/ItemId" },
89
{ "$ref": "../../global/parameters.json#/LanguageCode" },
@@ -14,7 +15,7 @@
1415
],
1516
"responses": {
1617
"200": {
17-
"description":"Item's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location",
18+
"description": "Item's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location.",
1819
"$ref": "./responses.json#/ItemDescription"
1920
},
2021
"304": { "$ref": "../../global/responses.json#/NotModified" },

repo/domains/crud/specs/resources/descriptions/description-with-fallback-for-property.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"get": {
33
"operationId": "getPropertyDescriptionWithFallback",
44
"tags": [ "descriptions" ],
5-
"summary": "Retrieve a Property's description in a specific language, with language fallback. If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description",
5+
"summary": "Retrieve a Property's description in a specific language, with language fallback",
6+
"description": "If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description.",
67
"parameters": [
78
{ "$ref": "../../global/parameters.json#/PropertyId" },
89
{ "$ref": "../../global/parameters.json#/LanguageCode" },
@@ -14,7 +15,7 @@
1415
],
1516
"responses": {
1617
"200": {
17-
"description": "Property's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location",
18+
"description": "Property's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location.",
1819
"$ref": "./responses.json#/PropertyDescription"
1920
},
2021
"304": { "$ref": "../../global/responses.json#/NotModified" },

repo/domains/crud/specs/resources/descriptions/responses.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
}
127127
},
128128
"DescriptionMovedTemporarily": {
129-
"description": "A description in a fallback language exists in the indicated location",
129+
"description": "A description in a fallback language exists at the indicated location",
130130
"headers": {
131131
"Location": {
132132
"description": "The URL to which the requested resource has been moved",

repo/domains/crud/specs/resources/labels/label-with-fallback-for-item.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"get": {
33
"operationId": "getItemLabelWithFallback",
44
"tags": [ "labels" ],
5-
"summary": "Retrieve an Item's label in a specific language, with language fallback. If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label",
5+
"summary": "Retrieve an Item's label in a specific language, with language fallback",
6+
"description": "If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label.",
67
"parameters": [
78
{ "$ref": "../../global/parameters.json#/ItemId" },
89
{ "$ref": "../../global/parameters.json#/LanguageCode" },
@@ -14,7 +15,7 @@
1415
],
1516
"responses": {
1617
"200": {
17-
"description": "Item's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location",
18+
"description": "Item's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location.",
1819
"$ref": "./responses.json#/ItemLabel"
1920
},
2021
"304": { "$ref": "../../global/responses.json#/NotModified" },

repo/domains/crud/specs/resources/labels/label-with-fallback-for-property.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"get": {
33
"operationId": "getPropertyLabelWithFallback",
44
"tags": [ "labels" ],
5-
"summary": "Retrieve a Property's label in a specific language, with language fallback. If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label",
5+
"summary": "Retrieve a Property's label in a specific language, with language fallback",
6+
"description": "If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label.",
67
"parameters": [
78
{ "$ref": "../../global/parameters.json#/PropertyId" },
89
{ "$ref": "../../global/parameters.json#/LanguageCode" },
@@ -14,7 +15,7 @@
1415
],
1516
"responses": {
1617
"200": {
17-
"description": "Property's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location",
18+
"description": "Property's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location.",
1819
"$ref": "./responses.json#/PropertyLabel"
1920
},
2021
"304": { "$ref": "../../global/responses.json#/NotModified" },

repo/domains/crud/specs/resources/labels/responses.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@
126126
}
127127
},
128128
"LabelMovedTemporarily": {
129-
"description": "A label in a fallback language exists in the indicated location",
129+
"description": "A label in a fallback language exists at the indicated location",
130130
"headers": {
131131
"Location": {
132132
"description": "The URL to which the requested resource has been moved",

repo/rest-api/src/openapi.json

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11501,7 +11501,8 @@
1150111501
"tags": [
1150211502
"descriptions"
1150311503
],
11504-
"summary": "Retrieve an Item's description in a specific language, with language fallback. If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description",
11504+
"summary": "Retrieve an Item's description in a specific language, with language fallback",
11505+
"description": "If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description.",
1150511506
"parameters": [
1150611507
{
1150711508
"in": "path",
@@ -11587,7 +11588,7 @@
1158711588
],
1158811589
"responses": {
1158911590
"200": {
11590-
"description": "Item's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location",
11591+
"description": "Item's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location.",
1159111592
"headers": {
1159211593
"ETag": {
1159311594
"description": "Last entity revision number",
@@ -11632,7 +11633,7 @@
1163211633
}
1163311634
},
1163411635
"307": {
11635-
"description": "A description in a fallback language exists in the indicated location",
11636+
"description": "A description in a fallback language exists at the indicated location",
1163611637
"headers": {
1163711638
"Location": {
1163811639
"description": "The URL to which the requested resource has been moved",
@@ -12981,7 +12982,8 @@
1298112982
"tags": [
1298212983
"descriptions"
1298312984
],
12984-
"summary": "Retrieve a Property's description in a specific language, with language fallback. If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description",
12985+
"summary": "Retrieve a Property's description in a specific language, with language fallback",
12986+
"description": "If a description is defined in the requested language, the API responds with a 200 status code and includes the description in the response payload. If a description only exists in a fallback language, the API returns a 307 status code and provides the location of the description.",
1298512987
"parameters": [
1298612988
{
1298712989
"in": "path",
@@ -13067,7 +13069,7 @@
1306713069
],
1306813070
"responses": {
1306913071
"200": {
13070-
"description": "Property's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location",
13072+
"description": "Property's description in a specific language. If a description only exists in a fallback language, the API returns a 307 status code and provides its location.",
1307113073
"headers": {
1307213074
"ETag": {
1307313075
"description": "Last entity revision number",
@@ -13112,7 +13114,7 @@
1311213114
}
1311313115
},
1311413116
"307": {
13115-
"description": "A description in a fallback language exists in the indicated location",
13117+
"description": "A description in a fallback language exists at the indicated location",
1311613118
"headers": {
1311713119
"Location": {
1311813120
"description": "The URL to which the requested resource has been moved",
@@ -21072,7 +21074,8 @@
2107221074
"tags": [
2107321075
"labels"
2107421076
],
21075-
"summary": "Retrieve an Item's label in a specific language, with language fallback. If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label",
21077+
"summary": "Retrieve an Item's label in a specific language, with language fallback",
21078+
"description": "If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label.",
2107621079
"parameters": [
2107721080
{
2107821081
"in": "path",
@@ -21158,7 +21161,7 @@
2115821161
],
2115921162
"responses": {
2116021163
"200": {
21161-
"description": "Item's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location",
21164+
"description": "Item's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location.",
2116221165
"headers": {
2116321166
"ETag": {
2116421167
"description": "Last entity revision number",
@@ -21203,7 +21206,7 @@
2120321206
}
2120421207
},
2120521208
"307": {
21206-
"description": "A label in a fallback language exists in the indicated location",
21209+
"description": "A label in a fallback language exists at the indicated location",
2120721210
"headers": {
2120821211
"Location": {
2120921212
"description": "The URL to which the requested resource has been moved",
@@ -22553,7 +22556,8 @@
2255322556
"tags": [
2255422557
"labels"
2255522558
],
22556-
"summary": "Retrieve a Property's label in a specific language, with language fallback. If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label",
22559+
"summary": "Retrieve a Property's label in a specific language, with language fallback",
22560+
"description": "If a label is defined in the requested language, the API responds with a 200 status code and includes the label in the response payload. If a label only exists in a fallback language, the API returns a 307 status code and provides the location of the label.",
2255722561
"parameters": [
2255822562
{
2255922563
"in": "path",
@@ -22639,7 +22643,7 @@
2263922643
],
2264022644
"responses": {
2264122645
"200": {
22642-
"description": "Property's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location",
22646+
"description": "Property's label in a specific language. If a label only exists in a fallback language, the API returns a 307 status code and provides its location.",
2264322647
"headers": {
2264422648
"ETag": {
2264522649
"description": "Last entity revision number",
@@ -22684,7 +22688,7 @@
2268422688
}
2268522689
},
2268622690
"307": {
22687-
"description": "A label in a fallback language exists in the indicated location",
22691+
"description": "A label in a fallback language exists at the indicated location",
2268822692
"headers": {
2268922693
"Location": {
2269022694
"description": "The URL to which the requested resource has been moved",
@@ -39381,7 +39385,7 @@
3938139385
}
3938239386
},
3938339387
"DescriptionMovedTemporarily": {
39384-
"description": "A description in a fallback language exists in the indicated location",
39388+
"description": "A description in a fallback language exists at the indicated location",
3938539389
"headers": {
3938639390
"Location": {
3938739391
"description": "The URL to which the requested resource has been moved",
@@ -41125,7 +41129,7 @@
4112541129
}
4112641130
},
4112741131
"LabelMovedTemporarily": {
41128-
"description": "A label in a fallback language exists in the indicated location",
41132+
"description": "A label in a fallback language exists at the indicated location",
4112941133
"headers": {
4113041134
"Location": {
4113141135
"description": "The URL to which the requested resource has been moved",

0 commit comments

Comments
 (0)