3148 add swaggo for swagger directory for rest #3177
Conversation
| //// @securityDefinitions.basic BasicAuth | ||
|
|
||
| //// @securityDefinitions.apikey ApiKeyAuth | ||
| //// @in header | ||
| //// @name Authorization | ||
| //// @description Description for what is this security definition being used | ||
|
|
||
| // -- Add authentication to swagger here | ||
| //// @securitydefinitions.oauth2.application OAuth2Application | ||
| //// @tokenUrl https://example.com/oauth/token | ||
| //// @scope.write Grants write access | ||
| //// @scope.admin Grants read and write access to administrative information | ||
| // | ||
| //// @securitydefinitions.oauth2.implicit OAuth2Implicit | ||
| //// @authorizationUrl https://example.com/oauth/authorize | ||
| //// @scope.write Grants write access | ||
| //// @scope.admin Grants read and write access to administrative information | ||
| // | ||
| //// @securitydefinitions.oauth2.password OAuth2Password | ||
| //// @tokenUrl https://example.com/oauth/token | ||
| //// @scope.read Grants read access | ||
| //// @scope.write Grants write access | ||
| //// @scope.admin Grants read and write access to administrative information | ||
| // | ||
| //// @securitydefinitions.oauth2.accessCode OAuth2AccessCode | ||
| //// @tokenUrl https://example.com/oauth/token | ||
| //// @authorizationUrl https://example.com/oauth/authorize | ||
| //// @scope.admin Grants read and write access to administrative information | ||
|
|
There was a problem hiding this comment.
Not correct for us – we don't implement authorization using OAuth2 at the moment, and these are example URLs
There was a problem hiding this comment.
This is all commented out, fyi
| // NodeInfo godoc | ||
| // | ||
| // @ID NodeInfo | ||
| // @Summary Information about the node. | ||
| // @Description Information about the node. | ||
| // @Tags Ops | ||
| // @Produce json | ||
| // @Success 200 {object} NodeInfo | ||
| // @Failure 500 {object} string | ||
| // @Router /api/v1/agent/node [get] |
There was a problem hiding this comment.
Swagger comments should be added on the actual method which serves the request, rather than the data structure, no?
There was a problem hiding this comment.
Swagger needs the godoc but you're right (I think) no router here
| // @Success 200 {object} []peer.AddrInfo | ||
| // @Success 200 {object} []string |
There was a problem hiding this comment.
peer.AddrInfo is not a string.
There was a problem hiding this comment.
This is a mechanism to flatten a complex structure into a string - swaggo does this automatically. If we'd like to do this more thoroughly, we can, but I get it was overkill
|
Replaced with this stack of PRs - #3224 |
No description provided.