Page MenuHomePhabricator

Firehose API Endpoints Documentation
Closed, ResolvedPublic5 Estimated Story Points

Description

When I'm using Firehose API, I want to able to be able to read the docs so I can know how to use the API.

Notes:

  1. I suggest manually creating and maintaining "swagger.json" and use docker image for UI.

Acceptance criteria:
Firehose API has a documentation endpoint where I can see and play around with the docs.

Event Timeline

This can be done independently from docker configuration and then merged together, I would suggest have docs.json file ore something like that in the root of the project and swagger UI in docker container (dcoker-compose.yaml) . But feel free to research and explore other options. We used this to generate docs in v1 and it was not bad, but has certain limitations in API support and lack of documentation.

AnnaMikla set the point value for this task to 5.Sep 1 2021, 4:14 PM
Sashah2 changed the task status from Open to In Progress.Sep 16 2021, 10:54 PM
Sashah2 changed the task status from In Progress to Open.