diff --git a/docs/docs/developer/open-api.md b/docs/docs/developer/open-api.md index ca9473a649..2c29c7365b 100644 --- a/docs/docs/developer/open-api.md +++ b/docs/docs/developer/open-api.md @@ -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. diff --git a/misc/release/pump-version.sh b/misc/release/pump-version.sh index a237909713..3342372fc6 100755 --- a/misc/release/pump-version.sh +++ b/misc/release/pump-version.sh @@ -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 diff --git a/mobile/openapi/README.md b/mobile/openapi/README.md index 10e5ecd45c..755f4afee1 100644 --- a/mobile/openapi/README.md +++ b/mobile/openapi/README.md @@ -3,7 +3,7 @@ Immich API This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: -- API version: 1.93.0 +- API version: 1.93.1 - Build package: org.openapitools.codegen.languages.DartClientCodegen ## Requirements diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json index e6be8b8e36..16f665d26f 100644 --- a/open-api/immich-openapi-specs.json +++ b/open-api/immich-openapi-specs.json @@ -6221,7 +6221,7 @@ "info": { "title": "Immich", "description": "Immich API", - "version": "1.93.0", + "version": "1.93.1", "contact": {} }, "tags": [], diff --git a/open-api/typescript-sdk/client/api.ts b/open-api/typescript-sdk/client/api.ts index 6f68d29e66..a899fda5ac 100644 --- a/open-api/typescript-sdk/client/api.ts +++ b/open-api/typescript-sdk/client/api.ts @@ -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). diff --git a/open-api/typescript-sdk/client/base.ts b/open-api/typescript-sdk/client/base.ts index 9743cb9594..d09d838319 100644 --- a/open-api/typescript-sdk/client/base.ts +++ b/open-api/typescript-sdk/client/base.ts @@ -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). diff --git a/open-api/typescript-sdk/client/common.ts b/open-api/typescript-sdk/client/common.ts index db34640578..ba40b6202a 100644 --- a/open-api/typescript-sdk/client/common.ts +++ b/open-api/typescript-sdk/client/common.ts @@ -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). diff --git a/open-api/typescript-sdk/client/configuration.ts b/open-api/typescript-sdk/client/configuration.ts index 9061ba1ed4..7e37412c4c 100644 --- a/open-api/typescript-sdk/client/configuration.ts +++ b/open-api/typescript-sdk/client/configuration.ts @@ -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). diff --git a/open-api/typescript-sdk/client/index.ts b/open-api/typescript-sdk/client/index.ts index c6ccd43fcd..3fd4a3b635 100644 --- a/open-api/typescript-sdk/client/index.ts +++ b/open-api/typescript-sdk/client/index.ts @@ -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).