Page MenuHomePhabricator

Translation Tagger tool: Implement RESTful API documentation via Swagger UI at the /doc endpoint
Open, Needs TriagePublicFeature

Description

Feature summary (what you would like to be able to do and where):

Expose a RESTful API, documented at the /doc endpoint (via Swagger UI) for the Translation Tagger tool https://toolhub.wikimedia.org/tools/toolforge-translatetagger

Use case(s) (list the steps that you performed to discover that problem, and describe the actual underlying problem which you want to solve. Do not describe only a solution):

Developers attempting to integrate with or build tooling for our platform frequently struggle to understand available endpoints and data structures.

Without a centralised, interactive reference, users must manually inspect the codebase or rely on (possibly outdated) documentation to figure out how to make API calls. This friction prevents third-party developers from efficiently utilising the tool's services and increases the support burden on our team in clarifying interface requirements.

Benefits (why should this be implemented?):

A RESTful API would guarantee more seamless interoperability for new wikis, gadgets and applications.

Providing an auto-generated Swagger UI at a standardised endpoint significantly lowers the barrier to entry for external developers by offering a live, interactive playground to test requests. This improves the developer experience, ensures documentation always stays in sync with the current implementation, and reduces time spent on manual onboarding and troubleshooting integration issues.