department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
98 stars 68 forks source link

[Events v3 - MVP] [#1] Create a schema model for Events V3 API #18947

Open FranECross opened 2 months ago

FranECross commented 2 months ago

Status

[2024-08-14] [Fran] @dsasser , @davidmpickett , and @chriskim2311 to edit and async refine.

Description

In prep for building a Swagger API document, and a mock API, a schema model needs to be created.

Things to keep in mind (from the initiative):

User story

AS A PO/PM/Engineer for Events v3 API I WANT a schema model created and discussed SO THAT a Swagger API document and subsequent mock API/actual API may be built using this guidance

Engineering notes / background

Analytics considerations

Quality / testing notes

Acceptance criteria

davidmpickett commented 2 months ago

Being new to API design, I am not sure what the expected output of this ticket would be. Would we just be outlining Schemas, or would we also get into thinking about Operations in this ticket? I guess they are a little interwoven.

Another way of asking the question: What level of detail do we get into in this ticket vs number 2?

My assumption is that we would take things like: