Skip to content

Commit e279e45

Browse files
jenkins-botGerrit Code Review
authored andcommitted
Merge "CRUD: Improve language fallback OAS docs"
2 parents abeb3d4 + c4e2c77 commit e279e45

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
@@ -11506,7 +11506,8 @@
1150611506
"tags": [
1150711507
"descriptions"
1150811508
],
11509-
"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",
11509+
"summary": "Retrieve an Item's description in a specific language, with language fallback",
11510+
"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.",
1151011511
"parameters": [
1151111512
{
1151211513
"in": "path",
@@ -11592,7 +11593,7 @@
1159211593
],
1159311594
"responses": {
1159411595
"200": {
11595-
"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",
11596+
"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.",
1159611597
"headers": {
1159711598
"ETag": {
1159811599
"description": "Last entity revision number",
@@ -11637,7 +11638,7 @@
1163711638
}
1163811639
},
1163911640
"307": {
11640-
"description": "A description in a fallback language exists in the indicated location",
11641+
"description": "A description in a fallback language exists at the indicated location",
1164111642
"headers": {
1164211643
"Location": {
1164311644
"description": "The URL to which the requested resource has been moved",
@@ -12986,7 +12987,8 @@
1298612987
"tags": [
1298712988
"descriptions"
1298812989
],
12989-
"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",
12990+
"summary": "Retrieve a Property's description in a specific language, with language fallback",
12991+
"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.",
1299012992
"parameters": [
1299112993
{
1299212994
"in": "path",
@@ -13072,7 +13074,7 @@
1307213074
],
1307313075
"responses": {
1307413076
"200": {
13075-
"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",
13077+
"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.",
1307613078
"headers": {
1307713079
"ETag": {
1307813080
"description": "Last entity revision number",
@@ -13117,7 +13119,7 @@
1311713119
}
1311813120
},
1311913121
"307": {
13120-
"description": "A description in a fallback language exists in the indicated location",
13122+
"description": "A description in a fallback language exists at the indicated location",
1312113123
"headers": {
1312213124
"Location": {
1312313125
"description": "The URL to which the requested resource has been moved",
@@ -21077,7 +21079,8 @@
2107721079
"tags": [
2107821080
"labels"
2107921081
],
21080-
"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",
21082+
"summary": "Retrieve an Item's label in a specific language, with language fallback",
21083+
"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.",
2108121084
"parameters": [
2108221085
{
2108321086
"in": "path",
@@ -21163,7 +21166,7 @@
2116321166
],
2116421167
"responses": {
2116521168
"200": {
21166-
"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",
21169+
"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.",
2116721170
"headers": {
2116821171
"ETag": {
2116921172
"description": "Last entity revision number",
@@ -21208,7 +21211,7 @@
2120821211
}
2120921212
},
2121021213
"307": {
21211-
"description": "A label in a fallback language exists in the indicated location",
21214+
"description": "A label in a fallback language exists at the indicated location",
2121221215
"headers": {
2121321216
"Location": {
2121421217
"description": "The URL to which the requested resource has been moved",
@@ -22558,7 +22561,8 @@
2255822561
"tags": [
2255922562
"labels"
2256022563
],
22561-
"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",
22564+
"summary": "Retrieve a Property's label in a specific language, with language fallback",
22565+
"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.",
2256222566
"parameters": [
2256322567
{
2256422568
"in": "path",
@@ -22644,7 +22648,7 @@
2264422648
],
2264522649
"responses": {
2264622650
"200": {
22647-
"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",
22651+
"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.",
2264822652
"headers": {
2264922653
"ETag": {
2265022654
"description": "Last entity revision number",
@@ -22689,7 +22693,7 @@
2268922693
}
2269022694
},
2269122695
"307": {
22692-
"description": "A label in a fallback language exists in the indicated location",
22696+
"description": "A label in a fallback language exists at the indicated location",
2269322697
"headers": {
2269422698
"Location": {
2269522699
"description": "The URL to which the requested resource has been moved",
@@ -39673,7 +39677,7 @@
3967339677
}
3967439678
},
3967539679
"DescriptionMovedTemporarily": {
39676-
"description": "A description in a fallback language exists in the indicated location",
39680+
"description": "A description in a fallback language exists at the indicated location",
3967739681
"headers": {
3967839682
"Location": {
3967939683
"description": "The URL to which the requested resource has been moved",
@@ -41417,7 +41421,7 @@
4141741421
}
4141841422
},
4141941423
"LabelMovedTemporarily": {
41420-
"description": "A label in a fallback language exists in the indicated location",
41424+
"description": "A label in a fallback language exists at the indicated location",
4142141425
"headers": {
4142241426
"Location": {
4142341427
"description": "The URL to which the requested resource has been moved",

0 commit comments

Comments
 (0)