public/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-12-07 07:33:47 +09:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

fix: open api pump (#6502)

Browse Source
This commit is contained in:
Jason Rasmussen
2024-01-19 12:09:18 -05:00
committed by GitHub
parent d5af357992
commit df27460f1c
9 changed files with 10 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/developer/open-api.md
View File

@@ -7,11 +7,7 @@ Immich uses the [OpenAPI](https://swagger.io/specification/) standard to generat
OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generator-cli` can be installed [here](https://openapi-generator.tech/docs/installation/). The generated SDK is based on the `immich-openapi-specs.json` file, which is autogenerated by the server **when running in development mode**. The `immich-openapi-specs.json` file can be modified with `@nestjs/swagger` decorators used or referenced by controller endpoints. See the [NestJS OpenAPI docs](https://docs.nestjs.com/openapi/types-and-parameters) for more info. When you add a new endpoint or modify an existing one, you must run the server in development mode and run the command below to update the client SDK.
```bash
npm run api:generate # Run from the `server/` directory
make open-api
```
You can find the generated client SDK in the `web/src/api` for Typescript SDK and `mobile/openapi` for Dart SDK.
:::tip
This can also be run via `make open-api` from the project root directory (not in the `server` folder)
:::
You can find the generated client SDK in the `open-api/typescript-sdk/client` for Typescript SDK and `mobile/openapi` for Dart SDK.