mirror of
https://github.com/go-gitea/gitea.git
synced 2026-08-15 16:26:14 +00:00
docs(api): document 401/403 responses for user key endpoints (#38711)
This commit is contained in:
+69
@@ -1711,6 +1711,21 @@
|
||||
},
|
||||
"description": "APIString is a string response"
|
||||
},
|
||||
"unauthorized": {
|
||||
"description": "APIUnauthorizedError is an unauthorized error response",
|
||||
"headers": {
|
||||
"message": {
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"url": {
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"validationError": {
|
||||
"description": "APIValidationError is error format response related to input validation",
|
||||
"headers": {
|
||||
@@ -34970,6 +34985,12 @@
|
||||
"200": {
|
||||
"$ref": "#/components/responses/string"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/components/responses/notFound"
|
||||
}
|
||||
@@ -34987,6 +35008,12 @@
|
||||
"201": {
|
||||
"$ref": "#/components/responses/GPGKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/components/responses/notFound"
|
||||
},
|
||||
@@ -35024,6 +35051,12 @@
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/components/responses/GPGKeyList"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
}
|
||||
},
|
||||
"summary": "List the authenticated user's GPG keys",
|
||||
@@ -35047,6 +35080,12 @@
|
||||
"201": {
|
||||
"$ref": "#/components/responses/GPGKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/components/responses/notFound"
|
||||
},
|
||||
@@ -35079,6 +35118,9 @@
|
||||
"204": {
|
||||
"$ref": "#/components/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
@@ -35109,6 +35151,12 @@
|
||||
"200": {
|
||||
"$ref": "#/components/responses/GPGKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/components/responses/notFound"
|
||||
}
|
||||
@@ -35290,6 +35338,12 @@
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/components/responses/PublicKeyList"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
}
|
||||
},
|
||||
"summary": "List the authenticated user's public keys",
|
||||
@@ -35313,6 +35367,12 @@
|
||||
"201": {
|
||||
"$ref": "#/components/responses/PublicKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
"422": {
|
||||
"$ref": "#/components/responses/validationError"
|
||||
}
|
||||
@@ -35342,6 +35402,9 @@
|
||||
"204": {
|
||||
"$ref": "#/components/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
@@ -35372,6 +35435,12 @@
|
||||
"200": {
|
||||
"$ref": "#/components/responses/PublicKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/components/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/components/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/components/responses/notFound"
|
||||
}
|
||||
|
||||
+65
@@ -22325,6 +22325,12 @@
|
||||
"200": {
|
||||
"$ref": "#/responses/string"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
}
|
||||
@@ -22348,6 +22354,12 @@
|
||||
"201": {
|
||||
"$ref": "#/responses/GPGKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
@@ -22384,6 +22396,12 @@
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/GPGKeyList"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -22412,6 +22430,12 @@
|
||||
"201": {
|
||||
"$ref": "#/responses/GPGKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
@@ -22445,6 +22469,12 @@
|
||||
"200": {
|
||||
"$ref": "#/responses/GPGKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
}
|
||||
@@ -22473,6 +22503,9 @@
|
||||
"204": {
|
||||
"$ref": "#/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
@@ -22661,6 +22694,12 @@
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/PublicKeyList"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -22689,6 +22728,12 @@
|
||||
"201": {
|
||||
"$ref": "#/responses/PublicKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"422": {
|
||||
"$ref": "#/responses/validationError"
|
||||
}
|
||||
@@ -22719,6 +22764,12 @@
|
||||
"200": {
|
||||
"$ref": "#/responses/PublicKey"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
}
|
||||
@@ -22747,6 +22798,9 @@
|
||||
"204": {
|
||||
"$ref": "#/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
@@ -34949,6 +35003,17 @@
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"unauthorized": {
|
||||
"description": "APIUnauthorizedError is an unauthorized error response",
|
||||
"headers": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"validationError": {
|
||||
"description": "APIValidationError is error format response related to input validation",
|
||||
"headers": {
|
||||
|
||||
Reference in New Issue
Block a user