Page MenuHomePhabricator
Create Task
Maniphest T416586

Review reference documentation moved off the API Portal
Closed, ResolvedPublic
Actions

Description

Verify and review reference documentation moved off the API Portal and replaced with OpenAPI descriptions.

  • Link Recommendation API
    • Patch created
    • Validated against OpenAPI Specification v2.0
    • Checked with linter and against style guide (with exceptions for OAS 2.0)
    • Confirmed useful for code generation (openapi-generator-cli 7.19.0)
    • Patch merged
  • Page Description API
    • Patch created
    • Partially validated against OpenAPI Specification v3.0.1
    • Partially checked with linter and against style guide (more information in this comment)
    • Confirmed useful for code generation (openapi-generator-cli 7.19.0)
    • Patch merged
  • Feed API
    • Patch created
    • Validated against OpenAPI Specification v2.0
    • Checked with linter and against style guide (with exceptions for OAS 2.0)
    • Confirmed useful for code generation (openapi-generator-cli 7.19.0)
    • Patch merged
  • Lift Wing API

Details

Related Changes in Gerrit:
SubjectAuthorRepoBranchLines +/-
linkrecommendation: Bump version #2Urbanecmoperations/deployment-chartsmaster+1 -1
Revert "linkrecommendation: Bump version"Urbanecmoperations/deployment-chartsmaster+1 -1
linkrecommendation: Bump versionUrbanecmoperations/deployment-chartsmaster+1 -1
docs: Improve operation descriptionKBachresearch/mwaddlinkmain+1 -1
docs: Validate OpenAPI descriptionKBachmediawiki/services/wikifeedsmaster+18 -6
docs: Review and update OpenAPI descriptionKBachresearch/mwaddlinkmain+51 -12
docs: Review and update OpenAPI descriptionKBachmediawiki/services/mobileappsmaster+12 -8
Customize query in gerrit

Related Objects
Search...

Event Timeline

KBach created this task.Feb 5 2026, 12:24 PM
KBach triaged this task as Medium priority.
apaskulin mentioned this in T415293: Shut down the API Portal.Feb 6 2026, 3:25 PM
KBach updated the task description. (Show Details)Feb 12 2026, 11:32 AM
gerritbot added a comment.Feb 12 2026, 12:07 PM

Change #1239064 had a related patch set uploaded (by KBach; author: KBach):

[research/mwaddlink@main] Review and update OAD

https://gerrit.wikimedia.org/r/1239064

gerritbot added a project: Patch-For-Review.Feb 12 2026, 12:07 PM
KBach updated the task description. (Show Details)Feb 13 2026, 10:06 AM
KBach updated the task description. (Show Details)
KBach updated the task description. (Show Details)Feb 13 2026, 10:10 AM
KBach updated the task description. (Show Details)Feb 20 2026, 8:34 AM
gerritbot added a comment.Feb 20 2026, 12:15 PM

Change #1240926 had a related patch set uploaded (by KBach; author: KBach):

[mediawiki/services/mobileapps@master] docs: Review and update OpenAPI description

https://gerrit.wikimedia.org/r/1240926

KBach updated the task description. (Show Details)Feb 20 2026, 12:20 PM
KBach added a comment.Feb 20 2026, 12:44 PM

The Page Description API OAD is split into multiple files. In this task, I only reviewed spec/page/description.yaml. Some recommendations from the Wikimedia OAD style guide could only be verified with a combined OpenAPI description and seemed out of scope for this task. When working with the combined OAD in the future, we might want to ensure that it specifies all the relevant tag-related fields, example fields, as well as servers and externalDocs.

KBach updated the task description. (Show Details)Feb 20 2026, 12:47 PM
gerritbot added a comment.Feb 26 2026, 3:19 PM

Change #1240926 merged by jenkins-bot:

[mediawiki/services/mobileapps@master] docs: Review and update OpenAPI description

https://gerrit.wikimedia.org/r/1240926

KBach updated the task description. (Show Details)Feb 26 2026, 3:37 PM
KBach updated the task description. (Show Details)Mar 3 2026, 3:19 PM
TBurmeister mentioned this in T419455: Generate OpenAPI descriptions for Lift Wing APIs.Mar 9 2026, 5:53 PM
KBach moved this task from Backlog to In progress on the Tech-Docs-Team board.Mar 11 2026, 1:09 PM
gerritbot added a comment.Mar 27 2026, 3:13 PM

Change #1239064 merged by jenkins-bot:

[research/mwaddlink@main] docs: Review and update OpenAPI description

https://gerrit.wikimedia.org/r/1239064

jenkins-bot mentioned this in rRMWAf2b02f4e2f02: docs: Review and update OpenAPI description.Mar 27 2026, 3:22 PM
Maintenance_bot removed a project: Patch-For-Review.Mar 27 2026, 3:31 PM
KBach edited parent tasks, added: T415293: Shut down the API Portal; removed: T405569: API docs work - Q2 and Q3 2025/26.Apr 10 2026, 1:16 PM
gerritbot added a comment.Apr 16 2026, 9:57 AM

Change #1272594 had a related patch set uploaded (by KBach; author: KBach):

[research/mwaddlink@main] docs: Improve operation description

https://gerrit.wikimedia.org/r/1272594

gerritbot added a project: Patch-For-Review.Apr 16 2026, 9:57 AM
KBach updated the task description. (Show Details)Apr 17 2026, 7:18 AM
gerritbot added a comment.Apr 17 2026, 7:25 AM

Change #1273477 had a related patch set uploaded (by KBach; author: KBach):

[mediawiki/services/wikifeeds@master] docs: Validate OpenAPI description

https://gerrit.wikimedia.org/r/1273477

KBach updated the task description. (Show Details)Apr 17 2026, 7:27 AM
KBach updated the task description. (Show Details)
KBach added a comment.Apr 17 2026, 7:36 AM

Two related patches are now in progress. A patch for Link Recommendation API OAD needs a few edits to improve a description of one operation. A patch for Wikifeeds API OAD is ready for review.

I removed the full linter-based review of the Wikifeeds API OAD and the review of Lift Wing OADs from the scope of this task. We will conduct the former once the API is rerouted, and the latter once the OADs are ready.

KBach changed the task status from Open to Stalled.Apr 23 2026, 8:17 AM
gerritbot added a comment.Apr 24 2026, 11:39 AM

Change #1273477 merged by jenkins-bot:

[mediawiki/services/wikifeeds@master] docs: Validate OpenAPI description

https://gerrit.wikimedia.org/r/1273477

KBach updated the task description. (Show Details)Apr 24 2026, 11:40 AM
gerritbot added a comment.Apr 27 2026, 3:13 PM

Change #1272594 merged by jenkins-bot:

[research/mwaddlink@main] docs: Improve operation description

https://gerrit.wikimedia.org/r/1272594

KBach closed this task as Resolved.Apr 27 2026, 3:14 PM
KBach updated the task description. (Show Details)
Maintenance_bot removed a project: Patch-For-Review.Apr 27 2026, 3:31 PM
KBach mentioned this in rRMWAe211f6e29ff7: docs: Improve operation description.Apr 27 2026, 4:13 PM
gerritbot added a comment.Apr 28 2026, 7:50 AM

Change #1278260 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[operations/deployment-charts@master] linkrecommendation: Bump version

https://gerrit.wikimedia.org/r/1278260

gerritbot added a project: Patch-For-Review.Apr 28 2026, 7:50 AM
gerritbot added a comment.Apr 28 2026, 7:53 AM

Change #1278260 merged by jenkins-bot:

[operations/deployment-charts@master] linkrecommendation: Bump version

https://gerrit.wikimedia.org/r/1278260

gerritbot added a comment.Apr 28 2026, 7:58 AM

Change #1278263 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[operations/deployment-charts@master] Revert "linkrecommendation: Bump version"

https://gerrit.wikimedia.org/r/1278263

gerritbot added a comment.Apr 28 2026, 8:00 AM

Change #1278263 merged by jenkins-bot:

[operations/deployment-charts@master] Revert "linkrecommendation: Bump version"

https://gerrit.wikimedia.org/r/1278263

Maintenance_bot removed a project: Patch-For-Review.Apr 28 2026, 8:31 AM
gerritbot added a comment.Apr 28 2026, 10:29 AM

Change #1278385 had a related patch set uploaded (by Urbanecm; author: Urbanecm):

[operations/deployment-charts@master] linkrecommendation: Bump version #2

https://gerrit.wikimedia.org/r/1278385

gerritbot added a project: Patch-For-Review.Apr 28 2026, 10:29 AM
gerritbot added a comment.Apr 28 2026, 10:32 AM

Change #1278385 merged by jenkins-bot:

[operations/deployment-charts@master] linkrecommendation: Bump version #2

https://gerrit.wikimedia.org/r/1278385

Maintenance_bot removed a project: Patch-For-Review.Apr 28 2026, 11:32 AM
apaskulin moved this task from In progress to Done on the Tech-Docs-Team board.May 5 2026, 4:19 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits