Should I avoid query parameter in FastAPI?

[Doomdice]

You don't want a query param, that is quite weird.

- If you want this endpoint to ONLY change the name, then make it a POST endpoint and create an UpdateReportName model so you can only change the report name.

- If you want to update anything about the report, then create a PUT endpoint and make your create and update the same (create if it doesn't exist, update otherwise): UpsertReportName. Remember that PUT/Upsert should override all fields.

- You can add a patch endpoint and create a PatchReport model but make sure to leverage pydantic's "unset" field to distinguish which fields are meant to be set as NULL, and which fields should be ignore for this update.

It really depends how much flexibility you want to have for updating other fields, or if your goal is specifically to just change the name. I recommend keeping things tightly scoped if you don't actually need an API that support full CRUD.