mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-15 07:34:42 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

feat(apidocs): use real version number

Browse source 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
This commit is contained in:
Erik Michelson 2023-01-09 00:25:42 +01:00 • committed by David Mehren
parent 8ee2d809c7
commit d52fc55ef3
3 changed files with 16 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

15
backend/src/utils/swagger.ts
View file

@ -8,12 +8,13 @@ import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
import { PrivateApiModule } from '../api/private/private-api.module';
import { PublicApiModule } from '../api/public/public-api.module';
import { getServerVersionFromPackageJson } from './serverVersion';
export function setupPublicApiDocs(app: INestApplication): void {
export async function setupPublicApiDocs(app: INestApplication): Promise<void> {
const version = await getServerVersionFromPackageJson();
const publicApiOptions = new DocumentBuilder()
.setTitle('HedgeDoc Public API')
// TODO: Use real version
.setVersion('2.0-dev')
.setVersion(version.fullString)
.addSecurity('token', {
type: 'http',
scheme: 'bearer',
@ -25,11 +26,13 @@ export function setupPublicApiDocs(app: INestApplication): void {
SwaggerModule.setup('apidoc', app, publicApi);
}
export function setupPrivateApiDocs(app: INestApplication): void {
export async function setupPrivateApiDocs(
app: INestApplication,
): Promise<void> {
const version = await getServerVersionFromPackageJson();
const privateApiOptions = new DocumentBuilder()
.setTitle('HedgeDoc Private API')
// TODO: Use real version
.setVersion('2.0-dev')
.setVersion(version.fullString)
.build();
const privateApi = SwaggerModule.createDocument(app, privateApiOptions, {