added documentation for update repository info

gojekfarm · Apr 16, 2021 · 72a5d70 · 72a5d70
1 parent d5ece1f
commit 72a5d70
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/api/repository/add.go b/api/repository/add.go
@@ -47,11 +47,11 @@ type AddOkResponse struct {
 
 const NAME string = "repository-name"
 
-// AddHandler handles an repo add request
+// AddHandler handles a repo add/update request
 // swagger:operation PUT /repository/{repository_name} repository addOperation
 //
-// Add a chart repository to the server
-//
+// Add/Update a chart repository to the server.
+// The endpoint is idempotent and a repository can be updated by using the force_update parameter to true
 // ---
 // produces:
 // - application/json

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -88,7 +88,7 @@
     },
     "/repository/{repository_name}": {
       "put": {
-        "description": "Add a chart repository to the server",
+        "description": "The endpoint is idempotent and a repository can be updated by using the force_update parameter to true",
         "produces": [
           "application/json"
         ],
@@ -98,6 +98,7 @@
         "tags": [
           "repository"
         ],
+        "summary": "Add/Update a chart repository to the server.",
         "operationId": "addOperation",
         "parameters": [
           {