Confirm
514
edits
Changes
m
* Mentors: [https://mozillians.org/en-US/u/ethan.glasser.camp/ Ethan Glasser-Camp] (glasserc on IRC) and [https://mozillians.org/en-US/u/natim/ Rémy Hubscher (natim on IRC)] <br />Participants: Mansimar Kaur and Gabriela Surita <br />[http://mansimar.com Mansimar's Website] <br />
→Add support for OpenAPI to Kinto: project updated
==== Add support for OpenAPI to Kinto ====
Kinto has a fairly comprehensive set of documentation that describes its API. However, the cool new thing is OpenAPIs (formerly known as Swagger). Documenting our API using this specification would facilitate the implementation of client libraries in other languages as well as open the door to lots of other projects, including "interactive" documentation which has buttons that launch requests against a live server.
The Kinto team is seeking an intern to 's participants will work on developing OpenAPI support in Kinto. This project is ideal for an Outreachy intern because it is self-contained and doesn't require understanding a complicated ecosystem The reservoir of services (unlike our previous "Push Notifications" project). We have structured the project to have multiple tasks. We do not expect any intern to finish every task; instead, we can draw tasks from this reservoir according to your momentum. These tasks areincludes:
* Document the existing API by writing an OpenAPI specification. This will involve reading the existing documentation and experimenting with the Kinto server.
* Add runnable examples to the documentation. This will involve comparative analyses of available tools as well as working with our Sphinx-based documentation.
