private/apigen/example: Add description to endpoint

Add the description field to the endpoint to show where it ends up when generating code. Change-Id: I415f088dbf795656ed1ef042ed41ebf39a517692
storj · Sep 19, 2023 · 926076b · 926076b
1 parent e599df0
commit 926076b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/private/apigen/example/apidocs.gen.md b/private/apigen/example/apidocs.gen.md
@@ -11,7 +11,7 @@
 
 <h3 id='documents-update-content'>Update Content (<a href='#list-of-endpoints'>go to full list</a>)</h3>
 
-
+Update the content of the document with the specified path and ID if the last update is before the indicated date
 
 `POST /api/v0/docs/{path}`
 

diff --git a/private/apigen/example/gen.go b/private/apigen/example/gen.go
@@ -19,8 +19,9 @@ func main() {
 	g := a.Group("Documents", "docs")
 
 	g.Post("/{path}", &apigen.Endpoint{
-		Name:       "Update Content",
-		MethodName: "UpdateContent",
+		Name:        "Update Content",
+		Description: "Update the content of the document with the specified path and ID if the last update is before the indicated date",
+		MethodName:  "UpdateContent",
 		Response: struct {
 			ID        uuid.UUID `json:"id"`
 			Date      time.Time `json:"date"`