Missing model/schema examples

[slaarti]

Okay, well, I went through all of the docs/, fastcrud/, and tests/ directories, and compiled all of the tables and schemas that were referenced (sometimes in multiple places, but I just noted where I first saw them) and/or defined. Sometimes there are not-quite-duplicates, like UserCreateSchema and CreateUserSchema, which I noted down separately but should probably be unified somehow.

Item

• Item - table - defined in docs/index.md :tada:
• ItemSchema - schema - defined in docs/index.md :tada:
• ItemCreateSchema - schema - defined in docs/index.md :tada:
• ItemUpdateSchema - schema - defined in docs/index.md :tada:

Order

• Order - table - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• OrderModel - table - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• OrderSchema - schema - ref'd in docs/usage/crud.md - Undefined :exclamation:
• OrderCreateSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• OrderReadSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• CreateOrderSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• UpdateOrderSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:

Customer

• Customer - table - ref'd in docs/usage/crud.md - Undefined :exclamation:
• CustomerSchema - schema - ref'd in docs/usage/crud.md - Undefined :exclamation:

Project

• Project - table - defined in tests/*/conftest.py :tada:
• ProjectSchema - schema - ref'd in docs/advanced/crud.md - Undefined :exclamation:

Participant

• Participant - table - defined in tests/*/conftest.py :tada:

User

• User - table - incompletely defined in docs/advanced/joins.md :interrobang:
• UserModel - table - ref'd in docs/advanced/crud.md - Undefined :exclamation:
• UserSchema - schema - ref'd in docs/advanced/crud.md - Undefined :exclamation:
• UserCreateSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• UserUpdateSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• UserReadSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• CreateUserSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• UpdateUserSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:

Tier

• Tier - table - defined in docs/advanced/joins.md :interrobang:
• TierModel - table - defined in tests/*/conftest.py :tada:
• TierSchema - schema - ref'd in docs/advanced/crud.md - Undefined :exclamation:

Tier and TierModel are nearly identical, except that TierModel has a field relating it to the ModelTest table; are they supposed to be the same? There's also a TierSchemaTest in the conftest.py files; should TierSchema be renamed to this?

Department

• Department - table - ref'd in docs/advanced/crud.md - Undefined :exclamation:
• DepartmentSchema - schema - ref'd in docs/advanced/crud.md - Undefined :exclamation:

Task

• Task - table - ref'd in docs/advanced/crud.md - Undefined :exclamation:
• TaskModel - table - ref'd in docs/advanced/crud.md - Undefined :exclamation:
• TaskSchema - schema - ref'd in docs/advanced/crud.md - Undefined :exclamation:
• TaskCreateSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• CreateTaskSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• UpdateTaskSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:

MyModel

• MyModel - table - defined in docs/advanced/endpoint.md :tada:
• CreateMyModel - schema - ref'd in docs/advanced/endpoint.md - Undefined :exclamation:
• UpdateMyModel - schema - ref'd in docs/advanced/endpoint.md - Undefined :exclamation:
• CreateMyModelSchema - schema - ref'd in docs/advanced/endpoint.md - Undefined :exclamation:
• UpdateMyModelSchema - schema - ref'd in docs/advanced/endpoint.md - Undefined :exclamation:
• DeleteMyModelSchema - schema - ref'd in docs/advanced/endpoint.md - Undefined :exclamation:

Role

• Role - table - ref'd in docs/advanced/joins.md - Undefined :exclamation:

Product

• Product - table - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• ProductModel - table - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• ProductCreateSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• ProductReadSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• CreateProductSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• UpdateProductSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• DeleteProductSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:

Comment

• Comment - table - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:
• CommentCreateSchema - schema - ref'd in fastcrud/crud/fast_crud.py - Undefined :exclamation:

ModelTest

• ModelTest - table - defined in tests/*/conftest.py :tada:

Booking

• BookingModel - table - defined in tests/*/conftest.py :tada:
• BookingSchema - schema - defined in tests/*/conftest.py :tada:

Customer

• CustomerModel - table - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• CreateCustomerSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:
• UpdateCustomerSchema - schema - ref'd in fastcrud/endpoint/crud_router.py - Undefined :exclamation:

OtherModel

• OtherModel - table - ref'd in fastcrud/endpoint/endpoint_creator.py - Undefined :exclamation:
• CreateOtherModel - schema - ref'd in fastcrud/endpoint/endpoint_creator.py - Undefined :exclamation:
• UpdateOtherModel - schema - ref'd in fastcrud/endpoint/endpoint_creator.py - Undefined :exclamation:

Originally posted by @slaarti in https://github.com/igorbenav/fastcrud/issues/68#issuecomment-2093104741

[igorbenav]

@slaarti do you still plan to do this?

[slaarti]

Oh, I've been not just planning, but actively working on it since the ticket got filed, up until about last week when I kind of got burned out from having gone through multiple iterations of it and then seeing there've been more commits on main and experiencing merge integration hell.

Of course, I'm certainly not about to insist that other work stop or anything, so obviously I need to change up how I'm doing things to not keep running into this. I think my current plan, once I get back on the horse, is to start from a fresh branch off current main and push out multiple smaller PRs than my initial intention had been. Basic overall doc consistency cleanup first, and then adding in the examples in chunks.

[igorbenav]

Damn, now I feel bad. Let me know if you need any help.