Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing model/schema examples #72

Open
slaarti opened this issue May 5, 2024 · 0 comments
Open

Missing model/schema examples #72

slaarti opened this issue May 5, 2024 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@slaarti
Copy link
Contributor

slaarti commented May 5, 2024

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 🎉
  • ItemSchema - schema - defined in docs/index.md 🎉
  • ItemCreateSchema - schema - defined in docs/index.md 🎉
  • ItemUpdateSchema - schema - defined in docs/index.md 🎉

Order

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

Customer

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

Project

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

Participant

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

User

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

Tier

  • Tier - table - defined in docs/advanced/joins.md ⁉️
  • TierModel - table - defined in tests/*/conftest.py 🎉
  • TierSchema - schema - ref'd in docs/advanced/crud.md - Undefined

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
  • DepartmentSchema - schema - ref'd in docs/advanced/crud.md - Undefined

Task

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

MyModel

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

Role

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

Product

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

Comment

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

ModelTest

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

Booking

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

Customer

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

OtherModel

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

Originally posted by @slaarti in #68 (comment)

@igorbenav igorbenav added documentation Improvements or additions to documentation bug Something isn't working labels May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants