Schema File organization

[jirhiker]

status: Accepted
date: 7/30/225

currently the schema package is organized like

schemas
  -- create
     ...
     |-- contact
     ...
     |-- thing
     ...
 -- response
     ...
     |-- contact
     ...
     |-- thing
     ...
-- update
     ...
     |-- contact
     ...
     |-- thing
     ...

doesn't it makes sense to just have one schema file per entity? With each file containing the necessary pydantic models. e.g WellCreate, WellUpdate, WellResponse

[chasetmartin]

I agree with this proposal, as this also simplifies schema imports from the api, and therefore developer experience. I propose that there are clearly delineated sections within each entity schema file for each operation type, like in schemas/contact.py:

# -------- CREATE --------
# |-- contact
def CreateContact():
# |-- phone
def CreatePhone():
...

# -------- RESPONSE --------
# |-- contact
def ContactResponse():
# |-- phone
def PhoneReponse():
...

# -------- UPDATE --------
# |-- contact
def UpdateContact():
# |-- phone
def UpdatePhone():
...