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

[FranECross]

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):

• Ensure existing functionality is retained/not degraded.
• Ensure the schema takes into consideration future-need items:
  • lat/long (for forward lookup, as well as adding/editing lat/long by editors
  • adding tags to events by editors e.g. audience for categorization
  • language

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

• Schema model created
• Model discussed with engineers
• Notify PM so that ticket VA-277: Add component library structure and docs #2 (Swagger document) can be queued up

[davidmpickett]

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:

• https://schema.org/Event
• https://schema.org/EventSeries
• https://schema.org/EventVenue
  and map our existing Drupal fields for Events onto them as a baseline and look for any gaps