summaryrefslogtreecommitdiffstats
path: root/templates/swagger
diff options
context:
space:
mode:
authorJakobDev <jakobdev@gmx.de>2023-04-26 08:08:28 +0200
committerGitHub <noreply@github.com>2023-04-26 02:08:28 -0400
commitfb37eefa282543fd8ce63c361cd4cf0dfac9943c (patch)
tree2a88297945f49000dc7c0340c75ae74efa0e4816 /templates/swagger
parent4d5c803f8b71ccf3182d89584196783e2338e365 (diff)
downloadgitea-fb37eefa282543fd8ce63c361cd4cf0dfac9943c.tar.gz
gitea-fb37eefa282543fd8ce63c361cd4cf0dfac9943c.zip
Add API for License templates (#23009)
This adds a API for getting License templates. This tries to be as close to the [GitHub API](https://docs.github.com/en/rest/licenses?apiVersion=2022-11-28) as possible, but Gitea does not support all features that GitHub has. I think they should been added, but this out f the scope of this PR. You should merge #23006 before this PR for security reasons.
Diffstat (limited to 'templates/swagger')
-rw-r--r--templates/swagger/v1_json.tmpl107
1 files changed, 107 insertions, 0 deletions
diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl
index e3f87d703e..bc403be446 100644
--- a/templates/swagger/v1_json.tmpl
+++ b/templates/swagger/v1_json.tmpl
@@ -883,6 +883,52 @@
}
}
},
+ "/licenses": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "miscellaneous"
+ ],
+ "summary": "Returns a list of all license templates",
+ "operationId": "listLicenseTemplates",
+ "responses": {
+ "200": {
+ "$ref": "#/responses/LicenseTemplateList"
+ }
+ }
+ }
+ },
+ "/licenses/{name}": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "miscellaneous"
+ ],
+ "summary": "Returns information about a license template",
+ "operationId": "getLicenseTemplateInfo",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "name of the license",
+ "name": "name",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/LicenseTemplateInfo"
+ },
+ "404": {
+ "$ref": "#/responses/notFound"
+ }
+ }
+ }
+ },
"/markdown": {
"post": {
"consumes": [
@@ -18704,6 +18750,52 @@
},
"x-go-package": "code.gitea.io/gitea/modules/structs"
},
+ "LicenseTemplateInfo": {
+ "description": "LicensesInfo contains information about a License",
+ "type": "object",
+ "properties": {
+ "body": {
+ "type": "string",
+ "x-go-name": "Body"
+ },
+ "implementation": {
+ "type": "string",
+ "x-go-name": "Implementation"
+ },
+ "key": {
+ "type": "string",
+ "x-go-name": "Key"
+ },
+ "name": {
+ "type": "string",
+ "x-go-name": "Name"
+ },
+ "url": {
+ "type": "string",
+ "x-go-name": "URL"
+ }
+ },
+ "x-go-package": "code.gitea.io/gitea/modules/structs"
+ },
+ "LicensesTemplateListEntry": {
+ "description": "LicensesListEntry is used for the API",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "x-go-name": "Key"
+ },
+ "name": {
+ "type": "string",
+ "x-go-name": "Name"
+ },
+ "url": {
+ "type": "string",
+ "x-go-name": "URL"
+ }
+ },
+ "x-go-package": "code.gitea.io/gitea/modules/structs"
+ },
"MarkdownOption": {
"description": "MarkdownOption markdown options",
"type": "object",
@@ -21587,6 +21679,21 @@
}
}
},
+ "LicenseTemplateInfo": {
+ "description": "LicenseTemplateInfo",
+ "schema": {
+ "$ref": "#/definitions/LicenseTemplateInfo"
+ }
+ },
+ "LicenseTemplateList": {
+ "description": "LicenseTemplateList",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LicensesTemplateListEntry"
+ }
+ }
+ },
"MarkdownRender": {
"description": "MarkdownRender is a rendered markdown document",
"schema": {