feat: Auth docs

packages/api-gateway/src/models/auth.ts

@@ -0,0 +1,29 @@
+import { ApiProperty } from "@nestjs/swagger";
+import { IsNotEmpty } from "class-validator";
+import { ApiKeyProto, IdentifierProto} from 'juno-proto';
+
+export class IssueApiKeyRequest {
+  @ApiProperty({ description: 'Issuing user email' })
+  @IsNotEmpty()
+  email: string;
+  @ApiProperty({ description: 'Issuing user password' })
+  @IsNotEmpty()
+  password:  string;
+  @ApiProperty({ description: 'Optional description for key' })
+  description?:  string | undefined;
+  @ApiProperty({ description: 'Environemnt this key should be tied to' })
+  @IsNotEmpty()
+  environment:  string;
+
+  @IsNotEmpty()
+  project: IdentifierProto.ProjectIdentifier;
+}
+
+export class IssueApiKeyResponse {
+  @ApiProperty({ type: 'boolean' })
+  apiKey: ApiKeyProto.ApiKey;
+
+  constructor(res: ApiKeyProto.IssueApiKeyResponse) {
+    this.apiKey = res.apiKey;
+  }
+}

packages/api-gateway/src/modules/auth/auth.controller.ts

@@ -7,12 +7,14 @@ import {
   Post,
 } from '@nestjs/common';
 import { ClientGrpc } from '@nestjs/microservices';
+import { ApiBearerAuth, ApiOperation, ApiCreatedResponse} from '@nestjs/swagger';
 import { ApiKeyProto, JwtProto } from 'juno-proto';
 import {
   ApiKeyServiceClient,
-  IssueApiKeyRequest,
 } from 'juno-proto/dist/gen/api_key';
 import { JwtServiceClient } from 'juno-proto/dist/gen/jwt';
+import { lastValueFrom } from 'rxjs';
+import { IssueApiKeyRequest, IssueApiKeyResponse } from 'src/models/auth';
 
 const { JWT_SERVICE_NAME } = JwtProto;
 const { API_KEY_SERVICE_NAME } = ApiKeyProto;
@@ -35,14 +37,30 @@ export class AuthController implements OnModuleInit {
   }
 
   @Get()
+  @ApiBearerAuth()
   getJWT() {
     console.log('CALLED');
     // this.apiKeyService.issueApiKey({}).subscribe();
     return 'test';
   }
 
+  @ApiOperation({
+    description: 'Thie endpoint issues a new API key for the project tied to the specified environment.'
+  })
+  @ApiCreatedResponse({
+    description: 'The API Key has been successfully created',
+    type: IssueApiKeyResponse,
+  })
   @Post('/key')
-  createApiKey(@Body() issueApiKeyRequest: IssueApiKeyRequest) {
-    this.apiKeyService.issueApiKey(issueApiKeyRequest).subscribe();
+  async createApiKey(@Body() issueApiKeyRequest: IssueApiKeyRequest) {
+    const obs = this.apiKeyService.issueApiKey({
+      email: issueApiKeyRequest.email,
+      password: issueApiKeyRequest.password,
+      description: issueApiKeyRequest.description,
+      environment: issueApiKeyRequest.environment,
+      project: issueApiKeyRequest.project
+    });
+
+    return new IssueApiKeyResponse(await lastValueFrom(obs));
   }
 }