repo/rest-api/specs/resources/descriptions/description-in-language-for-item.json
{
"get": {
"operationId": "getItemDescription",
"tags": [ "descriptions" ],
"summary": "Retrieve an Item's description in a specific language",
"parameters": [
{ "$ref": "../../global/parameters.json#/ItemId" },
{ "$ref": "../../global/parameters.json#/LanguageCode" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfModifiedSince" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
{ "$ref": "../../global/parameters.json#/Authorization" }
],
"responses": {
"200": { "$ref": "./responses.json#/ItemDescription" },
"304": { "$ref": "../../global/responses.json#/NotModified" },
"308": { "$ref": "../../global/responses.json#/MovedPermanently" },
"400": { "$ref": "../../global/responses.json#/InvalidTermByLanguageInput" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
},
"put": {
"operationId": "replaceItemDescription",
"tags": [ "descriptions" ],
"summary": "Add / Replace an Item's description in a specific language",
"parameters": [
{ "$ref": "../../global/parameters.json#/ItemId" },
{ "$ref": "../../global/parameters.json#/LanguageCode" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfModifiedSince" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
{ "$ref": "../../global/parameters.json#/Authorization" }
],
"requestBody": {
"description": "Payload containing Item description in the specified language and edit metadata",
"required": true,
"content": {
"application/json": {
"schema": { "$ref": "./requests.json#/SetDescriptionInLanguage" },
"example": {
"description": "famous person",
"tags": [],
"bot": false,
"comment": "set English description"
}
}
}
},
"responses": {
"200": {
"description": "The updated description",
"$ref": "./responses.json#/ItemDescription"
},
"201": {
"description": "The newly added description",
"$ref": "./responses.json#/ItemDescription"
},
"304": { "$ref": "../../global/responses.json#/NotModified" },
"400": { "$ref": "../../global/responses.json#/InvalidSetDescriptionInput" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"409": { "$ref": "../../global/responses.json#/ItemRedirected" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"422": { "$ref": "../../global/responses.json#/DataPolicyViolation" },
"429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
},
"delete": {
"operationId": "deleteItemDescription",
"tags": [ "descriptions" ],
"summary": "Delete an Item's description in a specific language",
"parameters": [
{ "$ref": "../../global/parameters.json#/ItemId" },
{ "$ref": "../../global/parameters.json#/LanguageCode" },
{ "$ref": "../../global/parameters.json#/IfNoneMatch" },
{ "$ref": "../../global/parameters.json#/IfModifiedSince" },
{ "$ref": "../../global/parameters.json#/IfMatch" },
{ "$ref": "../../global/parameters.json#/IfUnmodifiedSince" },
{ "$ref": "../../global/parameters.json#/Authorization" }
],
"requestBody": { "$ref": "../../global/requests.json#/Delete" },
"responses": {
"200": { "$ref": "./responses.json#/DescriptionDeleted" },
"400": { "$ref": "../../global/responses.json#/InvalidRemoveDescriptionInput" },
"403": { "$ref": "../../global/responses.json#/PermissionDenied" },
"404": { "$ref": "../../global/responses.json#/ResourceNotFound" },
"409": { "$ref": "../../global/responses.json#/ItemRedirected" },
"412": { "$ref": "../../global/responses.json#/PreconditionFailedError" },
"429": { "$ref": "../../global/responses.json#/RequestLimitReached" },
"500": { "$ref": "../../global/responses.json#/UnexpectedError" }
}
}
}