Hello, technical volunteer community!

Earlier today we kicked off a limited release of a new SwaggerUI-based
sandbox experience for MediaWiki REST APIs!  In addition to offering
funcitonally
validated, interactive documentation, the sandbox will support translation
(powered by translatewiki <https://translatewiki.net/>) for all endpoint
and parameter descriptions, so that developers may read the documentation
and download OpenAPI specs in their preferred language. The combination of
interactive sandbox docs and OpenAPI specs were among the top requested
items in the latest developer satisfaction survey
<https://www.mediawiki.org/wiki/Developer_Satisfaction_Survey/2025/APIs#api-wishlist-and-feedback>,
so we are eager to hear what you all think about the new experience!

The initial launch is available in the following Wikipedia language
communities (selected based on the availability of translation coverage):

   - Arabic
   
<https://ar.wikipedia.org/wiki/%D8%AE%D8%A7%D8%B5:%D9%85%D9%84%D8%B9%D8%A8_%D8%B1%D8%B3%D8%AA>
   (ar)
   - German <https://de.wikipedia.org/wiki/Spezial:RestSandbox> (de)
   - French <https://fr.wikipedia.org/wiki/Sp%C3%A9cial%3ARestSandbox> (fr)
   - Hebrew
   <https://he.wikipedia.org/wiki/%D7%9E%D7%99%D7%95%D7%97%D7%93:RestSandbox>
   (he)
   - Interlingua <https://ia.wikipedia.org/wiki/Special%3ARestSandbox> (ia)
   - Dutch <https://nl.wikipedia.org/wiki/Speciaal:RestSandbox> (nl)
   - Chinese <https://zh.wikipedia.org/wiki/Special:REST%E6%B2%99%E7%9B%92>
   (zh-hans, zh-hant)
   - English (testwiki <https://test.wikipedia.org/wiki/Special:RestSandbox>,
   Wiktionary <https://en.wiktionary.org/wiki/Special%3ARestSandbox>)


If you are a member of any of these communities (or want to check it out in
the testwiki), we would love your feedback
<https://www.mediawiki.org/wiki/MediaWiki_Interfaces_Team/Feature_Feedback/REST_Sandbox>.
On the linked feedback page, you can see additional information about this
project, as well as track progress on issues that we are already aware of.

In addition to verifying that everything is translated and working
correctly, we would like to get general feedback on the experience. Please
review and respond to the open ended prompts either here or on the REST
Sandbox feedback
<https://www.mediawiki.org/wiki/MediaWiki_Interfaces_Team/Feature_Feedback/REST_Sandbox>
discussion page:

   1. Do you believe that providing the documentation in your wiki
   community's preferred language will help developers better understand the
   content?
   2. Are the translations accurate and appropriate in your language?
   3. How disruptive or confusing are the mixed English headers and
   navigation items?
   4. How do you intend to use the OpenAPI specs that are now available
   through the sandbox?
   5. How will the sandbox change how you interact with the MediaWiki REST
   API?
   6. Would you like to see similar experiences for other APIs offered by
   Wikimedia?
   7. As an extension author, would you leverage this experience to provide
   interactive documentation for your extension's API?


Following the initial limited release, we will collect feedback for
approximately two weeks. Assuming we get enough feedback and do not have
any major issues, we plan to make the same REST Sandbox available across
all wiki projects before the end of April.

Please let me know if you have any initial questions, comments, or
concerns.

Thanks,
Halley
*Halley Coplin* (she/her)
Sr. Product Manager, MediaWiki Interfaces
Wikimedia Foundation <https://wikimediafoundation.org/>
_______________________________________________
Wikitech-l mailing list -- wikitech-l@lists.wikimedia.org
To unsubscribe send an email to wikitech-l-le...@lists.wikimedia.org
https://lists.wikimedia.org/postorius/lists/wikitech-l.lists.wikimedia.org/

Reply via email to