@Clement_Goubert We tried to deploy the new patch this afternoon but got a CORS error:

https://test.wikipedia.org/w/index.php?api=lift-wing&title=Special%3ARestSandbox is now live on Test Wiki! 🎉 I've tested it, and all the information appears as expected and "Try it out" works for all endpoints.

Sounds good to me! Thanks for the patch!

Thanks for working on this, @TBurmeister!

In T415293#11964589, @Novem_Linguae wrote:

A small suggestion on the order of steps in Clement's comment. Perhaps the dump should occur after the wiki is set to read only. Edits -> freeze -> snapshot, instead of snapshot -> edits -> freeze.

Thanks for working on this, @gkyziridis! The end goal should be to have one endpoint that serves the YAML for all endpoints. For example: https://api.wikimedia.org/service/lw/inference/v1/openapi.yaml

@Clement_Goubert That sounds good to me! I'll let you know about the schedule once the Lift Wing API docs are migrated.

Fix was released in v1.2.0 and is now live on https://doc.wikimedia.org/mediawiki-core/master/js/. Feel free to reopen if the issue persists

v1.3.0 with these changes is now live! I've updated the docs and will work on some upstream patches later this week

I've gone ahead and started working on a patch to add the Revscoring endpoints to the OpenAPI docs: https://gerrit.wikimedia.org/r/c/machinelearning/liftwing/inference-services/+/1293768

In T419455#11945084, @gkyziridis wrote:

We decided to go first with the current models that are configured in /docs and avoid revscoring/ORES models with (multi-wiki pattern) for now. We will discuss about them in a second iteration.

Marking this as resolved since there is now a plan in place:

This is super helpful. Thanks!

Is there documentation for how to add these examples?

Thanks for your responses. That all sounds good!

The usual pattern for this is to create an API endpoint that serves the OpenAPI file. For example: https://api.wikimedia.org/service/lw/recommendation/api/openapi.json although YAML will also work

Hi @isarantopoulos, thanks for the update!

Hi @KineticPelagic, For ideas for request parameter examples, you can:

• look at the examples in the response schemas. Once 1275490 is merged, there should be a complete set in the Schema directory.
• look at the manually-created docs on mediawiki.org which includes request examples.

Calling to-be-deprecated APIs out of scope for this task

Declining since the API Portal is scheduled to be shut down

Declining since the API Portal is scheduled to be shut down

Update on this: @HCoplin-WMF was able to find this data in Turnilo, where there is some existing and some WIP functionality for bot detection. She put together a spreadsheet (restricted access) that tries to filter out some bot traffic. There is additional bot detection work happening in Q4/Q1 on Data Platform, so we may have even better data soon.

• Updated the tools page: https://www.mediawiki.org/w/index.php?title=Documentation%2FTools&diff=8366307&oldid=8262968
• Added to the Documentation landing page: https://www.mediawiki.org/w/index.php?title=Documentation&diff=8366301&oldid=6899918
• Combined with Documentation/API documentation/Tools: https://www.mediawiki.org/w/index.php?title=Documentation%2FAPI_documentation%2FTools&diff=8366312&oldid=7855573
  • Updated link on https://www.mediawiki.org/wiki/Documentation/API_documentation

@Novem_Linguae Yes and yes :) although the current configs should still work, but it would still be good to update them.

Thanks, @Krinkle! That sounds good to me.

Neat! Thanks for sharing!

Very cool! @isarantopoulos, could you share the response from the /openapi.json request to see what kind output we're getting?

Thank you for opening this and for your work on the upgrade patches, @Umherirrender!

I've gone ahead and started adding examples to the response schemas using the approach in this initial patch. My plan is to add the examples in English for now. Then later on we can look at which examples could be translated and make a decision about where and how to do that and how it fits in to the broader translation strategy for the API docs.

Outcome: https://doc.wikimedia.org/mediawiki-core/master/js/mw.notification.Notification.html

Resolving this as a parent task. Open tasks will be moved under Q4 parent tasks

Thanks for your response, @BPirkle!

Do we really need the swagger UI? How does it play with the API portal's docs?

We ended up going in a slightly different direction with this task:

As https://www.mediawiki.org/wiki/Wikimedia_Technical_Documentation_Team/API_documentation_strategy/Gaps indicates, all APIs in scope for this task meet API documentation standards for information architecture and content. Note that this does not include standardization of reference documentation, which is a parallel effort and tracked in T405571.

Unstalling this task since we can work on standardizing the docs in their current state

Hi all, I'm in the process of deprecating https://api.wikimedia.org/wiki/Feed_API, so I added a few sample calls to the task description to not block any testing here