helpy4/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich synced 2025-11-14 17:36:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

test: sync open api spec (#9687)

Browse source 
test: sync spec file
This commit is contained in:
Jason Rasmussen 2024-05-23 07:40:57 -04:00 • committed by GitHub
parent a5e8b451b2
commit e7aa50425c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 45 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

23
server/src/bin/sync-open-api.ts Normal file
View file

@ -0,0 +1,23 @@
#!/usr/bin/env node
process.env.DB_URL = 'postgres://postgres:postgres@localhost:5432/immich';
import { NestFactory } from '@nestjs/core';
import { NestExpressApplication } from '@nestjs/platform-express';
import { ApiModule } from 'src/app.module';
import { useSwagger } from 'src/utils/misc';
const sync = async () => {
const app = await NestFactory.create<NestExpressApplication>(ApiModule, { preview: true });
useSwagger(app, true);
await app.close();
};
sync()
.then(() => {
console.log('Done');
process.exit(0);
})
.catch((error) => {
console.error(error);
console.log('Something went wrong');
process.exit(1);
});

0
server/src/utils/sql.ts → server/src/bin/sync-sql.ts
View file

4
server/src/utils/misc.ts
View file

@ -174,7 +174,7 @@ const patchOpenAPI = (document: OpenAPIObject) => {
return document;
};
export const useSwagger = (app: INestApplication) => {
export const useSwagger = (app: INestApplication, force = false) => {
const config = new DocumentBuilder()
.setTitle('Immich')
.setDescription('Immich API')
@ -211,7 +211,7 @@ export const useSwagger = (app: INestApplication) => {
SwaggerModule.setup('doc', app, specification, customOptions);
if (isDev()) {
if (isDev() || force) {
// Generate API Documentation only in development mode
const outputPath = path.resolve(process.cwd(), '../open-api/immich-openapi-specs.json');
writeFileSync(outputPath, JSON.stringify(patchOpenAPI(specification), null, 2), { encoding: 'utf8' });