Changed HTTP Post Index

sourcenetwork · Nov 22, 2024 · 02c5c50 · 02c5c50
1 parent a61dcd7
commit 02c5c50
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 2 deletions.
diff --git a/client/index.go b/client/index.go
@@ -36,6 +36,18 @@ type IndexDescription struct {
 	Unique bool
 }
 
+// IndexCreateRequestDescription describes an index creation request.
+// It does not contain the ID, as it is not a valid field for the request body.
+// Instead it should be automatically generated.
+type IndexCreateRequestDescription struct {
+	// Name contains the name of the index.
+	Name string
+	// Fields contains the fields that are being indexed.
+	Fields []IndexedFieldDescription
+	// Unique indicates whether the index is unique.
+	Unique bool
+}
+
 // CollectionIndex is an interface for indexing documents in a collection.
 type CollectionIndex interface {
 	// Save indexes a document by storing indexed field values.

diff --git a/docs/website/references/http/openapi.json b/docs/website/references/http/openapi.json
@@ -442,6 +442,31 @@
                 },
                 "type": "object"
             },
+            "index_create_request": {
+                "properties": {
+                    "Fields": {
+                        "items": {
+                            "properties": {
+                                "Descending": {
+                                    "type": "boolean"
+                                },
+                                "Name": {
+                                    "type": "string"
+                                }
+                            },
+                            "type": "object"
+                        },
+                        "type": "array"
+                    },
+                    "Name": {
+                        "type": "string"
+                    },
+                    "Unique": {
+                        "type": "boolean"
+                    }
+                },
+                "type": "object"
+            },
             "lens_config": {
                 "properties": {
                     "DestinationSchemaVersionID": {
@@ -1245,7 +1270,7 @@
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/index"
+                                "$ref": "#/components/schemas/index_create_request"
                             }
                         }
                     },

diff --git a/http/handler_collection.go b/http/handler_collection.go
@@ -318,6 +318,9 @@ func (h *collectionHandler) bindRoutes(router *Router) {
 	indexSchema := &openapi3.SchemaRef{
 		Ref: "#/components/schemas/index",
 	}
+	indexCreateRequestSchema := &openapi3.SchemaRef{
+		Ref: "#/components/schemas/index_create_request",
+	}
 
 	collectionNamePathParam := openapi3.NewPathParameter("name").
 		WithDescription("Collection name").
@@ -389,7 +392,7 @@ func (h *collectionHandler) bindRoutes(router *Router) {
 
 	createIndexRequest := openapi3.NewRequestBody().
 		WithRequired(true).
-		WithContent(openapi3.NewContentWithJSONSchemaRef(indexSchema))
+		WithContent(openapi3.NewContentWithJSONSchemaRef(indexCreateRequestSchema))
 	createIndexResponse := openapi3.NewResponse().
 		WithDescription("Index description").
 		WithJSONSchemaRef(indexSchema)

diff --git a/http/openapi.go b/http/openapi.go
@@ -32,6 +32,7 @@ var openApiSchemas = map[string]any{
 	"schema":                          &client.SchemaDescription{},
 	"collection_definition":           &client.CollectionDefinition{},
 	"index":                           &client.IndexDescription{},
+	"index_create_request":            &client.IndexCreateRequestDescription{},
 	"delete_result":                   &client.DeleteResult{},
 	"update_result":                   &client.UpdateResult{},
 	"lens_config":                     &client.LensConfig{},