roman/gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2026-07-04 15:07:42 +00:00
Code Issues Releases Wiki Activity

chore: upgrade go-swagger to v0.35.0 and enforce zero swagger warnings (#38299)

Browse Source 
Updates `go-swagger` to v0.35.0 and makes swagger generation and
validation warning-free, with the build now failing on any warning
(`go-swagger` itself exits `0` on warnings).

- Generation passes `--enable-allof-compounding` (keeps `$ref` fields
bare, no spec change) and `--skip-enum-desc` (drops the enum description
that duplicates `x-go-enum-desc` and was the only source of `allOf`
noise in the OpenAPI 3.0 output).
- Fixed warnings at the source: dropped `swagger:strfmt` where it
conflicts with `required: true` (`required` kept, `time.Time` still maps
to `date-time`), fixed a malformed `units_map` example, moved the
`parameterBodies` injection hack to `swagger:parameters`, and removed
unused responses.

Fixes: https://github.com/go-gitea/gitea/issues/12508

---------

Co-authored-by: bircni <bircni@icloud.com>
This commit is contained in:
silverwind
2026-07-01 23:07:34 +02:00
committed by GitHub
parent a031454586
commit 638e4bce09
12 changed files with 187 additions and 499 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+9 -5
View File
@@ -16,7 +16,7 @@ EDITORCONFIG_CHECKER_PACKAGE ?= github.com/editorconfig-checker/editorconfig-che
GOLANGCI_LINT_PACKAGE ?= github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.12.2 # renovate: datasource=go
GXZ_PACKAGE ?= github.com/ulikunitz/xz/cmd/gxz@v0.5.15 # renovate: datasource=go
MISSPELL_PACKAGE ?= github.com/golangci/misspell/cmd/misspell@v0.8.0 # renovate: datasource=go
SWAGGER_PACKAGE ?= github.com/go-swagger/go-swagger/cmd/swagger@v0.34.1 # renovate: datasource=go
SWAGGER_PACKAGE ?= github.com/go-swagger/go-swagger/cmd/swagger@v0.35.0 # renovate: datasource=go
XGO_PACKAGE ?= src.techknowlogick.com/xgo@v1.9.0 # renovate: datasource=go
GOVULNCHECK_PACKAGE ?= golang.org/x/vuln/cmd/govulncheck@v1.4.0 # renovate: datasource=go
ACTIONLINT_PACKAGE ?= github.com/rhysd/actionlint/cmd/actionlint@v1.7.12 # renovate: datasource=go
@@ -231,7 +231,9 @@ endif
generate-swagger: $(SWAGGER_SPEC) $(OPENAPI3_SPEC) ## generate the swagger spec from code comments
$(SWAGGER_SPEC): $(GO_SOURCES) $(SWAGGER_SPEC_INPUT)
$(GO) run $(SWAGGER_PACKAGE) generate spec --exclude "$(SWAGGER_EXCLUDE)" --input "$(SWAGGER_SPEC_INPUT)" --output './$(SWAGGER_SPEC)'
@output="$$($(GO) run $(SWAGGER_PACKAGE) generate spec --enable-allof-compounding --skip-enum-desc --exclude "$(SWAGGER_EXCLUDE)" --input "$(SWAGGER_SPEC_INPUT)" --output './$(SWAGGER_SPEC)' 2>&1)" || { printf '%s\n' "$$output" >&2; exit 1; }; \
warnings="$$(printf '%s\n' "$$output" | grep -v '^go: ')"; \
if [ -n "$$warnings" ]; then printf '%s\n' "$$warnings" >&2; exit 1; fi
.PHONY: swagger-check
swagger-check: generate-swagger
@@ -246,9 +248,11 @@ swagger-check: generate-swagger
swagger-validate: ## check if the swagger spec is valid
@# swagger "validate" requires that the "basePath" must start with a slash, but we are using Golang template "{{...}}"
@$(SED_INPLACE) -E -e 's|"basePath":( *)"(.*)"|"basePath":\1"/\2"|g' './$(SWAGGER_SPEC)' # add a prefix slash to basePath
@# FIXME: there are some warnings
$(GO) run $(SWAGGER_PACKAGE) validate './$(SWAGGER_SPEC)'
@$(SED_INPLACE) -E -e 's|"basePath":( *)"/(.*)"|"basePath":\1"\2"|g' './$(SWAGGER_SPEC)' # remove the prefix slash from basePath
@output="$$($(GO) run $(SWAGGER_PACKAGE) validate './$(SWAGGER_SPEC)' 2>&1)"; status=$$?; \
$(SED_INPLACE) -E -e 's|"basePath":( *)"/(.*)"|"basePath":\1"\2"|g' './$(SWAGGER_SPEC)'; \
printf '%s\n' "$$output" | grep -v '^go: '; \
[ $$status -eq 0 ] || exit $$status; \
case "$$output" in *WARNING:*) exit 1;; esac
.PHONY: generate-openapi3
generate-openapi3: $(OPENAPI3_SPEC) ## generate the OpenAPI 3.0 spec from the Swagger 2.0 spec
modules/structs/admin_user.go
-1
View File
@@ -19,7 +19,6 @@ type CreateUserOption struct {
// The full display name of the user
FullName string `json:"full_name" binding:"MaxSize(100)"`
// required: true
// swagger:strfmt email
Email string `json:"email" binding:"Required;Email;MaxSize(254)"`
// The plain text password for the user
Password string `json:"password" binding:"MaxSize(255)"`
modules/structs/issue.go
-1
View File
@@ -133,7 +133,6 @@ type IssueAssigneesOption struct {
// EditDeadlineOption options for creating a deadline
type EditDeadlineOption struct {
// required:true
// swagger:strfmt date-time
Deadline *time.Time `json:"due_date"`
}
modules/structs/org_team.go
+2 -2
View File
@@ -54,10 +54,10 @@ type CreateTeamOption struct {
// Whether the team has access to all repositories in the organization
IncludesAllRepositories bool `json:"includes_all_repositories"`
Permission RepoWritePermission `json:"permission"`
// example: ["repo.actions","repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.ext_wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"]
// example: ["repo.actions","repo.packages","repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.projects","repo.ext_wiki"]
// Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.
Units []string `json:"units"`
// example: {"repo.actions","repo.packages","repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}
// example: {"repo.actions":"read","repo.packages":"read","repo.code":"read","repo.issues":"write","repo.ext_issues":"none","repo.wiki":"admin","repo.pulls":"owner","repo.releases":"none","repo.projects":"none","repo.ext_wiki":"none"}
UnitsMap map[string]string `json:"units_map"`
// Whether the team can create repositories in the organization
CanCreateOrgRepo bool `json:"can_create_org_repo"`
routers/api/v1/swagger/action.go
-7
View File
@@ -12,13 +12,6 @@ type swaggerResponseSecretList struct {
Body []api.Secret `json:"body"`
}
// Secret
// swagger:response Secret
type swaggerResponseSecret struct {
// in:body
Body api.Secret `json:"body"`
}
// ActionVariable
// swagger:response ActionVariable
type swaggerResponseActionVariable struct {
routers/api/v1/swagger/issue.go
-7
View File
@@ -98,13 +98,6 @@ type swaggerIssueTemplates struct {
Body []api.IssueTemplate `json:"body"`
}
// StopWatch
// swagger:response StopWatch
type swaggerResponseStopWatch struct {
// in:body
Body api.StopWatch `json:"body"`
}
// StopWatchList
// swagger:response StopWatchList
type swaggerResponseStopWatchList struct {
routers/api/v1/swagger/nodeinfo.go
-15
View File
@@ -1,15 +0,0 @@
// Copyright 2021 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package swagger
import (
api "gitea.dev/modules/structs"
)
// NodeInfo
// swagger:response NodeInfo
type swaggerResponseNodeInfo struct {
// in:body
Body api.NodeInfo `json:"body"`
}
routers/api/v1/swagger/options.go
+8 -4
View File
@@ -8,11 +8,12 @@ import (
"gitea.dev/services/forms"
)
// not actually a response, just a hack to get go-swagger to include definitions
// of the various XYZOption structs
// not actually a set of parameters, just a hack to get go-swagger to include
// definitions of the various XYZOption structs. The annotation below uses an
// operation id that matches no route, so the spec carries no unused response
// or parameter for it while still emitting the referenced definitions.
// parameterBodies
// swagger:response parameterBodies
// swagger:parameters parameterBodies
type swaggerParameterBodies struct {
// in:body
AddCollaboratorOption api.AddCollaboratorOption
@@ -235,4 +236,7 @@ type swaggerParameterBodies struct {
// in:body
LockIssueOption api.LockIssueOption
// in:body
MergeUpstreamRequest api.MergeUpstreamRequest
}
routers/api/v1/swagger/repo.go
-13
View File
@@ -84,13 +84,6 @@ type swaggerResponseTagProtection struct {
Body api.TagProtection `json:"body"`
}
// Reference
// swagger:response Reference
type swaggerResponseReference struct {
// in:body
Body api.Reference `json:"body"`
}
// ReferenceList
// swagger:response ReferenceList
type swaggerResponseReferenceList struct {
@@ -511,12 +504,6 @@ type swaggerCompare struct {
Body api.Compare `json:"body"`
}
// swagger:response MergeUpstreamRequest
type swaggerMergeUpstreamRequest struct {
// in:body
Body api.MergeUpstreamRequest `json:"body"`
}
// swagger:response MergeUpstreamResponse
type swaggerMergeUpstreamResponse struct {
// in:body
services/context/api.go
-4
View File
@@ -104,10 +104,6 @@ type APINotFound struct{}
// swagger:response conflict
type APIConflict struct{}
// APIRedirect is a redirect response
// swagger:response redirect
type APIRedirect struct{}
// APIString is a string response
// swagger:response string
type APIString string
templates/swagger/v1_json.tmpl
Generated
+80 -205
View File
@@ -22762,7 +22762,7 @@
"type": "object",
"properties": {
"permission": {
"description": "Permission level to grant the collaborator\nread RepoWritePermissionRead\nwrite RepoWritePermissionWrite\nadmin RepoWritePermissionAdmin",
"description": "Permission level to grant the collaborator",
"type": "string",
"enum": [
"read",
@@ -22917,6 +22917,7 @@
"x-go-name": "DownloadURL"
},
"created_at": {
"description": "Created is the time when the attachment was uploaded",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -23065,8 +23066,8 @@
"x-go-name": "BlockOnRejectedReviews"
},
"branch_name": {
"description": "Deprecated: true",
"type": "string",
"x-deprecated": true,
"x-go-name": "BranchName"
},
"bypass_allowlist_teams": {
@@ -23389,7 +23390,7 @@
"x-go-name": "SHA"
},
"state": {
"description": "State is the overall combined status state\npending CommitStatusPending is for when the CommitStatus is Pending\nsuccess CommitStatusSuccess is for when the CommitStatus is Success\nerror CommitStatusError is for when the CommitStatus is Error\nfailure CommitStatusFailure is for when the CommitStatus is Failure\nwarning CommitStatusWarning is for when the CommitStatus is Warning\nskipped CommitStatusSkipped is for when CommitStatus is Skipped",
"description": "State is the overall combined status state",
"type": "string",
"enum": [
"pending",
@@ -23503,6 +23504,7 @@
"$ref": "#/definitions/User"
},
"created": {
"description": "Created is the time when the commit was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -23566,11 +23568,13 @@
"type": "object",
"properties": {
"author": {
"description": "Author is the author date for the commit",
"type": "string",
"format": "date-time",
"x-go-name": "Author"
},
"committer": {
"description": "Committer is the committer date for the commit",
"type": "string",
"format": "date-time",
"x-go-name": "Committer"
@@ -23583,6 +23587,7 @@
"title": "CommitMeta contains meta information of a commit in terms of API.",
"properties": {
"created": {
"description": "Created is the time when the commit was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -23654,7 +23659,7 @@
"x-go-name": "ID"
},
"status": {
"description": "State represents the status state (pending, success, error, failure)\npending CommitStatusPending is for when the CommitStatus is Pending\nsuccess CommitStatusSuccess is for when the CommitStatus is Success\nerror CommitStatusError is for when the CommitStatus is Error\nfailure CommitStatusFailure is for when the CommitStatus is Failure\nwarning CommitStatusWarning is for when the CommitStatus is Warning\nskipped CommitStatusSkipped is for when CommitStatus is Skipped",
"description": "State represents the status state (pending, success, error, failure)",
"type": "string",
"enum": [
"pending",
@@ -23695,6 +23700,7 @@
"x-go-name": "Date"
},
"email": {
"description": "Email is the person's email address",
"type": "string",
"format": "email",
"x-go-name": "Email"
@@ -23939,8 +23945,8 @@
"x-go-name": "BlockOnRejectedReviews"
},
"branch_name": {
"description": "Deprecated: true",
"type": "string",
"x-deprecated": true,
"x-go-name": "BranchName"
},
"bypass_allowlist_teams": {
@@ -24097,9 +24103,10 @@
"x-go-name": "BranchName"
},
"old_branch_name": {
"description": "Deprecated: true\nName of the old branch to create from",
"description": "Name of the old branch to create from",
"type": "string",
"uniqueItems": true,
"x-deprecated": true,
"x-go-name": "OldBranchName"
},
"old_ref_name": {
@@ -24222,6 +24229,7 @@
],
"properties": {
"active": {
"description": "Whether the webhook should be active upon creation",
"type": "boolean",
"default": false,
"x-go-name": "Active"
@@ -24253,6 +24261,7 @@
"x-go-name": "Name"
},
"type": {
"description": "The type of the webhook to create",
"type": "string",
"enum": [
"dingtalk",
@@ -24287,6 +24296,7 @@
],
"properties": {
"body": {
"description": "Body is the comment text content",
"type": "string",
"x-go-name": "Body"
}
@@ -24417,6 +24427,7 @@
"example": false
},
"name": {
"description": "Name is the display name for the new label",
"type": "string",
"x-go-name": "Name"
}
@@ -24433,11 +24444,13 @@
"x-go-name": "Description"
},
"due_on": {
"description": "Deadline is the due date for the milestone",
"type": "string",
"format": "date-time",
"x-go-name": "Deadline"
},
"state": {
"description": "State indicates the initial state of the milestone",
"type": "string",
"enum": [
"open",
@@ -24541,7 +24554,7 @@
"x-go-name": "UserName"
},
"visibility": {
"description": "possible values are `public` (default), `limited` or `private`\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate",
"description": "possible values are `public` (default), `limited` or `private`",
"type": "string",
"enum": [
"public",
@@ -24833,7 +24846,7 @@
"x-go-name": "Name"
},
"object_format_name": {
"description": "ObjectFormatName of the underlying git repository, empty string for default (sha1)\nsha1 ObjectFormatSHA1\nsha256 ObjectFormatSHA256",
"description": "ObjectFormatName of the underlying git repository, empty string for default (sha1)",
"type": "string",
"enum": [
"sha1",
@@ -24886,7 +24899,7 @@
"x-go-name": "Description"
},
"state": {
"description": "State represents the status state to set (pending, success, error, failure)\npending CommitStatusPending is for when the CommitStatus is Pending\nsuccess CommitStatusSuccess is for when the CommitStatus is Success\nerror CommitStatusError is for when the CommitStatus is Error\nfailure CommitStatusFailure is for when the CommitStatus is Failure\nwarning CommitStatusWarning is for when the CommitStatus is Warning\nskipped CommitStatusSkipped is for when CommitStatus is Skipped",
"description": "State represents the status state to set (pending, success, error, failure)",
"type": "string",
"enum": [
"pending",
@@ -24920,6 +24933,7 @@
"x-go-name": "Message"
},
"tag_name": {
"description": "The name of the tag to create",
"type": "string",
"x-go-name": "TagName"
},
@@ -24996,18 +25010,20 @@
"x-go-name": "Permission"
},
"units": {
"description": "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.",
"type": "array",
"items": {
"type": "string"
},
"x-deprecated": true,
"x-go-name": "Units",
"example": [
"repo.actions",
"repo.packages",
"repo.code",
"repo.issues",
"repo.ext_issues",
"repo.wiki",
"repo.ext_wiki",
"repo.pulls",
"repo.releases",
"repo.projects",
@@ -25020,10 +25036,21 @@
"type": "string"
},
"x-go-name": "UnitsMap",
"example": "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}"
"example": {
"repo.actions": "read",
"repo.code": "read",
"repo.ext_issues": "none",
"repo.ext_wiki": "none",
"repo.issues": "write",
"repo.packages": "read",
"repo.projects": "none",
"repo.pulls": "owner",
"repo.releases": "none",
"repo.wiki": "admin"
}
},
"visibility": {
"description": "Team visibility within the organization. Defaults to \"private\".\npublic TeamVisibilityPublic\nlimited TeamVisibilityLimited\nprivate TeamVisibilityPrivate",
"description": "Team visibility within the organization. Defaults to \"private\".",
"type": "string",
"enum": [
"public",
@@ -25052,7 +25079,6 @@
},
"email": {
"type": "string",
"format": "email",
"x-go-name": "Email"
},
"full_name": {
@@ -25098,7 +25124,7 @@
"x-go-name": "Username"
},
"visibility": {
"description": "User visibility level: public, limited, or private\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate",
"description": "User visibility level: public, limited, or private",
"type": "string",
"enum": [
"public",
@@ -25298,6 +25324,7 @@
"type": "object",
"properties": {
"created_at": {
"description": "Created is the time when the deploy key was added",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -25634,6 +25661,7 @@
],
"properties": {
"body": {
"description": "Body is the updated comment text content",
"type": "string",
"x-go-name": "Body"
}
@@ -25798,7 +25826,7 @@
"x-go-name": "RepoAdminChangeTeamAccess"
},
"visibility": {
"description": "possible values are `public`, `limited` or `private`\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate",
"description": "possible values are `public`, `limited` or `private`",
"type": "string",
"enum": [
"public",
@@ -26198,10 +26226,12 @@
"x-go-name": "Permission"
},
"units": {
"description": "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.",
"type": "array",
"items": {
"type": "string"
},
"x-deprecated": true,
"x-go-name": "Units",
"example": [
"repo.code",
@@ -26232,7 +26262,7 @@
}
},
"visibility": {
"description": "Team visibility within the organization. When omitted, visibility is\nleft unchanged.\npublic TeamVisibilityPublic\nlimited TeamVisibilityLimited\nprivate TeamVisibilityPrivate",
"description": "Team visibility within the organization. When omitted, visibility is\nleft unchanged.",
"type": "string",
"enum": [
"public",
@@ -26284,6 +26314,7 @@
"x-go-name": "Description"
},
"email": {
"description": "The email address of the user",
"type": "string",
"format": "email",
"x-go-name": "Email"
@@ -26331,12 +26362,13 @@
"x-go-name": "Restricted"
},
"source_id": {
"description": "The authentication source ID to associate with the user",
"type": "integer",
"format": "int64",
"x-go-name": "SourceID"
},
"visibility": {
"description": "User visibility level: public, limited, or private\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate",
"description": "User visibility level: public, limited, or private",
"type": "string",
"enum": [
"public",
@@ -26359,6 +26391,7 @@
"type": "object",
"properties": {
"email": {
"description": "The email address",
"type": "string",
"format": "email",
"x-go-name": "Email"
@@ -26437,6 +26470,7 @@
"$ref": "#/definitions/CommitUser"
},
"created": {
"description": "Created is the time when the commit was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -26576,6 +26610,7 @@
"x-go-name": "CanSign"
},
"created_at": {
"description": "The date and time when the GPG key was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -26589,6 +26624,7 @@
"x-go-name": "Emails"
},
"expires_at": {
"description": "The date and time when the GPG key expires",
"type": "string",
"format": "date-time",
"x-go-name": "Expires"
@@ -27077,6 +27113,7 @@
"x-go-name": "Config"
},
"created_at": {
"description": "The date and time when the webhook was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -27106,6 +27143,7 @@
"x-go-name": "Type"
},
"updated_at": {
"description": "The date and time when the webhook was last updated",
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
@@ -27118,6 +27156,7 @@
"type": "object",
"properties": {
"email": {
"description": "Email is the person's email address",
"type": "string",
"format": "email",
"x-go-name": "Email"
@@ -27652,8 +27691,9 @@
"type": "string"
},
"Wiki": {
"description": "Is it a wiki page? (use mode=wiki instead)\n\nDeprecated: true",
"type": "boolean"
"description": "Is it a wiki page? (use mode=wiki instead)",
"type": "boolean",
"x-deprecated": true
}
},
"x-go-package": "gitea.dev/modules/structs"
@@ -27679,8 +27719,9 @@
"type": "string"
},
"Wiki": {
"description": "Is it a wiki page? (use mode=wiki instead)\n\nDeprecated: true",
"type": "boolean"
"description": "Is it a wiki page? (use mode=wiki instead)",
"type": "boolean",
"x-deprecated": true
}
},
"x-go-package": "gitea.dev/modules/structs"
@@ -27916,7 +27957,7 @@
"x-go-name": "OpenIssues"
},
"state": {
"description": "State indicates if the milestone is open or closed\nopen StateOpen pr is opened\nclosed StateClosed pr is closed",
"description": "State indicates if the milestone is open or closed",
"type": "string",
"enum": [
"open",
@@ -27953,142 +27994,6 @@
},
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfo": {
"description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
"type": "object",
"properties": {
"metadata": {
"description": "Metadata contains free form key value pairs for software specific values",
"type": "object",
"x-go-name": "Metadata"
},
"openRegistrations": {
"description": "OpenRegistrations indicates if new user registrations are accepted",
"type": "boolean",
"x-go-name": "OpenRegistrations"
},
"protocols": {
"description": "Protocols lists the protocols supported by this server",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Protocols"
},
"services": {
"$ref": "#/definitions/NodeInfoServices"
},
"software": {
"$ref": "#/definitions/NodeInfoSoftware"
},
"usage": {
"$ref": "#/definitions/NodeInfoUsage"
},
"version": {
"description": "Version specifies the schema version",
"type": "string",
"x-go-name": "Version"
}
},
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoServices": {
"description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
"type": "object",
"properties": {
"inbound": {
"description": "Inbound lists services that can deliver content to this server",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Inbound"
},
"outbound": {
"description": "Outbound lists services this server can deliver content to",
"type": "array",
"items": {
"type": "string"
},
"x-go-name": "Outbound"
}
},
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoSoftware": {
"description": "NodeInfoSoftware contains Metadata about server software in use",
"type": "object",
"properties": {
"homepage": {
"description": "Homepage is the URL to the homepage of this server software",
"type": "string",
"x-go-name": "Homepage"
},
"name": {
"description": "Name is the canonical name of this server software",
"type": "string",
"x-go-name": "Name"
},
"repository": {
"description": "Repository is the URL to the source code repository",
"type": "string",
"x-go-name": "Repository"
},
"version": {
"description": "Version is the version of this server software",
"type": "string",
"x-go-name": "Version"
}
},
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoUsage": {
"description": "NodeInfoUsage contains usage statistics for this server",
"type": "object",
"properties": {
"localComments": {
"description": "LocalComments is the total amount of comments made by users local to this server",
"type": "integer",
"format": "int64",
"x-go-name": "LocalComments"
},
"localPosts": {
"description": "LocalPosts is the total amount of posts made by users local to this server",
"type": "integer",
"format": "int64",
"x-go-name": "LocalPosts"
},
"users": {
"$ref": "#/definitions/NodeInfoUsageUsers"
}
},
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoUsageUsers": {
"description": "NodeInfoUsageUsers contains statistics about the users of this server",
"type": "object",
"properties": {
"activeHalfyear": {
"description": "ActiveHalfyear is the amount of users that signed in at least once in the last 180 days",
"type": "integer",
"format": "int64",
"x-go-name": "ActiveHalfyear"
},
"activeMonth": {
"description": "ActiveMonth is the amount of users that signed in at least once in the last 30 days",
"type": "integer",
"format": "int64",
"x-go-name": "ActiveMonth"
},
"total": {
"description": "Total is the total amount of users on this server",
"type": "integer",
"format": "int64",
"x-go-name": "Total"
}
},
"x-go-package": "gitea.dev/modules/structs"
},
"Note": {
"description": "Note contains information related to a git note",
"type": "object",
@@ -28137,7 +28042,7 @@
"x-go-name": "LatestCommentURL"
},
"state": {
"description": "State indicates the current state of the notification subject\nopen NotifySubjectStateOpen is an open subject\nclosed NotifySubjectStateClosed is a closed subject\nmerged NotifySubjectStateMerged is a merged pull request",
"description": "State indicates the current state of the notification subject",
"type": "string",
"enum": [
"open",
@@ -28153,7 +28058,7 @@
"x-go-name": "Title"
},
"type": {
"description": "Type indicates the type of the notification subject\nIssue NotifySubjectIssue a issue is subject of an notification\nPull NotifySubjectPull a pull is subject of an notification\nCommit NotifySubjectCommit a commit is subject of an notification\nRepository NotifySubjectRepository a repository is subject of an notification",
"description": "Type indicates the type of the notification subject",
"type": "string",
"enum": [
"Issue",
@@ -28315,7 +28220,7 @@
"x-go-name": "UserName"
},
"visibility": {
"description": "The visibility level of the organization (public, limited, private)\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate",
"description": "The visibility level of the organization (public, limited, private)",
"type": "string",
"enum": [
"public",
@@ -28401,6 +28306,7 @@
"type": "object",
"properties": {
"created_at": {
"description": "The date and time when the package was created",
"type": "string",
"format": "date-time",
"x-go-name": "CreatedAt"
@@ -28532,6 +28438,7 @@
"x-go-name": "Removed"
},
"timestamp": {
"description": "The timestamp when the commit was made",
"type": "string",
"format": "date-time",
"x-go-name": "Timestamp"
@@ -28684,6 +28591,7 @@
"type": "object",
"properties": {
"created_at": {
"description": "Created is the time when the key was added",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -28917,7 +28825,7 @@
"x-go-name": "ReviewComments"
},
"state": {
"description": "The current state of the pull request\nopen StateOpen pr is opened\nclosed StateClosed pr is closed",
"description": "The current state of the pull request",
"type": "string",
"enum": [
"open",
@@ -29260,6 +29168,7 @@
"x-go-name": "Reaction"
},
"created_at": {
"description": "The date and time when the reaction was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -29432,7 +29341,7 @@
"type": "object",
"properties": {
"permission": {
"description": "Permission level of the collaborator\nnone AccessLevelNameNone\nread AccessLevelNameRead\nwrite AccessLevelNameWrite\nadmin AccessLevelNameAdmin\nowner AccessLevelNameOwner",
"description": "Permission level of the collaborator",
"type": "string",
"enum": [
"none",
@@ -29731,7 +29640,7 @@
"x-go-name": "Name"
},
"object_format_name": {
"description": "ObjectFormatName of the underlying git repository\nsha1 ObjectFormatSHA1\nsha256 ObjectFormatSHA256",
"description": "ObjectFormatName of the underlying git repository",
"type": "string",
"enum": [
"sha1",
@@ -29928,6 +29837,7 @@
"type": "object",
"properties": {
"created": {
"description": "Created is the time when the stopwatch was started",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -30030,6 +29940,7 @@
"type": "object",
"properties": {
"created_at": {
"description": "The date and time when the tag protection was created",
"type": "string",
"format": "date-time",
"x-go-name": "Created"
@@ -30046,6 +29957,7 @@
"x-go-name": "NamePattern"
},
"updated_at": {
"description": "The date and time when the tag protection was last updated",
"type": "string",
"format": "date-time",
"x-go-name": "Updated"
@@ -30115,10 +30027,12 @@
"x-go-name": "Permission"
},
"units": {
"description": "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.",
"type": "array",
"items": {
"type": "string"
},
"x-deprecated": true,
"x-go-name": "Units",
"example": [
"repo.code",
@@ -30149,7 +30063,7 @@
}
},
"visibility": {
"description": "Team visibility within the organization. \"private\" teams are only\nlistable by members and org owners; \"limited\" teams are listable by\nany organization member; \"public\" teams are listable by any signed-in\nuser.\npublic TeamVisibilityPublic\nlimited TeamVisibilityLimited\nprivate TeamVisibilityPrivate",
"description": "Team visibility within the organization. \"private\" teams are only\nlistable by members and org owners; \"limited\" teams are listable by\nany organization member; \"public\" teams are listable by any signed-in\nuser.",
"type": "string",
"enum": [
"public",
@@ -30669,7 +30583,7 @@
"x-go-name": "StarredRepos"
},
"visibility": {
"description": "User visibility level option: public, limited, private\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate",
"description": "User visibility level option: public, limited, private",
"type": "string",
"enum": [
"public",
@@ -31501,12 +31415,6 @@
"type": "string"
}
},
"MergeUpstreamRequest": {
"description": "",
"schema": {
"$ref": "#/definitions/MergeUpstreamRequest"
}
},
"MergeUpstreamResponse": {
"description": "",
"schema": {
@@ -31528,12 +31436,6 @@
}
}
},
"NodeInfo": {
"description": "NodeInfo",
"schema": {
"$ref": "#/definitions/NodeInfo"
}
},
"Note": {
"description": "Note",
"schema": {
@@ -31711,12 +31613,6 @@
}
}
},
"Reference": {
"description": "Reference",
"schema": {
"$ref": "#/definitions/Reference"
}
},
"ReferenceList": {
"description": "ReferenceList",
"schema": {
@@ -31812,12 +31708,6 @@
"$ref": "#/definitions/SearchResults"
}
},
"Secret": {
"description": "Secret",
"schema": {
"$ref": "#/definitions/Secret"
}
},
"SecretList": {
"description": "SecretList",
"schema": {
@@ -31833,12 +31723,6 @@
"$ref": "#/definitions/ServerVersion"
}
},
"StopWatch": {
"description": "StopWatch",
"schema": {
"$ref": "#/definitions/StopWatch"
}
},
"StopWatchList": {
"description": "StopWatchList",
"schema": {
@@ -32085,15 +31969,6 @@
"notFound": {
"description": "APINotFound is a not found empty response"
},
"parameterBodies": {
"description": "parameterBodies",
"schema": {
"$ref": "#/definitions/LockIssueOption"
}
},
"redirect": {
"description": "APIRedirect is a redirect response"
},
"repoArchivedError": {
"description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified",
"headers": {
templates/swagger/v1_openapi3_json.tmpl
Generated
+88 -235
View File
@@ -802,16 +802,6 @@
},
"description": "MarkupRender is a rendered markup document"
},
"MergeUpstreamRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeUpstreamRequest"
}
}
},
"description": ""
},
"MergeUpstreamResponse": {
"content": {
"application/json": {
@@ -845,16 +835,6 @@
},
"description": "MilestoneList"
},
"NodeInfo": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NodeInfo"
}
}
},
"description": "NodeInfo"
},
"Note": {
"content": {
"application/json": {
@@ -1128,16 +1108,6 @@
},
"description": "ReactionList"
},
"Reference": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Reference"
}
}
},
"description": "Reference"
},
"ReferenceList": {
"content": {
"application/json": {
@@ -1287,16 +1257,6 @@
},
"description": "SearchResults"
},
"Secret": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Secret"
}
}
},
"description": "Secret"
},
"SecretList": {
"content": {
"application/json": {
@@ -1320,16 +1280,6 @@
},
"description": "ServerVersion"
},
"StopWatch": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StopWatch"
}
}
},
"description": "StopWatch"
},
"StopWatchList": {
"content": {
"application/json": {
@@ -1696,19 +1646,6 @@
"notFound": {
"description": "APINotFound is a not found empty response"
},
"parameterBodies": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockIssueOption"
}
}
},
"description": "parameterBodies"
},
"redirect": {
"description": "APIRedirect is a redirect response"
},
"repoArchivedError": {
"description": "APIRepoArchivedError is an error that is raised when an archived repo should be modified",
"headers": {
@@ -2563,7 +2500,7 @@
"$ref": "#/components/schemas/RepoWritePermission"
}
],
"description": "Permission level to grant the collaborator\nread RepoWritePermissionRead\nwrite RepoWritePermissionWrite\nadmin RepoWritePermissionAdmin"
"description": "Permission level to grant the collaborator"
}
},
"type": "object",
@@ -2713,6 +2650,7 @@
"x-go-name": "DownloadURL"
},
"created_at": {
"description": "Created is the time when the attachment was uploaded",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -2862,9 +2800,8 @@
"x-go-name": "BlockOnRejectedReviews"
},
"branch_name": {
"deprecated": true,
"description": "Deprecated: true",
"type": "string",
"x-deprecated": true,
"x-go-name": "BranchName"
},
"bypass_allowlist_teams": {
@@ -3196,7 +3133,7 @@
"$ref": "#/components/schemas/CommitStatusState"
}
],
"description": "State is the overall combined status state\npending CommitStatusPending is for when the CommitStatus is Pending\nsuccess CommitStatusSuccess is for when the CommitStatus is Success\nerror CommitStatusError is for when the CommitStatus is Error\nfailure CommitStatusFailure is for when the CommitStatus is Failure\nwarning CommitStatusWarning is for when the CommitStatus is Warning\nskipped CommitStatusSkipped is for when CommitStatus is Skipped"
"description": "State is the overall combined status state"
},
"statuses": {
"description": "Statuses contains all individual commit statuses",
@@ -3302,6 +3239,7 @@
"$ref": "#/components/schemas/User"
},
"created": {
"description": "Created is the time when the commit was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -3368,11 +3306,13 @@
"description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
"properties": {
"author": {
"description": "Author is the author date for the commit",
"format": "date-time",
"type": "string",
"x-go-name": "Author"
},
"committer": {
"description": "Committer is the committer date for the commit",
"format": "date-time",
"type": "string",
"x-go-name": "Committer"
@@ -3384,6 +3324,7 @@
"CommitMeta": {
"properties": {
"created": {
"description": "Created is the time when the commit was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -3462,7 +3403,7 @@
"$ref": "#/components/schemas/CommitStatusState"
}
],
"description": "State represents the status state (pending, success, error, failure)\npending CommitStatusPending is for when the CommitStatus is Pending\nsuccess CommitStatusSuccess is for when the CommitStatus is Success\nerror CommitStatusError is for when the CommitStatus is Error\nfailure CommitStatusFailure is for when the CommitStatus is Failure\nwarning CommitStatusWarning is for when the CommitStatus is Warning\nskipped CommitStatusSkipped is for when CommitStatus is Skipped"
"description": "State represents the status state (pending, success, error, failure)"
},
"target_url": {
"description": "TargetURL is the URL to link to for more details",
@@ -3504,6 +3445,7 @@
"x-go-name": "Date"
},
"email": {
"description": "Email is the person's email address",
"format": "email",
"type": "string",
"x-go-name": "Email"
@@ -3754,9 +3696,8 @@
"x-go-name": "BlockOnRejectedReviews"
},
"branch_name": {
"deprecated": true,
"description": "Deprecated: true",
"type": "string",
"x-deprecated": true,
"x-go-name": "BranchName"
},
"bypass_allowlist_teams": {
@@ -3910,10 +3851,10 @@
"x-go-name": "BranchName"
},
"old_branch_name": {
"deprecated": true,
"description": "Deprecated: true\nName of the old branch to create from",
"description": "Name of the old branch to create from",
"type": "string",
"uniqueItems": true,
"x-deprecated": true,
"x-go-name": "OldBranchName"
},
"old_ref_name": {
@@ -4036,6 +3977,7 @@
"properties": {
"active": {
"default": false,
"description": "Whether the webhook should be active upon creation",
"type": "boolean",
"x-go-name": "Active"
},
@@ -4066,6 +4008,7 @@
"x-go-name": "Name"
},
"type": {
"description": "The type of the webhook to create",
"enum": [
"dingtalk",
"discord",
@@ -4101,6 +4044,7 @@
"description": "CreateIssueCommentOption options for creating a comment on an issue",
"properties": {
"body": {
"description": "Body is the comment text content",
"type": "string",
"x-go-name": "Body"
}
@@ -4231,6 +4175,7 @@
"x-go-name": "IsArchived"
},
"name": {
"description": "Name is the display name for the new label",
"type": "string",
"x-go-name": "Name"
}
@@ -4251,12 +4196,18 @@
"x-go-name": "Description"
},
"due_on": {
"description": "Deadline is the due date for the milestone",
"format": "date-time",
"type": "string",
"x-go-name": "Deadline"
},
"state": {
"$ref": "#/components/schemas/StateType"
"allOf": [
{
"$ref": "#/components/schemas/StateType"
}
],
"description": "State indicates the initial state of the milestone"
},
"title": {
"description": "Title is the title of the new milestone",
@@ -4356,7 +4307,7 @@
"$ref": "#/components/schemas/UserVisibility"
}
],
"description": "possible values are `public` (default), `limited` or `private`\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate"
"description": "possible values are `public` (default), `limited` or `private`"
},
"website": {
"description": "The website URL of the organization",
@@ -4636,7 +4587,7 @@
"$ref": "#/components/schemas/ObjectFormatName"
}
],
"description": "ObjectFormatName of the underlying git repository, empty string for default (sha1)\nsha1 ObjectFormatSHA1\nsha256 ObjectFormatSHA256"
"description": "ObjectFormatName of the underlying git repository, empty string for default (sha1)"
},
"private": {
"description": "Whether the repository is private",
@@ -4690,7 +4641,7 @@
"$ref": "#/components/schemas/CommitStatusState"
}
],
"description": "State represents the status state to set (pending, success, error, failure)\npending CommitStatusPending is for when the CommitStatus is Pending\nsuccess CommitStatusSuccess is for when the CommitStatus is Success\nerror CommitStatusError is for when the CommitStatus is Error\nfailure CommitStatusFailure is for when the CommitStatus is Failure\nwarning CommitStatusWarning is for when the CommitStatus is Warning\nskipped CommitStatusSkipped is for when CommitStatus is Skipped"
"description": "State represents the status state to set (pending, success, error, failure)"
},
"target_url": {
"description": "TargetURL is the URL to link to for more details",
@@ -4711,6 +4662,7 @@
"x-go-name": "Message"
},
"tag_name": {
"description": "The name of the tag to create",
"type": "string",
"x-go-name": "TagName"
},
@@ -4780,13 +4732,15 @@
"$ref": "#/components/schemas/RepoWritePermission"
},
"units": {
"deprecated": true,
"description": "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.",
"example": [
"repo.actions",
"repo.packages",
"repo.code",
"repo.issues",
"repo.ext_issues",
"repo.wiki",
"repo.ext_wiki",
"repo.pulls",
"repo.releases",
"repo.projects",
@@ -4796,13 +4750,25 @@
"type": "string"
},
"type": "array",
"x-deprecated": true,
"x-go-name": "Units"
},
"units_map": {
"additionalProperties": {
"type": "string"
},
"example": "{\"repo.actions\",\"repo.packages\",\"repo.code\":\"read\",\"repo.issues\":\"write\",\"repo.ext_issues\":\"none\",\"repo.wiki\":\"admin\",\"repo.pulls\":\"owner\",\"repo.releases\":\"none\",\"repo.projects\":\"none\",\"repo.ext_wiki\":\"none\"}",
"example": {
"repo.actions": "read",
"repo.code": "read",
"repo.ext_issues": "none",
"repo.ext_wiki": "none",
"repo.issues": "write",
"repo.packages": "read",
"repo.projects": "none",
"repo.pulls": "owner",
"repo.releases": "none",
"repo.wiki": "admin"
},
"type": "object",
"x-go-name": "UnitsMap"
},
@@ -4812,7 +4778,7 @@
"$ref": "#/components/schemas/TeamVisibility"
}
],
"description": "Team visibility within the organization. Defaults to \"private\".\npublic TeamVisibilityPublic\nlimited TeamVisibilityLimited\nprivate TeamVisibilityPrivate"
"description": "Team visibility within the organization. Defaults to \"private\"."
}
},
"required": [
@@ -4831,7 +4797,6 @@
"x-go-name": "Created"
},
"email": {
"format": "email",
"type": "string",
"x-go-name": "Email"
},
@@ -4883,7 +4848,7 @@
"$ref": "#/components/schemas/UserVisibility"
}
],
"description": "User visibility level: public, limited, or private\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate"
"description": "User visibility level: public, limited, or private"
}
},
"required": [
@@ -5079,6 +5044,7 @@
"description": "DeployKey a deploy key",
"properties": {
"created_at": {
"description": "Created is the time when the deploy key was added",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -5413,6 +5379,7 @@
"description": "EditIssueCommentOption options for editing a comment",
"properties": {
"body": {
"description": "Body is the updated comment text content",
"type": "string",
"x-go-name": "Body"
}
@@ -5585,7 +5552,7 @@
"$ref": "#/components/schemas/UserVisibility"
}
],
"description": "possible values are `public`, `limited` or `private`\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate"
"description": "possible values are `public`, `limited` or `private`"
},
"website": {
"description": "The website URL of the organization",
@@ -5967,6 +5934,8 @@
"$ref": "#/components/schemas/RepoWritePermission"
},
"units": {
"deprecated": true,
"description": "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.",
"example": [
"repo.code",
"repo.issues",
@@ -5981,6 +5950,7 @@
"type": "string"
},
"type": "array",
"x-deprecated": true,
"x-go-name": "Units"
},
"units_map": {
@@ -6006,7 +5976,7 @@
"$ref": "#/components/schemas/TeamVisibility"
}
],
"description": "Team visibility within the organization. When omitted, visibility is\nleft unchanged.\npublic TeamVisibilityPublic\nlimited TeamVisibilityLimited\nprivate TeamVisibilityPrivate"
"description": "Team visibility within the organization. When omitted, visibility is\nleft unchanged."
}
},
"required": [
@@ -6049,6 +6019,7 @@
"x-go-name": "Description"
},
"email": {
"description": "The email address of the user",
"format": "email",
"type": "string",
"x-go-name": "Email"
@@ -6096,6 +6067,7 @@
"x-go-name": "Restricted"
},
"source_id": {
"description": "The authentication source ID to associate with the user",
"format": "int64",
"type": "integer",
"x-go-name": "SourceID"
@@ -6106,7 +6078,7 @@
"$ref": "#/components/schemas/UserVisibility"
}
],
"description": "User visibility level: public, limited, or private\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate"
"description": "User visibility level: public, limited, or private"
},
"website": {
"description": "The user's personal website URL",
@@ -6125,6 +6097,7 @@
"description": "Email an email address belonging to a user",
"properties": {
"email": {
"description": "The email address",
"format": "email",
"type": "string",
"x-go-name": "Email"
@@ -6204,6 +6177,7 @@
"$ref": "#/components/schemas/CommitUser"
},
"created": {
"description": "Created is the time when the commit was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -6346,6 +6320,7 @@
"x-go-name": "CanSign"
},
"created_at": {
"description": "The date and time when the GPG key was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -6359,6 +6334,7 @@
"x-go-name": "Emails"
},
"expires_at": {
"description": "The date and time when the GPG key expires",
"format": "date-time",
"type": "string",
"x-go-name": "Expires"
@@ -6851,6 +6827,7 @@
"x-go-name": "Config"
},
"created_at": {
"description": "The date and time when the webhook was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -6880,6 +6857,7 @@
"x-go-name": "Type"
},
"updated_at": {
"description": "The date and time when the webhook was last updated",
"format": "date-time",
"type": "string",
"x-go-name": "Updated"
@@ -6892,6 +6870,7 @@
"description": "Identity for a person's identity like an author or committer",
"properties": {
"email": {
"description": "Email is the person's email address",
"format": "email",
"type": "string",
"x-go-name": "Email"
@@ -7426,9 +7405,9 @@
"type": "string"
},
"Wiki": {
"deprecated": true,
"description": "Is it a wiki page? (use mode=wiki instead)\n\nDeprecated: true",
"type": "boolean"
"description": "Is it a wiki page? (use mode=wiki instead)",
"type": "boolean",
"x-deprecated": true
}
},
"type": "object",
@@ -7454,9 +7433,9 @@
"type": "string"
},
"Wiki": {
"deprecated": true,
"description": "Is it a wiki page? (use mode=wiki instead)\n\nDeprecated: true",
"type": "boolean"
"description": "Is it a wiki page? (use mode=wiki instead)",
"type": "boolean",
"x-deprecated": true
}
},
"type": "object",
@@ -7698,7 +7677,7 @@
"$ref": "#/components/schemas/StateType"
}
],
"description": "State indicates if the milestone is open or closed\nopen StateOpen pr is opened\nclosed StateClosed pr is closed"
"description": "State indicates if the milestone is open or closed"
},
"title": {
"description": "Title is the title of the milestone",
@@ -7729,142 +7708,6 @@
"type": "object",
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfo": {
"description": "NodeInfo contains standardized way of exposing metadata about a server running one of the distributed social networks",
"properties": {
"metadata": {
"description": "Metadata contains free form key value pairs for software specific values",
"type": "object",
"x-go-name": "Metadata"
},
"openRegistrations": {
"description": "OpenRegistrations indicates if new user registrations are accepted",
"type": "boolean",
"x-go-name": "OpenRegistrations"
},
"protocols": {
"description": "Protocols lists the protocols supported by this server",
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "Protocols"
},
"services": {
"$ref": "#/components/schemas/NodeInfoServices"
},
"software": {
"$ref": "#/components/schemas/NodeInfoSoftware"
},
"usage": {
"$ref": "#/components/schemas/NodeInfoUsage"
},
"version": {
"description": "Version specifies the schema version",
"type": "string",
"x-go-name": "Version"
}
},
"type": "object",
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoServices": {
"description": "NodeInfoServices contains the third party sites this server can connect to via their application API",
"properties": {
"inbound": {
"description": "Inbound lists services that can deliver content to this server",
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "Inbound"
},
"outbound": {
"description": "Outbound lists services this server can deliver content to",
"items": {
"type": "string"
},
"type": "array",
"x-go-name": "Outbound"
}
},
"type": "object",
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoSoftware": {
"description": "NodeInfoSoftware contains Metadata about server software in use",
"properties": {
"homepage": {
"description": "Homepage is the URL to the homepage of this server software",
"type": "string",
"x-go-name": "Homepage"
},
"name": {
"description": "Name is the canonical name of this server software",
"type": "string",
"x-go-name": "Name"
},
"repository": {
"description": "Repository is the URL to the source code repository",
"type": "string",
"x-go-name": "Repository"
},
"version": {
"description": "Version is the version of this server software",
"type": "string",
"x-go-name": "Version"
}
},
"type": "object",
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoUsage": {
"description": "NodeInfoUsage contains usage statistics for this server",
"properties": {
"localComments": {
"description": "LocalComments is the total amount of comments made by users local to this server",
"format": "int64",
"type": "integer",
"x-go-name": "LocalComments"
},
"localPosts": {
"description": "LocalPosts is the total amount of posts made by users local to this server",
"format": "int64",
"type": "integer",
"x-go-name": "LocalPosts"
},
"users": {
"$ref": "#/components/schemas/NodeInfoUsageUsers"
}
},
"type": "object",
"x-go-package": "gitea.dev/modules/structs"
},
"NodeInfoUsageUsers": {
"description": "NodeInfoUsageUsers contains statistics about the users of this server",
"properties": {
"activeHalfyear": {
"description": "ActiveHalfyear is the amount of users that signed in at least once in the last 180 days",
"format": "int64",
"type": "integer",
"x-go-name": "ActiveHalfyear"
},
"activeMonth": {
"description": "ActiveMonth is the amount of users that signed in at least once in the last 30 days",
"format": "int64",
"type": "integer",
"x-go-name": "ActiveMonth"
},
"total": {
"description": "Total is the total amount of users on this server",
"format": "int64",
"type": "integer",
"x-go-name": "Total"
}
},
"type": "object",
"x-go-package": "gitea.dev/modules/structs"
},
"Note": {
"description": "Note contains information related to a git note",
"properties": {
@@ -7915,7 +7758,7 @@
"x-go-name": "LatestCommentURL"
},
"state": {
"description": "State indicates the current state of the notification subject\nopen NotifySubjectStateOpen is an open subject\nclosed NotifySubjectStateClosed is a closed subject\nmerged NotifySubjectStateMerged is a merged pull request",
"description": "State indicates the current state of the notification subject",
"enum": [
"open",
"closed",
@@ -7931,7 +7774,7 @@
"x-go-name": "Title"
},
"type": {
"description": "Type indicates the type of the notification subject\nIssue NotifySubjectIssue a issue is subject of an notification\nPull NotifySubjectPull a pull is subject of an notification\nCommit NotifySubjectCommit a commit is subject of an notification\nRepository NotifySubjectRepository a repository is subject of an notification",
"description": "Type indicates the type of the notification subject",
"enum": [
"Issue",
"Pull",
@@ -8109,7 +7952,7 @@
"$ref": "#/components/schemas/UserVisibility"
}
],
"description": "The visibility level of the organization (public, limited, private)\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate"
"description": "The visibility level of the organization (public, limited, private)"
},
"website": {
"description": "The website URL of the organization",
@@ -8187,6 +8030,7 @@
"description": "Package represents a package",
"properties": {
"created_at": {
"description": "The date and time when the package was created",
"format": "date-time",
"type": "string",
"x-go-name": "CreatedAt"
@@ -8319,6 +8163,7 @@
"x-go-name": "Removed"
},
"timestamp": {
"description": "The timestamp when the commit was made",
"format": "date-time",
"type": "string",
"x-go-name": "Timestamp"
@@ -8472,6 +8317,7 @@
"description": "PublicKey publickey is a user key to push code to repository",
"properties": {
"created_at": {
"description": "Created is the time when the key was added",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -8714,7 +8560,7 @@
"$ref": "#/components/schemas/StateType"
}
],
"description": "The current state of the pull request\nopen StateOpen pr is opened\nclosed StateClosed pr is closed"
"description": "The current state of the pull request"
},
"title": {
"description": "The title of the pull request",
@@ -9049,6 +8895,7 @@
"x-go-name": "Reaction"
},
"created_at": {
"description": "The date and time when the reaction was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -9232,7 +9079,7 @@
"$ref": "#/components/schemas/AccessLevelName"
}
],
"description": "Permission level of the collaborator\nnone AccessLevelNameNone\nread AccessLevelNameRead\nwrite AccessLevelNameWrite\nadmin AccessLevelNameAdmin\nowner AccessLevelNameOwner"
"description": "Permission level of the collaborator"
},
"role_name": {
"description": "RoleName is the name of the permission role",
@@ -9539,7 +9386,7 @@
"$ref": "#/components/schemas/ObjectFormatName"
}
],
"description": "ObjectFormatName of the underlying git repository\nsha1 ObjectFormatSHA1\nsha256 ObjectFormatSHA256"
"description": "ObjectFormatName of the underlying git repository"
},
"open_issues_count": {
"format": "int64",
@@ -9751,6 +9598,7 @@
"description": "StopWatch represent a running stopwatch",
"properties": {
"created": {
"description": "Created is the time when the stopwatch was started",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -9846,6 +9694,7 @@
"description": "TagProtection represents a tag protection",
"properties": {
"created_at": {
"description": "The date and time when the tag protection was created",
"format": "date-time",
"type": "string",
"x-go-name": "Created"
@@ -9862,6 +9711,7 @@
"x-go-name": "NamePattern"
},
"updated_at": {
"description": "The date and time when the tag protection was last updated",
"format": "date-time",
"type": "string",
"x-go-name": "Updated"
@@ -9922,6 +9772,8 @@
"$ref": "#/components/schemas/AccessLevelName"
},
"units": {
"deprecated": true,
"description": "Deprecated: This variable should be replaced by UnitsMap and will be dropped in later versions.",
"example": [
"repo.code",
"repo.issues",
@@ -9936,6 +9788,7 @@
"type": "string"
},
"type": "array",
"x-deprecated": true,
"x-go-name": "Units"
},
"units_map": {
@@ -9961,7 +9814,7 @@
"$ref": "#/components/schemas/TeamVisibility"
}
],
"description": "Team visibility within the organization. \"private\" teams are only\nlistable by members and org owners; \"limited\" teams are listable by\nany organization member; \"public\" teams are listable by any signed-in\nuser.\npublic TeamVisibilityPublic\nlimited TeamVisibilityLimited\nprivate TeamVisibilityPrivate"
"description": "Team visibility within the organization. \"private\" teams are only\nlistable by members and org owners; \"limited\" teams are listable by\nany organization member; \"public\" teams are listable by any signed-in\nuser."
}
},
"type": "object",
@@ -10493,7 +10346,7 @@
"$ref": "#/components/schemas/UserVisibility"
}
],
"description": "User visibility level option: public, limited, private\npublic UserVisibilityPublic\nlimited UserVisibilityLimited\nprivate UserVisibilityPrivate"
"description": "User visibility level option: public, limited, private"
},
"website": {
"description": "the user's website",