[Dev Documentation] - Vets-API and Vets-Website

[ldelacosta]

Background

We would like to start documenting the API calls to the different endpoints in VAOS. First we would like to start with the vets-api and VAOS service endpoints.

Goal

To create a documentation that provides a high level description of the all the different endpoints VAOS app calls.

Requirements to Consider

N/A

---

Tasks

• Answer the following questions:
  • Q1: What are all the vets-api calls?
  • Q2: What are all the backend services call?

Time Box

TBD

Definition of Done

• Tasks are complete
• Research and recommendations are documented in this ticket

[ldelacosta]

@cferris32 @ryanshaw @simiadebowale - We will use this ticket to track the documentation work. If we need further research on other items not mentioned in this ticket, we will create a new ticket. Thanks!

[JunTaoLuo]

Is the architecture diagram here sufficient? We also did a round of documentation as part of the zero silent errors effort so maybe we already completed this item? cc @JRRoof @simiadebowale