Page MenuHomePhabricator
Create Task
Maniphest T384283

Move the existing REST API code into a temporary `repo/domains/crud/` directory
Closed, ResolvedPublic
Actions

Description

The repo/rest-api/ directory becomes a central place containing the REST API documentation, shared infrastructure and e2e test helpers.

Move:

  • all the PHP code and phpunit tests
  • OpenAPI document
  • all the e2e end and OAS tests

Don't move:

  • test helpers
  • OpenAPI document build step
  • routes.dev.json

The README.md has to be split. Things concerning the REST API as a whole should stay in that directory. Everything specific to the domain (/the PHP code) moves into repo/domaisn/crud/README.md.

Wire up namespaces; basically https://gerrit.wikimedia.org/r/c/mediawiki/extensions/Wikibase/+/764731 but for the new directory.

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
Split README between repo/domains/crud/ and repo/rest-api/mediawiki/extensions/Wikibasemaster+39 -37
Move GetOpenApiDocRouteHandler back into repo/rest-api/mediawiki/extensions/Wikibasemaster+11 -9
Move CRUD-related e2e tests to domains/crud/mediawiki/extensions/Wikibasemaster+174 -141
Move CRUD-related OpenAPI doc to domains/crud/mediawiki/extensions/Wikibasemaster+69 -66
Move RestApi PHP namespace to Domains\Crudmediawiki/extensions/Wikibasemaster+5 K -5 K
Move REST API PHP code to repo/domains/crud/mediawiki/extensions/Wikibasemaster+25 -24
Customize query in gerrit

Related Objects
Search...

Event Timeline

Jakob_WMDE created this task.Jan 21 2025, 10:37 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJan 21 2025, 10:37 AM
Jakob_WMDE updated the task description. (Show Details)Jan 21 2025, 10:42 AM
Jakob_WMDE claimed this task.Jan 22 2025, 3:15 PM
Jakob_WMDE moved this task from To Do to Doing on the Wikibase Reuse Team (Sprint 37) board.
gerritbot added a comment.Jan 24 2025, 3:58 PM

Change #1114006 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] Move REST API PHP code to repo/domains/crud/

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

gerritbot added a project: Patch-For-Review.Jan 24 2025, 3:58 PM
gerritbot added a comment.Jan 24 2025, 4:48 PM

Change #1114017 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] Move RestApi PHP namespace to Domains\Crud

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

gerritbot added a comment.Jan 27 2025, 9:18 AM

Change #1114334 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] Move CRUD-related OpenAPI doc to domains/crud/

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

gerritbot added a comment.Jan 29 2025, 4:06 PM

Change #1114006 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Move REST API PHP code to repo/domains/crud/

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

gerritbot added a comment.Jan 29 2025, 4:30 PM

Change #1114017 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Move RestApi PHP namespace to Domains\Crud

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

gerritbot added a comment.Jan 29 2025, 4:30 PM

Change #1114334 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Move CRUD-related OpenAPI doc to domains/crud/

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

ReleaseTaggerBot added a project: MW-1.44-notes (1.44.0-wmf.15; 2025-02-04).Jan 29 2025, 5:01 PM
gerritbot added a comment.Jan 30 2025, 2:00 PM

Change #1115386 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] Move CRUD-related e2e tests to domains/crud/

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

gerritbot added a comment.Jan 30 2025, 5:16 PM

Change #1115464 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] Move GetOpenApiDocRouteHandler back into repo/rest-api/

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

gerritbot added a comment.Jan 30 2025, 5:35 PM

Change #1115465 had a related patch set uploaded (by Jakob; author: Jakob):

[mediawiki/extensions/Wikibase@master] Split README between repo/domains/crud/ and repo/rest-api/

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

Jakob_WMDE moved this task from Doing to Peer Review on the Wikibase Reuse Team (Sprint 37) board.Jan 30 2025, 6:37 PM
gerritbot added a comment.Jan 31 2025, 1:06 PM

Change #1115386 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Move CRUD-related e2e tests to domains/crud/

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

gerritbot added a comment.Jan 31 2025, 2:51 PM

Change #1115464 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Move GetOpenApiDocRouteHandler back into repo/rest-api/

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

gerritbot added a comment.Jan 31 2025, 3:46 PM

Change #1115465 merged by jenkins-bot:

[mediawiki/extensions/Wikibase@master] Split README between repo/domains/crud/ and repo/rest-api/

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

Maintenance_bot removed a project: Patch-For-Review.Jan 31 2025, 4:30 PM
Silvan_WMDE moved this task from Peer Review to Done on the Wikibase Reuse Team (Sprint 37) board.Feb 3 2025, 10:07 AM
WMDE-leszek closed this task as Resolved.Feb 4 2025, 12:39 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