habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
88928d7f722ebf7541e614a40e79d76329d7b067
authentik/website/developer-docs/api/making-schema-changes.md
Simonyi Gergő a3a13d265b website/docs: fix outdated docs and typos (#11020) 
* fix typo

* fix out of date docs on Go client

* remove completed issue from known issues list

* fix typo
2024-08-29 16:12:31 +02:00

994 B
Raw Blame History

title
title
Making schema changes

Some backend changes might require new/different fields or remove other fields. To create a new schema after changing a Serializer, run make gen-build.

This will update the schema.yml file in the root of the repository.

Building the Go Client

The Go client is used by the Outpost to communicate with the backend authentik server. To build the go client, run make gen-client-go.

The generated files are stored in /gen-go-api in the root of the repository.

Building the Web Client

The web client is used by the web-interface and web-FlowExecutor to communicate with authentik. To build the client, run make gen-client-ts.

Since the client is normally distributed as an npm package, running make gen-client-ts will overwrite the locally installed client with the newly built one.

:::caution Running npm i in the /web folder after using make gen-client-ts will overwrite the custom client and revert to the upstream client. :::