mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-09-27 14:10:24 +00:00
Run make generate-swagger
This commit is contained in:
parent
9309ce5612
commit
c057e5c87b
1 changed files with 661 additions and 1 deletions
662
templates/swagger/v1_json.tmpl
generated
662
templates/swagger/v1_json.tmpl
generated
|
@ -15278,6 +15278,42 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/starlist/{id}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get a star list by id",
|
||||
"operationId": "userGetStarListByID",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"description": "id of the star list to get",
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarList"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/teams/{id}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
|
@ -17144,6 +17180,384 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/user/starlist/{name}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get the star list of the authenticated user with the given name",
|
||||
"operationId": "userGetOwnStarListByName",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarList"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Deletes a star list",
|
||||
"operationId": "userDeleteStarList",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"$ref": "#/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
},
|
||||
"patch": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Edits a star list",
|
||||
"operationId": "userEditStarList",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CreateEditStarListOptions"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarList"
|
||||
},
|
||||
"400": {
|
||||
"$ref": "#/responses/error"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/starlist/{name}/repos": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get the repos of the star list of the authenticated user with the given name",
|
||||
"operationId": "userGetOwnStarListRepos",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "page number of results to return (1-based)",
|
||||
"name": "page",
|
||||
"in": "query"
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "page size of results",
|
||||
"name": "limit",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/RepositoryList"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/starlist/{name}/{owner}/{repo}": {
|
||||
"put": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Adds a Repo to a Star List",
|
||||
"operationId": "userAddRepoToStarList",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "owner of the repo to star",
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the repo to star",
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"$ref": "#/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Removes a Repo from a Star List",
|
||||
"operationId": "userRemoveRepoFromStarList",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "owner of the repo to star",
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the repo to star",
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"$ref": "#/responses/empty"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/starlists": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "List the authenticated user's star lists",
|
||||
"operationId": "userGetOwnStarLists",
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarListSlice"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Creates a star list",
|
||||
"operationId": "userCreateStarList",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "body",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/CreateEditStarListOptions"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"201": {
|
||||
"$ref": "#/responses/StarList"
|
||||
},
|
||||
"400": {
|
||||
"$ref": "#/responses/error"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/starlists/repoinfo/{owner}/{repo}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Gets all star lists of the user together with the information, if the given repo is in the list",
|
||||
"operationId": "userGetStarListRepoInfo",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "owner of the repo to star",
|
||||
"name": "owner",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the repo to star",
|
||||
"name": "repo",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarListRepoInfo"
|
||||
},
|
||||
"401": {
|
||||
"$ref": "#/responses/unauthorized"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/user/starred": {
|
||||
"get": {
|
||||
"produces": [
|
||||
|
@ -17937,6 +18351,137 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"/users/{username}/starlist/{name}": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get the star list of the given user with the given name",
|
||||
"operationId": "userGetUserStarListByName",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "username of user",
|
||||
"name": "username",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarList"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/{username}/starlist/{name}/repos": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get the repos of the star list of the given user with the given name",
|
||||
"operationId": "userGetUserStarListRepos",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "username of user",
|
||||
"name": "username",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"description": "name of the star list",
|
||||
"name": "name",
|
||||
"in": "path",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "page number of results to return (1-based)",
|
||||
"name": "page",
|
||||
"in": "query"
|
||||
},
|
||||
{
|
||||
"type": "integer",
|
||||
"description": "page size of results",
|
||||
"name": "limit",
|
||||
"in": "query"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/RepositoryList"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/{username}/starlists": {
|
||||
"get": {
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "List the given user's star lists",
|
||||
"operationId": "userGetUserStarLists",
|
||||
"parameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"description": "username of user",
|
||||
"name": "username",
|
||||
"in": "path",
|
||||
"required": true
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"$ref": "#/responses/StarListSlice"
|
||||
},
|
||||
"403": {
|
||||
"$ref": "#/responses/forbidden"
|
||||
},
|
||||
"404": {
|
||||
"$ref": "#/responses/notFound"
|
||||
},
|
||||
"501": {
|
||||
"$ref": "#/responses/featureDisabled"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/{username}/starred": {
|
||||
"get": {
|
||||
"produces": [
|
||||
|
@ -19332,6 +19877,25 @@
|
|||
},
|
||||
"x-go-package": "code.gitea.io/gitea/modules/structs"
|
||||
},
|
||||
"CreateEditStarListOptions": {
|
||||
"description": "CreateEditStarListOptions when creating or editing a star list",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"description": {
|
||||
"type": "string",
|
||||
"x-go-name": "Description"
|
||||
},
|
||||
"is_private": {
|
||||
"type": "boolean",
|
||||
"x-go-name": "IsPrivate"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"x-go-name": "Name"
|
||||
}
|
||||
},
|
||||
"x-go-package": "code.gitea.io/gitea/modules/structs"
|
||||
},
|
||||
"CreateEmailOption": {
|
||||
"description": "CreateEmailOption options when creating email addresses",
|
||||
"type": "object",
|
||||
|
@ -21486,6 +22050,10 @@
|
|||
"type": "boolean",
|
||||
"x-go-name": "MirrorsDisabled"
|
||||
},
|
||||
"star_lists_disabled": {
|
||||
"type": "boolean",
|
||||
"x-go-name": "StarListsDisabled"
|
||||
},
|
||||
"stars_disabled": {
|
||||
"type": "boolean",
|
||||
"x-go-name": "StarsDisabled"
|
||||
|
@ -24069,6 +24637,52 @@
|
|||
},
|
||||
"x-go-package": "code.gitea.io/gitea/modules/structs"
|
||||
},
|
||||
"StarList": {
|
||||
"description": "StarList represents a star list",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"description": {
|
||||
"type": "string",
|
||||
"x-go-name": "Description"
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"x-go-name": "ID"
|
||||
},
|
||||
"is_private": {
|
||||
"type": "boolean",
|
||||
"x-go-name": "IsPrivate"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"x-go-name": "Name"
|
||||
},
|
||||
"repository_count": {
|
||||
"type": "integer",
|
||||
"format": "int64",
|
||||
"x-go-name": "RepositoryCount"
|
||||
},
|
||||
"user": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
},
|
||||
"x-go-package": "code.gitea.io/gitea/modules/structs"
|
||||
},
|
||||
"StarListRepoInfo": {
|
||||
"description": "StarListRepoInfo represents a star list and if the repo contains this star list",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"contains": {
|
||||
"type": "boolean",
|
||||
"x-go-name": "Contains"
|
||||
},
|
||||
"star_list": {
|
||||
"$ref": "#/definitions/StarList"
|
||||
}
|
||||
},
|
||||
"x-go-package": "code.gitea.io/gitea/modules/structs"
|
||||
},
|
||||
"StateType": {
|
||||
"description": "StateType issue state type",
|
||||
"type": "string",
|
||||
|
@ -25746,6 +26360,30 @@
|
|||
"$ref": "#/definitions/ServerVersion"
|
||||
}
|
||||
},
|
||||
"StarList": {
|
||||
"description": "StarList",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/StarList"
|
||||
}
|
||||
},
|
||||
"StarListRepoInfo": {
|
||||
"description": "StarListRepoInfo",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/StarListRepoInfo"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StarListSlice": {
|
||||
"description": "StarListSlice",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/StarList"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StopWatch": {
|
||||
"description": "StopWatch",
|
||||
"schema": {
|
||||
|
@ -25925,6 +26563,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"featureDisabled": {
|
||||
"description": "APIFeatureDisabledError is a error that is retruned when the given feature is disabled",
|
||||
"headers": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"forbidden": {
|
||||
"description": "APIForbiddenError is a forbidden error response",
|
||||
"headers": {
|
||||
|
@ -25956,7 +26605,7 @@
|
|||
"parameterBodies": {
|
||||
"description": "parameterBodies",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/UpdateVariableOption"
|
||||
"$ref": "#/definitions/CreateEditStarListOptions"
|
||||
}
|
||||
},
|
||||
"redirect": {
|
||||
|
@ -25979,6 +26628,17 @@
|
|||
"type": "string"
|
||||
}
|
||||
},
|
||||
"unauthorized": {
|
||||
"description": "APIUnauthorizedError is a unauthorized error response",
|
||||
"headers": {
|
||||
"message": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"validationError": {
|
||||
"description": "APIValidationError is error format response related to input validation",
|
||||
"headers": {
|
||||
|
|
Loading…
Reference in a new issue