self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2024-12-22 01:47:08 +02:00
Code Issues Releases 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
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 9 additions and 13 deletions
Show Stats 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.

2
misc/release/pump-version.sh
View File

@ -62,7 +62,7 @@ fi
if [ "$CURRENT_SERVER" != "$NEXT_SERVER" ]; then
echo "Pumping Server: $CURRENT_SERVER => $NEXT_SERVER"
npm --prefix server version $SERVER_PUMP
npm --prefix server run api:generate
make open-api
poetry --directory machine-learning version $SERVER_PUMP
fi

BIN
mobile/openapi/README.md generated
View File

Binary file not shown.

2
open-api/immich-openapi-specs.json
View File

@ -6221,7 +6221,7 @@
"info": {
"title": "Immich",
"description": "Immich API",
"version": "1.93.0",
"version": "1.93.1",
"contact": {}
},
"tags": [],

2
open-api/typescript-sdk/client/api.ts generated
View File

@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.93.0
* The version of the OpenAPI document: 1.93.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
open-api/typescript-sdk/client/base.ts generated
View File

@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.93.0
* The version of the OpenAPI document: 1.93.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
open-api/typescript-sdk/client/common.ts generated
View File

@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.93.0
* The version of the OpenAPI document: 1.93.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
open-api/typescript-sdk/client/configuration.ts generated
View File

@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.93.0
* The version of the OpenAPI document: 1.93.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

2
open-api/typescript-sdk/client/index.ts generated
View File

@ -4,7 +4,7 @@
* Immich
* Immich API
*
* The version of the OpenAPI document: 1.93.0
* The version of the OpenAPI document: 1.93.1
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).