On this page

Maintain API contracts and documentation

Update the production contract and consumers

After changing an API operation, install the dependencies in Work on a local checkout and run these commands from the repository root.

poetry run python scripts/check_openapi_snapshot.py --write
npm --prefix frontend run api:gen
uv --directory sdk/python run --frozen scripts/sdk.py gen
npm --prefix sdk/typescript run gen

The script exports the OpenAPI snapshot using production Django settings. Review the diff for the operation ID, request and response types, access rules and error codes. Then check the affected browser and SDK calls. Use the generators for derived code and edit handwritten SDK facades in their owning packages. Python SDK · TypeScript SDK

Keep both editions current

  1. Update the Russian and English pages in the same change. Describe inputs, expected results and errors. Name the deployment profile if it changes the procedure.

  2. Reuse maintained examples with literalinclude. Use the :source: role to link a file or symbol at the build revision. For a new page, use the same path and add it to both toctrees.

  3. After a node or storage change, check its documented parameters and requirements against the catalogue and API. Build both languages and verify rendered examples, links and the language switch. Documentation build

ContextBase0.1.0

Search the documentation