Maniphest T252390

Implement check endpoint using the MW:Rest-API
Closed, ResolvedPublic10 Estimated Story Points
Actions

Description

Goal:
Mimic current RESTbase check endpoint

Omit the x-resource location header for this task

Side objectives:
Math extension should be developed in concordance with core and Wikidata. For instance,

Use namespaces
High test coverage
Use DI
Different implementations are not modelled by extending classes but service containers

Useful documentation:

Open Questions not covered by the documentation

Best practices to generate cache keys.
Best practices how to return non 200 response codes serving content
Best practices to chose WANObject cache TTL
Is there no swagger-style documentation for endpoints, to generate https://www.mediawiki.org/wiki/API:REST/Extensions/Documentation_Template from the code?

Details

Subject	Repo	Branch	Lines +/-
Add mathoid check endpoint to REST API	mediawiki/extensions/Math	master	+967 -32
Add MathCheckerFactory Service	mediawiki/extensions/Math	master	+334 -0
Move checking code to a new namespace	mediawiki/extensions/Math	master	+46 -22
Check endpoint using the MW:Rest-API	mediawiki/extensions/Math	master	+499 -33

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Declined	Physikerwelt	T237516 Update to MathJax 3
Declined	None	T252389 Prepare Math extension for MathJax
Resolved	Physikerwelt	T252390 Implement check endpoint using the MW:Rest-API
Declined	None	T253613 Improve FactoryArgTestTrait
Resolved	Jdforrester-WMF	T254031 Enable mediawiki-quibble-apitests-vendor-docker for extension Math

Event Timeline

Physikerwelt created this task.May 11 2020, 10:06 AM

Physikerwelt added a project: Wikimedia-Hackathon-2020.

Physikerwelt moved this task from Inbox to Doing on the Math board.

Physikerwelt set the point value for this task to 10.May 11 2020, 10:08 AM

Change 595558 had a related patch set uploaded (by Physikerwelt; owner: Physikerwelt):
[mediawiki/extensions/Math@master] Check endpoint using the MW:Rest-API

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

gerritbot added a project: Patch-For-Review.May 11 2020, 3:41 PM

(@WDoranWMF|Core Platform Team) this is the work I did during the Hackathon. I spend most of the time reading the documentation of the new features built into MediaWiki. Thus it will require a bit more work to review and revise the design.

• Pchelolo edited projects, added Platform Team Workboards (External Code Reviews); removed Platform Engineering.May 11 2020, 3:54 PM

• Pchelolo moved this task from External Code Review Needed to External Code Review In Progress on the Platform Team Workboards (External Code Reviews) board.May 12 2020, 2:13 PM

Change 595558 abandoned by Physikerwelt:
Check endpoint using the MW:Rest-API

Reason:
Redo with atomic commits

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

Change 595982 had a related patch set uploaded (by Physikerwelt; owner: Physikerwelt):
[mediawiki/extensions/Math@master] Move checking code to a new namespace

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

Change 596006 had a related patch set uploaded (by Physikerwelt; owner: Physikerwelt):
[mediawiki/extensions/Math@master] Add MathCheckerFactory Service

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

@Physikerwelt very cool, thanks for sharing.

Physikerwelt mentioned this in T252587: Improve developer guidelines and documentation for MW REST API framework.May 12 2020, 7:44 PM

Change 595982 merged by jenkins-bot:
[mediawiki/extensions/Math@master] Move checking code to a new namespace

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

ReleaseTaggerBot added a project: MW-1.35-notes (1.35.0-wmf.34; 2020-05-26).May 12 2020, 9:00 PM

Lucas_Werkmeister_WMDE unsubscribed.May 26 2020, 8:18 AM

Change 596006 merged by jenkins-bot:
[mediawiki/extensions/Math@master] Add MathCheckerFactory Service

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

ReleaseTaggerBot edited projects, added MW-1.35-notes (1.35.0-wmf.35; 2020-06-02); removed MW-1.35-notes (1.35.0-wmf.34; 2020-05-26).May 27 2020, 7:00 PM

Maintenance_bot removed a project: Patch-For-Review.May 27 2020, 7:10 PM

Change 599857 had a related patch set uploaded (by Physikerwelt; owner: Physikerwelt):
[mediawiki/extensions/Math@master] Add mathoid check endpoint to REST API

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

gerritbot added a project: Patch-For-Review.May 29 2020, 1:22 PM

Reedy closed subtask T254031: Enable mediawiki-quibble-apitests-vendor-docker for extension Math as Resolved.May 30 2020, 4:54 PM

Jdforrester-WMF reopened subtask T254031: Enable mediawiki-quibble-apitests-vendor-docker for extension Math as Stalled.Jun 1 2020, 8:49 PM

Change 599857 merged by jenkins-bot:
[mediawiki/extensions/Math@master] Add mathoid check endpoint to REST API

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

Maintenance_bot removed a project: Patch-For-Review.Jun 1 2020, 10:10 PM

Physikerwelt closed this task as Resolved.Jun 3 2020, 6:04 AM

Aklapper removed a subtask: T252590: How to give feedback regarding DI?.Aug 15 2020, 5:06 PM

Physikerwelt changed the status of subtask T254031: Enable mediawiki-quibble-apitests-vendor-docker for extension Math from Stalled to Open.Nov 6 2020, 6:30 AM

Physikerwelt closed subtask T254031: Enable mediawiki-quibble-apitests-vendor-docker for extension Math as Resolved.Dec 4 2020, 3:03 PM

• Pchelolo closed subtask T253613: Improve FactoryArgTestTrait as Declined.Aug 13 2021, 1:27 PM