Page MenuHomeSoftware Heritage

content review for the API doc page
Closed, MigratedEdits Locked

Description

In view of opening up the API, we need to thoroughly review the content of each endpoint listed in the API doc page.

The following action items come to mind, but more might be needed and added later:

  • we are not going to open up all endpoints, so some of them will need to be hidden/removed. How can we do that without having to remove the actual doc from the code? (T631)
  • we need an introductory paragraph at the beginning of the page, which is not tied to any particular endpoint, to explain what this page is (T630)
  • we need to review each endpoint description for content, uniformity of language, etc.

Revisions and Commits

Related Objects

Event Timeline

zack moved this task from Restricted Project Column to Restricted Project Column on the Restricted Project board.
zack removed a subscriber: olasd.
zack raised the priority of this task from Normal to High.Jan 27 2017, 10:06 AM
zack changed the task status from Open to Work in Progress.Jan 30 2017, 4:54 PM