diff options
author | frankie <fgoodwin@wikimedia.org> | 2025-02-12 18:59:18 -0500 |
---|---|---|
committer | bpirkle <bpirkle@wikimedia.org> | 2025-03-20 21:14:42 -0500 |
commit | e08b214a5fddd9bad9722000c352fb2c6e4c4997 (patch) | |
tree | a0721b45e81ae6df66ea592f1afecedb013fb7ac /includes/Rest/Handler | |
parent | 7ea856d4d236a800b730619656d5418dd7f772ed (diff) | |
download | mediawikicore-e08b214a5fddd9bad9722000c352fb2c6e4c4997.tar.gz mediawikicore-e08b214a5fddd9bad9722000c352fb2c6e4c4997.zip |
Translate response body property descriptions for remaining endpoints
Extending the work began in T3847447, in a continued effort to auto-generate translatable messages in OpenAPI specs, refactor schemas for content.v1 endpoints to accept translatable strings.
Bug: T384750
Change-Id: I95b51021babbed1800ed53ee0066cbe83b3b7535
Diffstat (limited to 'includes/Rest/Handler')
-rw-r--r-- | includes/Rest/Handler/Schema/ExistingRevisionHtml.json | 4 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/MediaFile.json | 58 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/MediaLinks.json | 46 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/PageHistory.json | 22 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/PageHistoryCount.json | 6 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/PageLanguageLinks.json | 10 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/RevisionCompare.json | 32 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/RevisionMetaDataBare.json | 4 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/RevisionMetaDataWithSource.json | 4 | ||||
-rw-r--r-- | includes/Rest/Handler/Schema/SearchResults.json | 28 |
10 files changed, 107 insertions, 107 deletions
diff --git a/includes/Rest/Handler/Schema/ExistingRevisionHtml.json b/includes/Rest/Handler/Schema/ExistingRevisionHtml.json index 74903d5201d0..c3d2bccc4f87 100644 --- a/includes/Rest/Handler/Schema/ExistingRevisionHtml.json +++ b/includes/Rest/Handler/Schema/ExistingRevisionHtml.json @@ -87,11 +87,11 @@ "properties": { "id": { "type": "integer", - "x-i18n-description": "rest-property-desc-revision-user-id" + "x-i18n-description": "rest-property-desc-user-id" }, "name": { "type": "string", - "x-i18n-description": "rest-property-desc-revision-user-name" + "x-i18n-description": "rest-property-desc-user-name" } } }, diff --git a/includes/Rest/Handler/Schema/MediaFile.json b/includes/Rest/Handler/Schema/MediaFile.json index 3c20ac19a40f..7cf9649151d3 100644 --- a/includes/Rest/Handler/Schema/MediaFile.json +++ b/includes/Rest/Handler/Schema/MediaFile.json @@ -1,5 +1,5 @@ { - "description": "Information about the file", + "x-i18n-description": "rest-schema-desc-media-file", "required": [ "title", "file_description_url", @@ -11,35 +11,35 @@ "properties": { "title": { "type": "string", - "description": "File title" + "x-i18n-description": "rest-param-desc-media-links-title" }, "file_description_url": { "type": "string", - "description": "URL for the page describing the file, including license information and other metadata" + "description": "rest-param-desc-media-description-url" }, "latest": { "type": "object", "nullable": true, - "description": "Information about the latest revision to the file", + "x-i18n-description": "rest-param-desc-media-latest", "properties": { "timestamp": { "type": "string", "format": "date-time", - "description": "Last modified timestamp in ISO 8601 format" + "x-i18n-description": "rest-param-desc-media-latest-timestamp" }, "user": { "type": "object", - "description": "Information about the user who uploaded the file", + "x-i18n-description": "rest-param-desc-media-latest-user", "properties": { "id": { "type": "integer", "nullable": true, - "description": "User identifier" + "x-i18n-description": "rest-property-desc-user-id" }, "name": { "type": "string", "nullable": true, - "description": "Username" + "x-i18n-description": "rest-property-desc-user-name" } }, "required": [ "id", "name" ] @@ -50,37 +50,37 @@ "preferred": { "type": "object", "nullable": true, - "description": "Information about the file's preferred preview format, original format, and thumbnail format", + "x-i18n-description": "rest-param-desc-media-preferred", "properties": { "mediatype": { "type": "string", "enum": [ "BITMAP", "DRAWING", "AUDIO", "VIDEO", "MULTIMEDIA", "UNKNOWN", "OFFICE", "TEXT", "EXECUTABLE", "ARCHIVE", "3D" ], - "description": "The file type" + "x-i18n-description": "rest-param-desc-media-mediatype" }, "size": { "type": "integer", "nullable": true, - "description": "File size in bytes or null if not available" + "x-i18n-description": "rest-param-desc-media-size" }, "width": { "type": "integer", "nullable": true, - "description": "Maximum recommended image width in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-width" }, "height": { "type": "integer", "nullable": true, - "description": "Maximum recommended image height in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-height" }, "duration": { "type": "number", "nullable": true, - "description": "The length of the video, audio, or multimedia file or null for other media types" + "x-i18n-description": "rest-param-desc-media-duration" }, "url": { "type": "string", "format": "uri", - "description": "URL to download the file" + "x-i18n-description": "rest-param-desc-media-url" } }, "required": [ "mediatype", "size", "width", "height", "duration", "url" ] @@ -88,37 +88,37 @@ "original": { "type": "object", "nullable": true, - "description": "Original file details", + "x-i18n-description": "rest-param-desc-media-original", "properties": { "mediatype": { "type": "string", "enum": [ "BITMAP", "DRAWING", "AUDIO", "VIDEO", "MULTIMEDIA", "UNKNOWN", "OFFICE", "TEXT", "EXECUTABLE", "ARCHIVE", "3D" ], - "description": "The file type" + "x-i18n-description": "rest-param-desc-media-mediatype" }, "size": { "type": "integer", "nullable": true, - "description": "File size in bytes or null if not available" + "x-i18n-description": "rest-param-desc-media-size" }, "width": { "type": "integer", "nullable": true, - "description": "Maximum recommended image width in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-width" }, "height": { "type": "integer", "nullable": true, - "description": "Maximum recommended image height in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-height" }, "duration": { "type": "number", "nullable": true, - "description": "The length of the video, audio, or multimedia file or null for other media types" + "x-i18n-description": "rest-param-desc-media-duration" }, "url": { "type": "string", "format": "url", - "description": "URL to download the file" + "x-i18n-description": "rest-param-desc-media-url" } }, "required": [ "mediatype", "size", "width", "height", "duration", "url" ] @@ -126,37 +126,37 @@ "thumbnail": { "type": "object", "nullable": true, - "description": "Thumbnail information", + "x-i18n-description": "rest-param-desc-media-thumbnail", "properties": { "mediatype": { "type": "string", "enum": [ "BITMAP", "DRAWING", "AUDIO", "VIDEO", "MULTIMEDIA", "UNKNOWN", "OFFICE", "TEXT", "EXECUTABLE", "ARCHIVE", "3D" ], - "description": "The file type" + "x-i18n-description": "rest-param-desc-media-mediatype" }, "size": { "type": "integer", "nullable": true, - "description": "File size in bytes or null if not available" + "x-i18n-description": "rest-param-desc-media-size" }, "width": { "type": "integer", "nullable": true, - "description": "Maximum recommended image width in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-width" }, "height": { "type": "integer", "nullable": true, - "description": "Maximum recommended image height in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-height" }, "duration": { "type": "number", "nullable": true, - "description": "The length of the video, audio, or multimedia file or null for other media types" + "x-i18n-description": "rest-param-desc-media-duration" }, "url": { "type": "string", "format": "uri", - "description": "URL to download the file" + "x-i18n-description": "rest-param-desc-media-preferred-url" } }, "required": [ "mediatype", "size", "width", "height", "duration", "url" ] diff --git a/includes/Rest/Handler/Schema/MediaLinks.json b/includes/Rest/Handler/Schema/MediaLinks.json index fe1dd0fe1eef..5906f0320f7d 100644 --- a/includes/Rest/Handler/Schema/MediaLinks.json +++ b/includes/Rest/Handler/Schema/MediaLinks.json @@ -1,12 +1,12 @@ { - "description": "Media links for the page", + "x-i18n-description": "rest-schema-desc-media-links", "required": [ "files" ], "properties": { "files": { "type": "array", - "description": "Array of media used on the page", + "x-i18n-description": "rest-param-desc-media-links-array", "items": { "type": "object", "required": [ @@ -19,35 +19,35 @@ "properties": { "title": { "type": "string", - "description": "File title" + "x-i18n-description": "rest-param-desc-media-links-title" }, "file_description_url": { "type": "string", - "description": "URL for the page describing the file, including license information and other metadata" + "x-i18n-description": "rest-param-desc-media-description-url" }, "latest": { "type": "object", "nullable": true, - "description": "Information about the latest revision to the file", + "x-i18n-description": "rest-param-desc-media-latest", "properties": { "timestamp": { "type": "string", "format": "date-time", - "description": "Last modified timestamp in ISO 8601 format" + "x-i18n-description": "rest-param-desc-media-latest-timestamp" }, "user": { "type": "object", - "description": "Information about the user who uploaded the file", + "x-i18n-description": "rest-param-desc-media-latest-user", "properties": { "id": { "type": "integer", "nullable": true, - "description": "User identifier" + "x-i18n-description": "rest-property-desc-user-id" }, "name": { "type": "string", "nullable": true, - "description": "Username" + "x-i18n-description": "rest-property-desc-user-name" } }, "required": [ @@ -64,7 +64,7 @@ "preferred": { "type": "object", "nullable": true, - "description": "Information about the file's preferred preview format, original format, and thumbnail format", + "x-i18n-description": "rest-param-desc-media-preferred", "properties": { "mediatype": { "type": "string", @@ -81,32 +81,32 @@ "ARCHIVE", "3D" ], - "description": "The file type" + "x-i18n-description": "rest-param-desc-media-mediatype" }, "size": { "type": "integer", "nullable": true, - "description": "File size in bytes or null if not available" + "x-i18n-description": "rest-param-desc-media-size" }, "width": { "type": "integer", "nullable": true, - "description": "Maximum recommended image width in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-width" }, "height": { "type": "integer", "nullable": true, - "description": "Maximum recommended image height in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-height" }, "duration": { "type": "number", "nullable": true, - "description": "The length of the video, audio, or multimedia file or null for other media types" + "x-i18n-description": "rest-param-desc-media-duration" }, "url": { "type": "string", "format": "uri", - "description": "URL to download the file" + "x-i18n-description": "rest-param-desc-media-url" } }, "required": [ @@ -121,7 +121,7 @@ "original": { "type": "object", "nullable": true, - "description": "Original file details", + "x-i18n-description": "rest-param-desc-media-original", "properties": { "mediatype": { "type": "string", @@ -138,32 +138,32 @@ "ARCHIVE", "3D" ], - "description": "The file type" + "x-i18n-description": "rest-param-desc-media-mediatype" }, "size": { "type": "integer", "nullable": true, - "description": "File size in bytes or null if not available" + "x-i18n-description": "rest-param-desc-media-size" }, "width": { "type": "integer", "nullable": true, - "description": "Maximum recommended image width in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-width" }, "height": { "type": "integer", "nullable": true, - "description": "Maximum recommended image height in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-height" }, "duration": { "type": "number", "nullable": true, - "description": "The length of the video, audio, or multimedia file or null for other media types" + "x-i18n-description": "rest-param-desc-media-duration" }, "url": { "type": "string", "format": "uri", - "description": "URL to download the file" + "x-i18n-description": "rest-param-desc-media-url" } }, "required": [ diff --git a/includes/Rest/Handler/Schema/PageHistory.json b/includes/Rest/Handler/Schema/PageHistory.json index 8d61596b8b53..bab998550ca8 100644 --- a/includes/Rest/Handler/Schema/PageHistory.json +++ b/includes/Rest/Handler/Schema/PageHistory.json @@ -1,5 +1,5 @@ { - "description": "Page revision history", + "x-i18n-description": "rest-schema-desc-page-history", "required": [ "revisions", "latest" @@ -7,7 +7,7 @@ "properties": { "revisions": { "type": "array", - "description": "List of revisions of the page", + "x-i18n-description": "rest-property-desc-revision-array", "items": { "type": "object", "required": [ @@ -22,7 +22,7 @@ "properties": { "id": { "type": "integer", - "description": "Unique revision identifier" + "x-i18n-description": "rest-property-desc-revision-id" }, "timestamp": { "type": "string", @@ -30,30 +30,30 @@ }, "minor": { "type": "boolean", - "description": "True if the edit is marked as minor" + "x-i18n-description": "rest-property-desc-revision-minor" }, "size": { "type": "integer", - "description": "Size of the revision in bytes" + "x-i18n-description": "rest-property-desc-revision-size" }, "comment": { "type": "string", "nullable": true, - "description": "The comment the author associated with the revision" + "x-i18n-description": "rest-property-desc-revision-comment" }, "user": { "type": "object", "nullable": true, - "description": "Information about the user who made the revision", + "x-i18n-description": "rest-property-desc-revision-user", "properties": { "id": { "type": "integer", "nullable": true, - "description": "Unique identifier for the user; null for anonymous users" + "x-i18n-description": "rest-property-desc-user-id" }, "name": { "type": "string", - "description": "Username of the editor, or IP address if the user is anonymous" + "x-i18n-description": "rest-property-desc-user-name" } }, "required": [ @@ -64,7 +64,7 @@ "delta": { "type": "integer", "nullable": true, - "description": "Change in size between this revision and the preceding one; null if not available" + "x-i18n-description": "rest-property-desc-revision-delta" } } } @@ -72,7 +72,7 @@ "latest": { "type": "string", "format": "uri", - "description": "URL to the latest revision of the page" + "x-i18n-description": "rest-property-desc-revision-url" } } } diff --git a/includes/Rest/Handler/Schema/PageHistoryCount.json b/includes/Rest/Handler/Schema/PageHistoryCount.json index d0362597857e..7ed25e1b1885 100644 --- a/includes/Rest/Handler/Schema/PageHistoryCount.json +++ b/includes/Rest/Handler/Schema/PageHistoryCount.json @@ -1,5 +1,5 @@ { - "description": "Page history edit count", + "x-i18n-description": "rest-schema-desc-page-history-count", "required": [ "count", "limit" @@ -7,11 +7,11 @@ "properties": { "count": { "type": "integer", - "description": "Number of edit counts of the specified type" + "x-i18n-description": "rest-property-desc-page-history-edit-count" }, "limit": { "type": "boolean", - "description": "Whether the actual edit count exceeded the allowed limit for that type" + "x-i18n-description": "rest-property-desc-page-history-edit-limit" } } } diff --git a/includes/Rest/Handler/Schema/PageLanguageLinks.json b/includes/Rest/Handler/Schema/PageLanguageLinks.json index c38bee2e5297..deff1d15ec4d 100644 --- a/includes/Rest/Handler/Schema/PageLanguageLinks.json +++ b/includes/Rest/Handler/Schema/PageLanguageLinks.json @@ -1,5 +1,5 @@ { - "description": "Interlanguage links for the page", + "x-i18n-description": "rest-schema-desc-page-language-links", "type": "array", "items": { "required": [ @@ -11,19 +11,19 @@ "properties": { "code": { "type": "string", - "description": "Language code" + "x-i18n-description": "rest-property-desc-page-language-code" }, "name": { "type": "string", - "description": "Translated language name" + "x-i18n-description": "rest-property-desc-page-language-name" }, "key": { "type": "string", - "description": "Translated page title in URL-friendly format" + "x-i18n-description": "rest-property-desc-page-language-key" }, "title": { "type": "string", - "description": "Translated page title in reading-friendly format" + "x-i18n-description": "rest-property-desc-page-language-title" } } } diff --git a/includes/Rest/Handler/Schema/RevisionCompare.json b/includes/Rest/Handler/Schema/RevisionCompare.json index 8d5431cef483..6f711257411f 100644 --- a/includes/Rest/Handler/Schema/RevisionCompare.json +++ b/includes/Rest/Handler/Schema/RevisionCompare.json @@ -1,5 +1,5 @@ { - "description": "Revision comparision", + "x-i18n-description": "rest-schema-desc-revision-compare", "required": [ "from", "to", @@ -8,7 +8,7 @@ "properties": { "from": { "type": "object", - "description": "Details of the 'from' revision", + "x-i18n-description": "rest-param-desc-compare-from", "required": [ "id", "slot_role", @@ -17,15 +17,15 @@ "properties": { "id": { "type": "integer", - "description": "Revision identifier for the from revision" + "x-i18n-description": "rest-param-desc-compare-from-id" }, "slot_role": { "type": "string", - "description": "Role for the slot being compared (currently always 'main')" + "x-i18n-description": "rest-param-desc-compare-from-slotrole" }, "sections": { "type": "array", - "description": "Preprocessor sections for the revision, without template expansion", + "x-i18n-description": "rest-param-desc-compare-from-sections", "items": { "type": "object", "required": [ @@ -36,15 +36,15 @@ "properties": { "level": { "type": "integer", - "description": "Section level" + "x-i18n-description": "rest-param-desc-compare-from-section-level" }, "heading": { "type": "string", - "description": "Section heading e.g. 1 for <h1>" + "x-i18n-description": "rest-param-desc-compare-from-section-heading" }, "offset": { "type": "integer", - "description": "Byte offset within the wikitext at which the section starts" + "x-i18n-description": "rest-param-desc-compare-from-section-offset" } } } @@ -53,7 +53,7 @@ }, "to": { "type": "object", - "description": "Details of the 'to' revision", + "x-i18n-description": "Details of the 'to' revision", "required": [ "id", "slot_role", @@ -62,15 +62,15 @@ "properties": { "id": { "type": "integer", - "description": "Revision identifier for the from revision" + "x-i18n-description": "rest-param-desc-compare-to" }, "slot_role": { "type": "string", - "description": "Role for the slot being compared (currently always 'main')" + "x-i18n-description": "rest-param-desc-compare-to-slotrole" }, "sections": { "type": "array", - "description": "Preprocessor sections for the revision, without template expansion", + "x-i18n-description": "rest-param-desc-compare-to-sections", "items": { "type": "object", "required": [ @@ -81,15 +81,15 @@ "properties": { "level": { "type": "integer", - "description": "Section level" + "x-i18n-description": "rest-param-desc-compare-to-section-level" }, "heading": { "type": "string", - "description": "Section heading e.g. 1 for <h1>" + "x-i18n-description": "rest-param-desc-compare-to-section-heading" }, "offset": { "type": "integer", - "description": "Byte offset within the wikitext at which the section starts" + "x-i18n-description": "rest-param-desc-compare-to-section-offset" } } } @@ -98,7 +98,7 @@ }, "diff": { "type": "array", - "description": "Differences between revisions", + "x-i18n-description": "rest-param-desc-compare-diff", "items": { "type": "object" } diff --git a/includes/Rest/Handler/Schema/RevisionMetaDataBare.json b/includes/Rest/Handler/Schema/RevisionMetaDataBare.json index 710d733d6be0..7393913c88d1 100644 --- a/includes/Rest/Handler/Schema/RevisionMetaDataBare.json +++ b/includes/Rest/Handler/Schema/RevisionMetaDataBare.json @@ -86,11 +86,11 @@ "properties": { "id": { "type": "integer", - "x-i18n-description": "rest-property-desc-revision-user-id" + "x-i18n-description": "rest-property-desc-user-id" }, "name": { "type": "string", - "x-i18n-description": "rest-property-desc-revision-user-name" + "x-i18n-description": "rest-property-desc-user-name" } } }, diff --git a/includes/Rest/Handler/Schema/RevisionMetaDataWithSource.json b/includes/Rest/Handler/Schema/RevisionMetaDataWithSource.json index 9ca62377ed15..6dc3658695e7 100644 --- a/includes/Rest/Handler/Schema/RevisionMetaDataWithSource.json +++ b/includes/Rest/Handler/Schema/RevisionMetaDataWithSource.json @@ -95,11 +95,11 @@ "properties": { "id": { "type": "integer", - "x-i18n-description": "rest-property-desc-revision-user-id" + "x-i18n-description": "rest-property-desc-user-id" }, "name": { "type": "string", - "x-i18n-description": "rest-property-desc-revision-user-name" + "x-i18n-description": "rest-property-desc-user-name" } } }, diff --git a/includes/Rest/Handler/Schema/SearchResults.json b/includes/Rest/Handler/Schema/SearchResults.json index 0dbdd231545d..057273bb1998 100644 --- a/includes/Rest/Handler/Schema/SearchResults.json +++ b/includes/Rest/Handler/Schema/SearchResults.json @@ -1,12 +1,12 @@ { - "description": "Search results", + "x-i18n-description": "rest-schema-desc-search-results", "required": [ "pages" ], "properties": { "pages": { "type": "array", - "description": "List of search result pages", + "x-i18n-description": "List of search result pages", "items": { "type": "object", "required": [ @@ -21,59 +21,59 @@ "properties": { "id": { "type": "integer", - "description": "Page identifier" + "x-i18n-description": "rest-property-desc-page-id" }, "key": { "type": "string", - "description": "Page title in URL-friendly format" + "x-i18n-description": "rest-property-desc-page-key" }, "title": { "type": "string", - "description": "Page title in reading-friendly format" + "x-i18n-description": "rest-param-desc-page-content-title" }, "excerpt": { "type": "string", "nullable": true, - "description": "Excerpt of the page content matching the search query" + "x-i18n-description": "rest-property-desc-search-excerpt" }, "matched_title": { "type": "string", "nullable": true, - "description": "The title of a page redirection from, if applicable, or null" + "x-i18n-description": "rest-property-desc-search-matched-title" }, "description": { "type": "string", "nullable": true, - "description": "Short summary of the page topic or null if no summary exists." + "x-i18n-description": "The title of a page redirection from, if applicable, or null" }, "thumbnail": { "type": "object", "nullable": true, - "description": "Information about the thumbnail image for the page, or null if no thumbnail exists.", + "x-i18n-description": "rest-property-desc-search-thumbnail", "properties": { "mimetype": { "type": "string", - "description": "The file type" + "x-i18n-description": "rest-param-desc-media-mediatype" }, "width": { "type": "integer", "nullable": true, - "description": "Maximum recommended image width in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-width" }, "height": { "type": "integer", "nullable": true, - "description": "Maximum recommended image height in pixels or null if not available" + "x-i18n-description": "rest-param-desc-media-height" }, "duration": { "type": "number", "nullable": true, - "description": "The length of the video, audio, or multimedia file or null for other media types" + "x-i18n-description": "rest-param-desc-media-duration" }, "url": { "type": "string", "format": "uri", - "description": "URL to download the file" + "x-i18n-description": "rest-param-desc-media-url" } }, "required": [ "mimetype", "width", "height", "duration", "url" ] |