Description
PUT /entities/properties/{property_id}/description/{language_code}
Acceptance criteria:
- The respective successful responses should present the relevant data as a string -- similar to the responses of GET /entities/properties/{property_id}/descriptions/{language_code}.
- If a description in the given language didn't exist before the successful request the response should use 201 code.
- If the request changed the existing description, the response code should be 200.
Error cases to consider
| HTTP response code | response payload | |
|---|---|---|
| Property does not exist | 404 | "code": "property-not-found" "message": "Could not find a property with the ID: {property_id}" |
| Invalid property ID | 400 | "code": "invalid-property-id" "message": "Not a valid property ID: {property_id}" "context": {"property": "{property-id}"} |
| Invalid language code | 400 | { "code": "invalid-language-code", "message": "Not a valid language code: {language_code}"} |
| Description contains invalid characters | 400 | "code": "invalid-description" "message": "Not a valid description: {description}" |
| Description is empty | 400 | { "code": "description-empty", "message": "Description must not be empty" } |
| Description too long | 400 | { "code": "description-too-long", "message": "Description must be no more than {limit} characters long", "context": { "value": "{description}", "character-limit": "{limit}" } } |
| Label description same value | 400 | { "code": "label-description-same-value", "message": "Label and description for language code '{language}' can not have the same value", "context": { "language": "{language}" } } |
| Invalid edit tag | 400 | { "code": "invalid-edit-tag", "message": "Invalid MediaWiki tag: {tag}" } |
| Comment too long | 400 | {"code": "comment-too-long", "message": "Comment must not be longer than {limit} characters"} |
Notes
- Automated edit summaries similar as done for items: https://phabricator.wikimedia.org/T323813
- client can provide additional edit metadata: mediawiki tags, edit summary text to append to the automated summary, and a bot edit flag, like in GET /entities/properties/{property_id}/descriptions/{language_code}
- mul is a not allowed for descriptions
- Handle HTTP conditional request headers as in PUT /entities/items/{item_id}/descriptions/{language_code}
- Handle user authentication/authorization like in PUT /entities/items/{item_id}/descriptions/{language_code}
Task breakdown notes:
- Add the new route to OAS.
- create use case validation deserialization:
- create PropertyDescriptionValidator interface and implement it (WikibaseRepoPropertyDescriptionValidator)
- create PropertyDescriptionEditRequest interface
- create PropertyDescriptionEditRequestValidatingDeserializer
rename TermValidatorFactoryDescriptionTextValidator to TermValidatorFactoryItemDescriptionTextValidatorcreate a new TermValidatorFactoryPropertyDescriptionTextValidator
- happy path (with edit summary)
- use the use case validator for deserialization only, but don't handle or test any errors it throws yet
- ETag and Last-Modified
- differentiate between 200 OK for replaced and 201 CREATED for a newly added description
- Handle request validation errors
- Respond 404 if property not found
- Authorization
- Use the usual middlewares and add the route handler to RouteHandlersTest
- Add spec tests.
- Mark as production ready.