diff options
| author | bpirkle <bpirkle@wikimedia.org> | 2024-11-21 09:47:43 -0600 |
|---|---|---|
| committer | bpirkle <bpirkle@wikimedia.org> | 2024-12-17 11:43:55 -0600 |
| commit | 7b2a765ca7c5e770d4c295a53ec843afe29b6040 (patch) | |
| tree | 7082ed5517f4320c285a0e8c96bbf90520412dcb /includes/Rest/Handler | |
| parent | 92680dc75216e471b896816506a6cbfa192de3b1 (diff) | |
| download | mediawikicore-7b2a765ca7c5e770d4c295a53ec843afe29b6040.tar.gz mediawikicore-7b2a765ca7c5e770d4c295a53ec843afe29b6040.zip | |
REST: Allow response body properties to have translatable descriptions
In https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1078506 we added
the ability to specify path/query parameter descriptions as
MessageValue objects to expose them in a translatable way in
OpenAPI specs. Make the same possible for response body parameters.
Caveat: only schema and top-level property descriptions are translated.
Description translation in nested objects is not supported in this patch.
Bug: T379706
Change-Id: I68215ad55f2e8b2fec4315516e874192faba6595
Diffstat (limited to 'includes/Rest/Handler')
| -rw-r--r-- | includes/Rest/Handler/Schema/RevisionMetaData.json | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/includes/Rest/Handler/Schema/RevisionMetaData.json b/includes/Rest/Handler/Schema/RevisionMetaData.json index a3b8eba027c5..248d06c00fe4 100644 --- a/includes/Rest/Handler/Schema/RevisionMetaData.json +++ b/includes/Rest/Handler/Schema/RevisionMetaData.json @@ -1,5 +1,5 @@ { - "description": "revision meta-data", + "x-i18n-description": "rest-schema-desc-revision-metadata", "required": [ "id", "size", @@ -14,7 +14,7 @@ "properties": { "id": { "type": "integer", - "description": "Revision id" + "x-i18n-description": "rest-property-desc-revision-id" }, "size": { "type": "integer", |