Document all endpoints

[Jkd-eth]

User Story:

As the Passport Engineering team
We want to document all endpoints
So that we can setup monitoring and it's easier to support

Acceptance Criteria

GIVEN the existing set of all Passport endpoints
WHEN we check the documentation
THEN all endpoints are present

Include the 3x Scroll endpoints

Product & Design Links:

Tech Details:

Open Questions:

Notes/Assumptions:

[nutrina]

Ideas:

Ideally the list of endpoints could be generated as part of the system tests we will create.
The system tests should have all public endpoints configured.

On the other hand we can also agree to have an open api spec output for all our APIs in all repos: passport (iam), passport-scorer, Passport-data-science and passport-scroll-badge. This would allow generating documentation from the code.

Having the an openapi.json would also allow the system tests to check if all APIs are covered and no (new) API has been forgotten in the system tests.