diff --git a/static/openapi3-latest.json b/static/openapi3-latest.json index 736e767e..7c25c89c 100644 --- a/static/openapi3-latest.json +++ b/static/openapi3-latest.json @@ -228,6 +228,16 @@ } } }, + "CodeSearchResults": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CodeSearchResults" + } + } + }, + "description": "CodeSearchResults" + }, "CombinedStatus": { "content": { "application/json": { @@ -3147,6 +3157,123 @@ "type": "object", "x-go-package": "gitea.dev/modules/structs" }, + "CodeSearchResultItem": { + "properties": { + "html_url": { + "description": "File URL at the searched commit", + "format": "uri", + "type": "string", + "x-go-name": "HTMLURL" + }, + "language": { + "description": "Programming language (Gitea extension)", + "type": "string", + "x-go-name": "Language" + }, + "name": { + "type": "string", + "x-go-name": "Name" + }, + "path": { + "type": "string", + "x-go-name": "Path" + }, + "repository": { + "$ref": "#/components/schemas/Repository" + }, + "text_matches": { + "items": { + "$ref": "#/components/schemas/CodeSearchTextMatch" + }, + "type": "array", + "x-go-name": "TextMatches" + }, + "url": { + "description": "Contents API URL at the searched commit", + "format": "uri", + "type": "string", + "x-go-name": "URL" + } + }, + "title": "CodeSearchResultItem is a matching file.", + "type": "object", + "x-go-package": "gitea.dev/modules/structs" + }, + "CodeSearchResults": { + "properties": { + "incomplete_results": { + "description": "Search stopped early", + "type": "boolean", + "x-go-name": "IncompleteResults" + }, + "items": { + "items": { + "$ref": "#/components/schemas/CodeSearchResultItem" + }, + "type": "array", + "x-go-name": "Items" + }, + "total_count": { + "format": "int64", + "type": "integer", + "x-go-name": "TotalCount" + } + }, + "title": "CodeSearchResults contains matching files.", + "type": "object", + "x-go-package": "gitea.dev/modules/structs" + }, + "CodeSearchTextMatch": { + "properties": { + "fragment": { + "type": "string", + "x-go-name": "Fragment" + }, + "matches": { + "items": { + "$ref": "#/components/schemas/CodeSearchTextMatchTerm" + }, + "type": "array", + "x-go-name": "Matches" + }, + "object_type": { + "type": "string", + "x-go-name": "ObjectType" + }, + "object_url": { + "format": "uri", + "type": "string", + "x-go-name": "ObjectURL" + }, + "property": { + "type": "string", + "x-go-name": "Property" + } + }, + "title": "CodeSearchTextMatch is a matching fragment.", + "type": "object", + "x-go-package": "gitea.dev/modules/structs" + }, + "CodeSearchTextMatchTerm": { + "properties": { + "indices": { + "description": "Start and end UTF-8 byte offsets in the fragment, end-exclusive", + "items": { + "format": "int64", + "type": "integer" + }, + "type": "array", + "x-go-name": "Indices" + }, + "text": { + "type": "string", + "x-go-name": "Text" + } + }, + "title": "CodeSearchTextMatchTerm is a matched term.", + "type": "object", + "x-go-package": "gitea.dev/modules/structs" + }, "CombinedStatus": { "description": "CombinedStatus holds the combined state of several statuses for a single commit", "properties": { @@ -5543,12 +5670,12 @@ "x-go-name": "Active" }, "authorization_header": { - "description": "Authorization header to include in webhook requests", + "description": "Authorization header to include in webhook requests, omitted keeps the current value unless the url changes", "type": "string", "x-go-name": "AuthorizationHeader" }, "branch_filter": { - "description": "Branch filter pattern to determine which branches trigger the webhook", + "description": "Branch filter pattern to determine which branches trigger the webhook, omitted keeps the current value", "type": "string", "x-go-name": "BranchFilter" }, @@ -5561,7 +5688,7 @@ "x-go-name": "Config" }, "events": { - "description": "List of events that trigger this webhook", + "description": "List of events that trigger this webhook, omitted or empty keeps the current events", "items": { "type": "string" }, @@ -6140,6 +6267,11 @@ "type": "string", "x-go-name": "ProjectsMode" }, + "pull_requests_creation_restriction": { + "description": "who is allowed to create pull requests: \"reader\" (default, any user with read access), \"member\" (must be a collaborator with read access) or \"writer\" (must be a collaborator with write access).", + "type": "string", + "x-go-name": "PullRequestsCreationRestriction" + }, "squash_merge_commit_message": { "description": "set the default squash merge commit message body: \"PR_BODY\", \"COMMIT_MESSAGES\", or \"BLANK\".", "type": "string", @@ -7278,6 +7410,11 @@ "type": "boolean", "x-go-name": "AllowOnlyContributorsToTrackTime" }, + "creation_restriction": { + "description": "who is allowed to create issues: \"reader\" (default, any user with read access), \"member\" (must be a collaborator with read access) or \"writer\" (must be a collaborator with write access).", + "type": "string", + "x-go-name": "CreationRestriction" + }, "enable_issue_dependencies": { "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)", "type": "boolean", @@ -9968,6 +10105,11 @@ "internal_tracker": { "$ref": "#/components/schemas/InternalTracker" }, + "issues_creation_restriction": { + "description": "who is allowed to create issues: \"reader\", \"member\" or \"writer\"", + "type": "string", + "x-go-name": "IssuesCreationRestriction" + }, "language": { "type": "string", "x-go-name": "Language" @@ -10050,6 +10192,11 @@ "type": "string", "x-go-name": "ProjectsMode" }, + "pull_requests_creation_restriction": { + "description": "who is allowed to create pull requests: \"reader\", \"member\" or \"writer\"", + "type": "string", + "x-go-name": "PullRequestsCreationRestriction" + }, "release_counter": { "format": "int64", "type": "integer", @@ -20183,6 +20330,77 @@ ] } }, + "/repos/{owner}/{repo}/code/search": { + "get": { + "description": "The files of the ref are searched with git grep, which returns at most 50 files. The result window is limited to 1000 files (page * limit).", + "operationId": "repoSearchCode", + "parameters": [ + { + "description": "owner of the repo", + "in": "path", + "name": "owner", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "name of the repo", + "in": "path", + "name": "repo", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Terms must all occur in a file. Supports \"exact phrases\", /regexp/ and path:DIR. Language and repository qualifiers are not supported.", + "in": "query", + "name": "q", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The name of the commit/branch/tag. Default to the repository’s default branch", + "in": "query", + "name": "ref", + "schema": { + "type": "string" + } + }, + { + "description": "page number of results to return (1-based)", + "in": "query", + "name": "page", + "schema": { + "type": "integer" + } + }, + { + "description": "page size of results", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/CodeSearchResults" + }, + "default": { + "$ref": "#/components/responses/error" + } + }, + "summary": "Search the code of a repository", + "tags": [ + "repository" + ] + } + }, "/repos/{owner}/{repo}/collaborators": { "get": { "operationId": "repoListCollaborators", @@ -33051,6 +33269,51 @@ ] } }, + "/search/code": { + "get": { + "description": "Authentication is required. The default branches are searched with the code indexer. Regular expressions are not supported. The result window is limited to 1000 files (page * limit).", + "operationId": "codeSearch", + "parameters": [ + { + "description": "Literal terms and \"exact phrases\" must all occur in a file, with optional qualifiers:\n\"repo:OWNER/NAME\", \"user:NAME\" and \"org:NAME\" to only search these repositories (each can be repeated),\n\"path:DIR\" to only search the files in a directory, \"language:NAME\" to only search the files of a language\n", + "in": "query", + "name": "q", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "page number of results to return (1-based)", + "in": "query", + "name": "page", + "schema": { + "type": "integer" + } + }, + { + "description": "page size of results", + "in": "query", + "name": "limit", + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/CodeSearchResults" + }, + "default": { + "$ref": "#/components/responses/error" + } + }, + "summary": "Search the code of all repositories", + "tags": [ + "repository" + ] + } + }, "/settings/api": { "get": { "operationId": "getGeneralAPISettings", @@ -36121,6 +36384,9 @@ "responses": { "200": { "$ref": "#/components/responses/UserSettings" + }, + "default": { + "$ref": "#/components/responses/error" } }, "summary": "Update user settings", diff --git a/static/swagger-latest.json b/static/swagger-latest.json index 76001986..ce90d24d 100644 --- a/static/swagger-latest.json +++ b/static/swagger-latest.json @@ -8260,6 +8260,68 @@ } } }, + "/repos/{owner}/{repo}/code/search": { + "get": { + "description": "The files of the ref are searched with git grep, which returns at most 50 files. The result window is limited to 1000 files (page * limit).", + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Search the code of a repository", + "operationId": "repoSearchCode", + "parameters": [ + { + "type": "string", + "description": "owner of the repo", + "name": "owner", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of the repo", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Terms must all occur in a file. Supports \"exact phrases\", /regexp/ and path:DIR. Language and repository qualifiers are not supported.", + "name": "q", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "The name of the commit/branch/tag. Default to the repository’s default branch", + "name": "ref", + "in": "query" + }, + { + "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/CodeSearchResults" + }, + "default": { + "$ref": "#/responses/error" + } + } + } + }, "/repos/{owner}/{repo}/collaborators": { "get": { "produces": [ @@ -20000,6 +20062,48 @@ } } }, + "/search/code": { + "get": { + "description": "Authentication is required. The default branches are searched with the code indexer. Regular expressions are not supported. The result window is limited to 1000 files (page * limit).", + "produces": [ + "application/json" + ], + "tags": [ + "repository" + ], + "summary": "Search the code of all repositories", + "operationId": "codeSearch", + "parameters": [ + { + "type": "string", + "description": "Literal terms and \"exact phrases\" must all occur in a file, with optional qualifiers:\n\"repo:OWNER/NAME\", \"user:NAME\" and \"org:NAME\" to only search these repositories (each can be repeated),\n\"path:DIR\" to only search the files in a directory, \"language:NAME\" to only search the files of a language\n", + "name": "q", + "in": "query", + "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/CodeSearchResults" + }, + "default": { + "$ref": "#/responses/error" + } + } + } + }, "/settings/api": { "get": { "produces": [ @@ -23053,6 +23157,9 @@ "responses": { "200": { "$ref": "#/responses/UserSettings" + }, + "default": { + "$ref": "#/responses/error" } } } @@ -25520,6 +25627,120 @@ }, "x-go-package": "gitea.dev/modules/structs" }, + "CodeSearchResultItem": { + "type": "object", + "title": "CodeSearchResultItem is a matching file.", + "properties": { + "html_url": { + "description": "File URL at the searched commit", + "type": "string", + "x-go-name": "HTMLURL" + }, + "language": { + "description": "Programming language (Gitea extension)", + "type": "string", + "x-go-name": "Language" + }, + "name": { + "type": "string", + "x-go-name": "Name" + }, + "path": { + "type": "string", + "x-go-name": "Path" + }, + "repository": { + "$ref": "#/definitions/Repository" + }, + "text_matches": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeSearchTextMatch" + }, + "x-go-name": "TextMatches" + }, + "url": { + "description": "Contents API URL at the searched commit", + "type": "string", + "x-go-name": "URL" + } + }, + "x-go-package": "gitea.dev/modules/structs" + }, + "CodeSearchResults": { + "type": "object", + "title": "CodeSearchResults contains matching files.", + "properties": { + "incomplete_results": { + "description": "Search stopped early", + "type": "boolean", + "x-go-name": "IncompleteResults" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeSearchResultItem" + }, + "x-go-name": "Items" + }, + "total_count": { + "type": "integer", + "format": "int64", + "x-go-name": "TotalCount" + } + }, + "x-go-package": "gitea.dev/modules/structs" + }, + "CodeSearchTextMatch": { + "type": "object", + "title": "CodeSearchTextMatch is a matching fragment.", + "properties": { + "fragment": { + "type": "string", + "x-go-name": "Fragment" + }, + "matches": { + "type": "array", + "items": { + "$ref": "#/definitions/CodeSearchTextMatchTerm" + }, + "x-go-name": "Matches" + }, + "object_type": { + "type": "string", + "x-go-name": "ObjectType" + }, + "object_url": { + "type": "string", + "x-go-name": "ObjectURL" + }, + "property": { + "type": "string", + "x-go-name": "Property" + } + }, + "x-go-package": "gitea.dev/modules/structs" + }, + "CodeSearchTextMatchTerm": { + "type": "object", + "title": "CodeSearchTextMatchTerm is a matched term.", + "properties": { + "indices": { + "description": "Start and end UTF-8 byte offsets in the fragment, end-exclusive", + "type": "array", + "items": { + "type": "integer", + "format": "int64" + }, + "x-go-name": "Indices" + }, + "text": { + "type": "string", + "x-go-name": "Text" + } + }, + "x-go-package": "gitea.dev/modules/structs" + }, "CombinedStatus": { "description": "CombinedStatus holds the combined state of several statuses for a single commit", "type": "object", @@ -27932,12 +28153,12 @@ "x-go-name": "Active" }, "authorization_header": { - "description": "Authorization header to include in webhook requests", + "description": "Authorization header to include in webhook requests, omitted keeps the current value unless the url changes", "type": "string", "x-go-name": "AuthorizationHeader" }, "branch_filter": { - "description": "Branch filter pattern to determine which branches trigger the webhook", + "description": "Branch filter pattern to determine which branches trigger the webhook, omitted keeps the current value", "type": "string", "x-go-name": "BranchFilter" }, @@ -27950,7 +28171,7 @@ "x-go-name": "Config" }, "events": { - "description": "List of events that trigger this webhook", + "description": "List of events that trigger this webhook, omitted or empty keeps the current events", "type": "array", "items": { "type": "string" @@ -28541,6 +28762,11 @@ "type": "string", "x-go-name": "ProjectsMode" }, + "pull_requests_creation_restriction": { + "description": "who is allowed to create pull requests: \"reader\" (default, any user with read access), \"member\" (must be a collaborator with read access) or \"writer\" (must be a collaborator with write access).", + "type": "string", + "x-go-name": "PullRequestsCreationRestriction" + }, "squash_merge_commit_message": { "description": "set the default squash merge commit message body: \"PR_BODY\", \"COMMIT_MESSAGES\", or \"BLANK\".", "type": "string", @@ -29681,6 +29907,11 @@ "type": "boolean", "x-go-name": "AllowOnlyContributorsToTrackTime" }, + "creation_restriction": { + "description": "who is allowed to create issues: \"reader\" (default, any user with read access), \"member\" (must be a collaborator with read access) or \"writer\" (must be a collaborator with write access).", + "type": "string", + "x-go-name": "CreationRestriction" + }, "enable_issue_dependencies": { "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)", "type": "boolean", @@ -32340,6 +32571,11 @@ "internal_tracker": { "$ref": "#/definitions/InternalTracker" }, + "issues_creation_restriction": { + "description": "who is allowed to create issues: \"reader\", \"member\" or \"writer\"", + "type": "string", + "x-go-name": "IssuesCreationRestriction" + }, "language": { "type": "string", "x-go-name": "Language" @@ -32422,6 +32658,11 @@ "type": "string", "x-go-name": "ProjectsMode" }, + "pull_requests_creation_restriction": { + "description": "who is allowed to create pull requests: \"reader\", \"member\" or \"writer\"", + "type": "string", + "x-go-name": "PullRequestsCreationRestriction" + }, "release_counter": { "type": "integer", "format": "int64", @@ -33813,6 +34054,12 @@ } } }, + "CodeSearchResults": { + "description": "CodeSearchResults", + "schema": { + "$ref": "#/definitions/CodeSearchResults" + } + }, "CombinedStatus": { "description": "CombinedStatus", "schema": {