Page MenuHomePhabricator
Create Task
Maniphest T425920

Exclude link objects from wikimedia-paths-parameter-example-exists
Closed, ResolvedPublic3 Estimated Story Points
Actions

Description

Discovered while working on T419576

Linting the OAD example currently raises a wikimedia-paths-parameter-example-exists warning in two locations in the description:

  • paths ➤ /customer/getIdByEmail ➤ get ➤ responses ➤ 200 ➤ links ➤ Customer ➤ parameters ➤ id
  • paths ➤ /customer/verifyCustomer ➤ put ➤ responses ➤ 200 ➤ links ➤ Customer ➤ parameters ➤ id

The warning recommends that we add an example to the parameter. However, the Link object doesn't support examples for values in the parameters field. That field is for parameters that serve a different purpose, don't follow the structure of the Parameter object, and will never contain an example.

Proposed solution: exclude link objects (defined under links in the response and components objects) from this rule.

Details

Related Changes in GitLab:
TitleReferenceAuthorSource BranchDest Branch
wikimedia-paths-parameter-example-exists: Exclude Link Object parameters from validationrepos/ci-tools/wikimedia-spectral-ruleset!6milazgfeat/T425920main
Customize query in GitLab

Related Objects
Search...

Event Timeline

KBach created this task.May 11 2026, 9:37 AM
KBach mentioned this in T419576: Add tests to ensure consistency between OAD example and OpenAPI linter.May 11 2026, 10:03 AM
KBach updated the task description. (Show Details)May 11 2026, 10:06 AM
KBach updated the task description. (Show Details)
KineticPelagic triaged this task as Medium priority.EditedMay 12 2026, 12:45 AM
KineticPelagic moved this task from Incoming (Needs Triage) to To Refine on the MW-Interfaces-Team board.
KineticPelagic subscribed.

As part of my Clinic Duty rotation, I am moving this task to the "To Refine" column of our MWI workboard and assigning "Medium" priority because:

  • An internal MediaWiki team member identified the issue.
  • This task is a subtask of an Open, Medium, committed task , which is currently in the Code Review column of our current Sprint 33. I had a temptation to move this subtask into Sprint 33. Will let our current team member working on the parent task guide.
  • Without addressing this task, the warning recommends developers to do something that we do not actually expect them to do.
  • The task description has a proposed solution. I am not 100% clear if we are ready to proceed with this proposal and/or we want the person who works on the ticket to do an amount of discovery before implementing a solution.
• Atieno subscribed.EditedMay 12 2026, 3:00 PM
  • There's already a rule in the underlying ruleset and we should just cancel it.
  • Sometimes the harder thing is how to make the rule recognise the right structure.
  • During estimation we should give ourselves some leeway
• Atieno moved this task from To Refine to To Estimate on the MW-Interfaces-Team board.May 12 2026, 3:00 PM
HCoplin-WMF set the point value for this task to 3.May 14 2026, 3:30 PM
KBach moved this task from To Estimate to Ready, Sized, & Prioritized on the MW-Interfaces-Team board.May 19 2026, 11:19 AM
HCoplin-WMF assigned this task to MGoncalves-WMF.May 19 2026, 2:56 PM
HCoplin-WMF edited projects, added: MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)); removed: MW-Interfaces-Team.
MGoncalves-WMF changed the task status from Open to In Progress.May 26 2026, 2:15 PM
MGoncalves-WMF moved this task from Committed to In Progress on the MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)) board.
CodeReviewBot added a project: Patch-For-Review.May 28 2026, 2:21 PM

milazg opened https://gitlab.wikimedia.org/repos/ci-tools/wikimedia-spectral-ruleset/-/merge_requests/6

wikimedia-paths-parameter-example-exists: Exclude Link Object parameters from validation

MGoncalves-WMF moved this task from In Progress to Code Review on the MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)) board.May 28 2026, 2:22 PM
CodeReviewBot added a comment.Jun 1 2026, 12:52 PM

aghirelli merged https://gitlab.wikimedia.org/repos/ci-tools/wikimedia-spectral-ruleset/-/merge_requests/6

wikimedia-paths-parameter-example-exists: Exclude Link Object parameters from validation

AGhirelli-WMF moved this task from Code Review to Demo Ready! on the MW-Interfaces-Team (MWI-Sprint-34 (2026-05-19 to 2026-06-02)) board.Jun 1 2026, 12:52 PM
Maintenance_bot removed a project: Patch-For-Review.Jun 1 2026, 1:32 PM
MGoncalves-WMF closed this task as Resolved.Jun 2 2026, 2:17 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