feat(indexer): add openapi schema and ui (#35)

Azure-Samples · Sep 15, 2023 · 05a5bc4 · 05a5bc4
1 parent 83857e1
commit 05a5bc4
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 64 deletions.
diff --git a/packages/indexer/src/plugins/multipart.ts b/packages/indexer/src/plugins/multipart.ts
@@ -6,7 +6,7 @@ const FILE_UPLOAD_LIMIT = 20 * 1024 * 1024; // 20 MB
 export default fp(async (fastify) => {
   fastify.register(multipart, {
     attachFieldsToBody: true,
-    sharedSchemaId: '#multipartField',
+    sharedSchemaId: 'multipartField',
     limits: {
       fileSize: FILE_UPLOAD_LIMIT,
       files: 1,

diff --git a/packages/indexer/src/plugins/schemas.ts b/packages/indexer/src/plugins/schemas.ts
diff --git a/packages/indexer/src/routes/indexes/index.ts b/packages/indexer/src/routes/indexes/index.ts
@@ -10,6 +10,8 @@ export interface IndexFileOptionsField {
 const root: FastifyPluginAsyncJsonSchemaToTs = async (fastify, _options): Promise<void> => {
   fastify.post('/', {
     schema: {
+      description: 'Create a new search index',
+      tags: ['indexes'],
       body: {
         type: 'object',
         properties: {
@@ -43,6 +45,8 @@ const root: FastifyPluginAsyncJsonSchemaToTs = async (fastify, _options): Promis
 
   fastify.delete('/:name', {
     schema: {
+      description: 'Delete a search index',
+      tags: ['indexes'],
       params: {
         type: 'object',
         properties: {
@@ -75,7 +79,9 @@ const root: FastifyPluginAsyncJsonSchemaToTs = async (fastify, _options): Promis
 
   fastify.post('/:name/files', {
     schema: {
-      // consumes: ['multipart/form-data'],
+      description: 'Upload a file for indexing',
+      tags: ['indexes'],
+      consumes: ['multipart/form-data'],
       params: {
         type: 'object',
         properties: {
@@ -88,8 +94,9 @@ const root: FastifyPluginAsyncJsonSchemaToTs = async (fastify, _options): Promis
       body: {
         type: 'object',
         properties: {
-          options: { $ref: '#multipartField' },
-          file: { $ref: '#multipartField' },
+          options: { $ref: 'multipartField' },
+          // TODO: missing proper file type from ajv plugin
+          file: { $ref: 'multipartField' },
         },
         required: ['file'],
       },
@@ -150,6 +157,8 @@ const root: FastifyPluginAsyncJsonSchemaToTs = async (fastify, _options): Promis
 
   fastify.delete('/:name/files/:filename', {
     schema: {
+      description: 'Delete a file from the index',
+      tags: ['indexes'],
       params: {
         type: 'object',
         properties: {