docs: improve documentation of recent envelopes

envelope-zero · Aug 3, 2024 · ebdc556 · ebdc556
1 parent 36cb311
commit ebdc556
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/pkg/controllers/v4/account.go b/pkg/controllers/v4/account.go
@@ -248,6 +248,11 @@ func GetAccount(c *gin.Context) {
 // @Failure		500	{object}	RecentEnvelopesResponse
 // @Param			id	path		string	true	"ID formatted as string"
 // @Router			/v4/accounts/{id}/recent-envelopes [get]
+//
+// GetAccountRecentEnvelopes returns recent envelopes for an account.
+//
+// Income is returned as a RecentEnvelope with the nil ID.
+// Clients must be able to handle this.
 func GetAccountRecentEnvelopes(c *gin.Context) {
 	id, err := httputil.UUIDFromString(c.Param("id"))
 	if err != nil {