branding: update API descriptions (#7244)
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7244 Reviewed-by: Gusted <gusted@noreply.codeberg.org> Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: 0ko <0ko@noreply.codeberg.org> Co-committed-by: 0ko <0ko@noreply.codeberg.org>
This commit is contained in:
parent
1132fde45f
commit
ae8dca8423
4 changed files with 7 additions and 7 deletions
|
@ -27,7 +27,7 @@ type User struct {
|
|||
Email string `json:"email"`
|
||||
// URL to the user's avatar
|
||||
AvatarURL string `json:"avatar_url"`
|
||||
// URL to the user's gitea page
|
||||
// URL to the user's profile page
|
||||
HTMLURL string `json:"html_url"`
|
||||
// User locale
|
||||
Language string `json:"language"`
|
||||
|
|
|
@ -16,11 +16,11 @@ import (
|
|||
|
||||
const cacheKeyNodeInfoUsage = "API_NodeInfoUsage"
|
||||
|
||||
// NodeInfo returns the NodeInfo for the Gitea instance to allow for federation
|
||||
// NodeInfo returns the NodeInfo for the Forgejo instance to allow for federation
|
||||
func NodeInfo(ctx *context.APIContext) {
|
||||
// swagger:operation GET /nodeinfo miscellaneous getNodeInfo
|
||||
// ---
|
||||
// summary: Returns the nodeinfo of the Gitea application
|
||||
// summary: Returns the nodeinfo of the Forgejo application
|
||||
// produces:
|
||||
// - application/json
|
||||
// responses:
|
||||
|
|
|
@ -15,7 +15,7 @@ import (
|
|||
func Version(ctx *context.APIContext) {
|
||||
// swagger:operation GET /version miscellaneous getVersion
|
||||
// ---
|
||||
// summary: Returns the version of the Gitea application
|
||||
// summary: Returns the version of the running application
|
||||
// produces:
|
||||
// - application/json
|
||||
// responses:
|
||||
|
|
6
templates/swagger/v1_json.tmpl
generated
6
templates/swagger/v1_json.tmpl
generated
|
@ -1877,7 +1877,7 @@
|
|||
"tags": [
|
||||
"miscellaneous"
|
||||
],
|
||||
"summary": "Returns the nodeinfo of the Gitea application",
|
||||
"summary": "Returns the nodeinfo of the Forgejo application",
|
||||
"operationId": "getNodeInfo",
|
||||
"responses": {
|
||||
"200": {
|
||||
|
@ -20530,7 +20530,7 @@
|
|||
"tags": [
|
||||
"miscellaneous"
|
||||
],
|
||||
"summary": "Returns the version of the Gitea application",
|
||||
"summary": "Returns the version of the running application",
|
||||
"operationId": "getVersion",
|
||||
"responses": {
|
||||
"200": {
|
||||
|
@ -27943,7 +27943,7 @@
|
|||
"x-go-name": "FullName"
|
||||
},
|
||||
"html_url": {
|
||||
"description": "URL to the user's gitea page",
|
||||
"description": "URL to the user's profile page",
|
||||
"type": "string",
|
||||
"x-go-name": "HTMLURL"
|
||||
},
|
||||
|
|
Loading…
Add table
Reference in a new issue