funkwhale/docs/developer/api/schema.md

8 lines
450 B
Markdown

# OpenAPI schema
The client-side app needs up to date schemas. If you change something in the API, then you need to upgrade the schema as well. Run: `docker compose run --rm api funkwhale-manage spectacular > ./api/funkwhale_api/common/schema.yml`.
Then you need to regenerate the app schema has well by running `yarn generate-types-from-local-schema`.
Be aware that `get_signup_form_additional_fields_serializer` can tweak the schema generation.