openapi-directory/api/gitea.io.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"/api/v1"}],"info":{"contact":{"x-twitter":"giteaio"},"description":"This documentation describes the Gitea API.","license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"},"title":"Gitea API.","version":"1.20.0+dev-539-g5e389228f","x-apisguru-categories":["developer_tools"],"x-logo":{"url":"https://twitter.com/giteaio/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://try.gitea.io/swagger.v1.json","version":"3.0"}],"x-providerName":"gitea.io"},"security":[{"BasicAuth":[]},{"Token":[]},{"AccessToken":[]},{"AuthorizationHeaderToken":[]},{"SudoParam":[]},{"SudoHeader":[]},{"TOTPHeader":[]}],"paths":{"/activitypub/user-id/{user-id}":{"get":{"operationId":"activitypubPerson","parameters":[{"description":"user ID of the user","in":"path","name":"user-id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/ActivityPub"}},"summary":"Returns the Person actor for a user","tags":["activitypub"]}},"/activitypub/user-id/{user-id}/inbox":{"post":{"operationId":"activitypubPersonInbox","parameters":[{"description":"user ID of the user","in":"path","name":"user-id","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"$ref":"#/components/responses/empty"}},"summary":"Send to the inbox","tags":["activitypub"]}},"/admin/cron":{"get":{"operationId":"adminCronList","parameters":[{"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/CronList"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"List cron tasks","tags":["admin"]}},"/admin/cron/{task}":{"post":{"operationId":"adminCronRun","parameters":[{"description":"task to run","in":"path","name":"task","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Run cron task","tags":["admin"]}},"/admin/emails":{"get":{"operationId":"adminGetAllEmails","parameters":[{"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/EmailList"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"List all emails","tags":["admin"]}},"/admin/emails/search":{"get":{"operationId":"adminSearchEmails","parameters":[{"description":"keyword","in":"query","name":"q","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/EmailList"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"Search all emails","tags":["admin"]}},"/admin/hooks":{"get":{"operationId":"adminListHooks","parameters":[{"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/HookList"}},"summary":"List system's webhooks","tags":["admin"]},"post":{"operationId":"adminCreateHook","requestBody":{"$ref":"#/components/requestBodies/CreateHookOption"},"responses":{"201":{"$ref":"#/components/responses/Hook"}},"summary":"Create a hook","tags":["admin"]}},"/admin/hooks/{id}":{"get":{"operationId":"adminGetHook","parameters":[{"description":"id of the hook to get","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Hook"}},"summary":"Get a hook","tags":["admin"]},"patch":{"operationId":"adminEditHook","parameters":[{"description":"id of the hook to update","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/EditHookOption"},"responses":{"200":{"$ref":"#/components/responses/Hook"}},"summary":"Update a hook","tags":["admin"]}},"/admin/orgs":{"get":{"operationId":"adminGetAllOrgs","parameters":[{"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/OrganizationList"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"List all organizations","tags":["admin"]}},"/admin/unadopted":{"get":{"operationId":"adminUnadoptedList","parameters":[{"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"}},{"description":"pattern of repositories to search for","in":"query","name":"pattern","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/StringSlice"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"List unadopted repositories","tags":["admin"]}},"/admin/unadopted/{owner}/{repo}":{"delete":{"operationId":"adminDeleteUnadoptedRepository","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"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"Delete unadopted files","tags":["admin"]},"post":{"operationId":"adminAdoptRepository","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"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Adopt unadopted files as a repository","tags":["admin"]}},"/admin/users":{"get":{"operationId":"adminSearchUsers","parameters":[{"description":"ID of the user's login source to search for","in":"query","name":"source_id","schema":{"format":"int64","type":"integer"}},{"description":"user's login name to search for","in":"query","name":"login_name","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/UserList"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"Search users according filter conditions","tags":["admin"]},"post":{"operationId":"adminCreateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserOption"}}}},"responses":{"201":{"$ref":"#/components/responses/User"},"400":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create a user","tags":["admin"]}},"/admin/users/{username}":{"delete":{"operationId":"adminDeleteUser","parameters":[{"description":"username of user to delete","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"purge the user from the system completely","in":"query","name":"purge","schema":{"type":"boolean"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Delete a user","tags":["admin"]},"patch":{"operationId":"adminEditUser","parameters":[{"description":"username of user to edit","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditUserOption"}}}},"responses":{"200":{"$ref":"#/components/responses/User"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Edit an existing user","tags":["admin"]}},"/admin/users/{username}/keys":{"post":{"operationId":"adminCreatePublicKey","parameters":[{"description":"username of the user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateKeyOption"},"responses":{"201":{"$ref":"#/components/responses/PublicKey"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Add a public key on behalf of a user","tags":["admin"]}},"/admin/users/{username}/keys/{id}":{"delete":{"operationId":"adminDeleteUserPublicKey","parameters":[{"description":"username of user","in":"path","name":"username","required":true,"schema":{"type":"string"}},{"description":"id of the key to delete","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Delete a user's public key","tags":["admin"]}},"/admin/users/{username}/orgs":{"post":{"operationId":"adminCreateOrg","parameters":[{"description":"username of the user that will own the created organization","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateOrgOption"},"responses":{"201":{"$ref":"#/components/responses/Organization"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create an organization","tags":["admin"]}},"/admin/users/{username}/rename":{"post":{"operationId":"adminRenameUser","parameters":[{"description":"existing username of user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameUserOption"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RenameUserOption"}}},"required":true},"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Rename a user","tags":["admin"]}},"/admin/users/{username}/repos":{"post":{"operationId":"adminCreateRepo","parameters":[{"description":"username of the user. This user will own the created repository","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRepoOption"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/Repository"},"400":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"},"409":{"$ref":"#/components/responses/error"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create a repository on behalf of a user","tags":["admin"]}},"/amdin/hooks/{id}":{"delete":{"operationId":"adminDeleteHook","parameters":[{"description":"id of the hook to delete","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"$ref":"#/components/responses/empty"}},"summary":"Delete a hook","tags":["admin"]}},"/markdown":{"post":{"operationId":"renderMarkdown","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkdownOption"}}}},"responses":{"200":{"$ref":"#/components/responses/MarkdownRender"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Render a markdown document as HTML","tags":["miscellaneous"]}},"/markdown/raw":{"post":{"operationId":"renderMarkdownRaw","requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"Request body to render","required":true},"responses":{"200":{"$ref":"#/components/responses/MarkdownRender"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Render raw markdown as HTML","tags":["miscellaneous"]}},"/markup":{"post":{"operationId":"renderMarkup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkupOption"}}}},"responses":{"200":{"$ref":"#/components/responses/MarkupRender"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Render a markup document as HTML","tags":["miscellaneous"]}},"/nodeinfo":{"get":{"operationId":"getNodeInfo","responses":{"200":{"$ref":"#/components/responses/NodeInfo"}},"summary":"Returns the nodeinfo of the Gitea application","tags":["miscellaneous"]}},"/notifications":{"get":{"operationId":"notifyGetList","parameters":[{"description":"If true, show notifications marked as read. Default value is false","in":"query","name":"all","schema":{"type":"boolean"}},{"description":"Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned.","explode":true,"in":"query","name":"status-types","schema":{"items":{"type":"string"},"type":"array"}},{"description":"filter notifications by subject type","explode":true,"in":"query","name":"subject-type","schema":{"items":{"enum":["issue","pull","commit","repository"],"type":"string"},"type":"array"}},{"description":"Only show notifications updated after the given time. This is a timestamp in RFC 3339 format","in":"query","name":"since","schema":{"format":"date-time","type":"string"}},{"description":"Only show notifications updated before the given time. This is a timestamp in RFC 3339 format","in":"query","name":"before","schema":{"format":"date-time","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/NotificationThreadList"}},"summary":"List users's notification threads","tags":["notification"]},"put":{"operationId":"notifyReadList","parameters":[{"description":"Describes the last point that notifications were checked. Anything updated since this time will not be updated.","in":"query","name":"last_read_at","schema":{"format":"date-time","type":"string"}},{"description":"If true, mark all notifications on this repo. Default value is false","in":"query","name":"all","schema":{"type":"string"}},{"description":"Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.","explode":true,"in":"query","name":"status-types","schema":{"items":{"type":"string"},"type":"array"}},{"description":"Status to mark notifications as, Defaults to read.","in":"query","name":"to-status","schema":{"type":"string"}}],"responses":{"205":{"$ref":"#/components/responses/NotificationThreadList"}},"summary":"Mark notification threads as read, pinned or unread","tags":["notification"]}},"/notifications/new":{"get":{"operationId":"notifyNewAvailable","responses":{"200":{"$ref":"#/components/responses/NotificationCount"}},"summary":"Check if unread notifications exist","tags":["notification"]}},"/notifications/threads/{id}":{"get":{"operationId":"notifyGetThread","parameters":[{"description":"id of notification thread","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/NotificationThread"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Get notification thread by ID","tags":["notification"]},"patch":{"operationId":"notifyReadThread","parameters":[{"description":"id of notification thread","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Status to mark notifications as","in":"query","name":"to-status","schema":{"default":"read","type":"string"}}],"responses":{"205":{"$ref":"#/components/responses/NotificationThread"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Mark notification thread as read by ID","tags":["notification"]}},"/org/{org}/repos":{"post":{"deprecated":true,"operationId":"createOrgRepoDeprecated","parameters":[{"description":"name of organization","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateRepoOption"},"responses":{"201":{"$ref":"#/components/responses/Repository"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create a repository in an organization","tags":["organization"]}},"/orgs":{"get":{"operationId":"orgGetAll","parameters":[{"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/OrganizationList"}},"summary":"Get list of organizations","tags":["organization"]},"post":{"operationId":"orgCreate","requestBody":{"$ref":"#/components/requestBodies/CreateOrgOption"},"responses":{"201":{"$ref":"#/components/responses/Organization"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create an organization","tags":["organization"]}},"/orgs/{org}":{"delete":{"operationId":"orgDelete","parameters":[{"description":"organization that is to be deleted","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"}},"summary":"Delete an organization","tags":["organization"]},"get":{"operationId":"orgGet","parameters":[{"description":"name of the organization to get","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Organization"}},"summary":"Get an organization","tags":["organization"]},"patch":{"operationId":"orgEdit","parameters":[{"description":"name of the organization to edit","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditOrgOption"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/Organization"}},"summary":"Edit an organization","tags":["organization"]}},"/orgs/{org}/activities/feeds":{"get":{"operationId":"orgListActivityFeeds","parameters":[{"description":"name of the org","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"the date of the activities to be found","in":"query","name":"date","schema":{"format":"date","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/ActivityFeedsList"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"List an organization's activity feeds","tags":["organization"]}},"/orgs/{org}/hooks":{"get":{"operationId":"orgListHooks","parameters":[{"description":"name of the organization","in":"path","name":"org","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/HookList"}},"summary":"List an organization's webhooks","tags":["organization"]},"post":{"operationId":"orgCreateHook","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateHookOption"},"responses":{"201":{"$ref":"#/components/responses/Hook"}},"summary":"Create a hook","tags":["organization"]}},"/orgs/{org}/hooks/{id}":{"delete":{"operationId":"orgDeleteHook","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"id of the hook to delete","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"$ref":"#/components/responses/empty"}},"summary":"Delete a hook","tags":["organization"]},"get":{"operationId":"orgGetHook","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"id of the hook to get","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Hook"}},"summary":"Get a hook","tags":["organization"]},"patch":{"operationId":"orgEditHook","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"id of the hook to update","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/EditHookOption"},"responses":{"200":{"$ref":"#/components/responses/Hook"}},"summary":"Update a hook","tags":["organization"]}},"/orgs/{org}/labels":{"get":{"operationId":"orgListLabels","parameters":[{"description":"name of the organization","in":"path","name":"org","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/LabelList"}},"summary":"List an organization's labels","tags":["organization"]},"post":{"operationId":"orgCreateLabel","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateLabelOption"},"responses":{"201":{"$ref":"#/components/responses/Label"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create a label for an organization","tags":["organization"]}},"/orgs/{org}/labels/{id}":{"delete":{"operationId":"orgDeleteLabel","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"id of the label to delete","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"$ref":"#/components/responses/empty"}},"summary":"Delete a label","tags":["organization"]},"get":{"operationId":"orgGetLabel","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"id of the label to get","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/Label"}},"summary":"Get a single label","tags":["organization"]},"patch":{"operationId":"orgEditLabel","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"id of the label to edit","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"$ref":"#/components/requestBodies/EditLabelOption"},"responses":{"200":{"$ref":"#/components/responses/Label"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Update a label","tags":["organization"]}},"/orgs/{org}/members":{"get":{"operationId":"orgListMembers","parameters":[{"description":"name of the organization","in":"path","name":"org","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/UserList"}},"summary":"List an organization's members","tags":["organization"]}},"/orgs/{org}/members/{username}":{"delete":{"operationId":"orgDeleteMember","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"username of the user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"member removed"}},"summary":"Remove a member from an organization","tags":["organization"]},"get":{"operationId":"orgIsMember","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"username of the user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"user is a member"},"303":{"description":"redirection to /orgs/{org}/public_members/{username}"},"404":{"description":"user is not a member"}},"summary":"Check if a user is a member of an organization","tags":["organization"]}},"/orgs/{org}/public_members":{"get":{"operationId":"orgListPublicMembers","parameters":[{"description":"name of the organization","in":"path","name":"org","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/UserList"}},"summary":"List an organization's public members","tags":["organization"]}},"/orgs/{org}/public_members/{username}":{"delete":{"operationId":"orgConcealMember","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"username of the user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"Conceal a user's membership","tags":["organization"]},"get":{"operationId":"orgIsPublicMember","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"username of the user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"user is a public member"},"404":{"description":"user is not a public member"}},"summary":"Check if a user is a public member of an organization","tags":["organization"]},"put":{"operationId":"orgPublicizeMember","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"username of the user","in":"path","name":"username","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"membership publicized"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"Publicize a user's membership","tags":["organization"]}},"/orgs/{org}/repos":{"get":{"operationId":"orgListRepos","parameters":[{"description":"name of the organization","in":"path","name":"org","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/RepositoryList"}},"summary":"List an organization's repos","tags":["organization"]},"post":{"operationId":"createOrgRepo","parameters":[{"description":"name of organization","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CreateRepoOption"},"responses":{"201":{"$ref":"#/components/responses/Repository"},"400":{"$ref":"#/components/responses/error"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Create a repository in an organization","tags":["organization"]}},"/orgs/{org}/teams":{"get":{"operationId":"orgListTeams","parameters":[{"description":"name of the organization","in":"path","name":"org","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/TeamList"}},"summary":"List an organization's teams","tags":["organization"]},"post":{"operationId":"orgCreateTeam","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTeamOption"}}}},"responses":{"201":{"$ref":"#/components/responses/Team"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create a team","tags":["organization"]}},"/orgs/{org}/teams/search":{"get":{"operationId":"teamSearch","parameters":[{"description":"name of the organization","in":"path","name":"org","required":true,"schema":{"type":"string"}},{"description":"keywords to search","in":"query","name":"q","schema":{"type":"string"}},{"description":"include search within team description (defaults to true)","in":"query","name":"include_desc","schema":{"type":"boolean"}},{"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":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"},"ok":{"type":"boolean"}},"type":"object"}}},"description":"SearchResults of a successful search"}},"summary":"Search for teams within an organization","tags":["organization"]}},"/packages/{owner}":{"get":{"operationId":"listPackages","parameters":[{"description":"owner of the packages","in":"path","name":"owner","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"}},{"description":"package type filter","in":"query","name":"type","schema":{"enum":["cargo","chef","composer","conan","conda","container","generic","helm","maven","npm","nuget","pub","pypi","rubygems","swift","vagrant"],"type":"string"}},{"description":"name filter","in":"query","name":"q","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/PackageList"}},"summary":"Gets all packages of an owner","tags":["package"]}},"/packages/{owner}/{type}/{name}/{version}":{"delete":{"operationId":"deletePackage","parameters":[{"description":"owner of the package","in":"path","name":"owner","required":true,"schema":{"type":"string"}},{"description":"type of the package","in":"path","name":"type","required":true,"schema":{"type":"string"}},{"description":"name of the package","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"version of the package","in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Delete a package","tags":["package"]},"get":{"operationId":"getPackage","parameters":[{"description":"owner of the package","in":"path","name":"owner","required":true,"schema":{"type":"string"}},{"description":"type of the package","in":"path","name":"type","required":true,"schema":{"type":"string"}},{"description":"name of the package","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"version of the package","in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Package"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Gets a package","tags":["package"]}},"/packages/{owner}/{type}/{name}/{version}/files":{"get":{"operationId":"listPackageFiles","parameters":[{"description":"owner of the package","in":"path","name":"owner","required":true,"schema":{"type":"string"}},{"description":"type of the package","in":"path","name":"type","required":true,"schema":{"type":"string"}},{"description":"name of the package","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"version of the package","in":"path","name":"version","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/PackageFileList"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Gets all files of a package","tags":["package"]}},"/repos/issues/search":{"get":{"operationId":"issueSearchIssues","parameters":[{"description":"whether issue is open or closed","in":"query","name":"state","schema":{"type":"string"}},{"description":"comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded","in":"query","name":"labels","schema":{"type":"string"}},{"description":"comma separated list of milestone names. Fetch only issues that have any of this milestones. Non existent are discarded","in":"query","name":"milestones","schema":{"type":"string"}},{"description":"search string","in":"query","name":"q","schema":{"type":"string"}},{"description":"repository to prioritize in the results","in":"query","name":"priority_repo_id","schema":{"format":"int64","type":"integer"}},{"description":"filter by type (issues / pulls) if set","in":"query","name":"type","schema":{"type":"string"}},{"description":"Only show notifications updated after the given time. This is a timestamp in RFC 3339 format","in":"query","name":"since","schema":{"format":"date-time","type":"string"}},{"description":"Only show notifications updated before the given time. This is a timestamp in RFC 3339 format","in":"query","name":"before","schema":{"format":"date-time","type":"string"}},{"description":"filter (issues / pulls) assigned to you, default is false","in":"query","name":"assigned","schema":{"type":"boolean"}},{"description":"filter (issues / pulls) created by you, default is false","in":"query","name":"created","schema":{"type":"boolean"}},{"description":"filter (issues / pulls) mentioning you, default is false","in":"query","name":"mentioned","schema":{"type":"boolean"}},{"description":"filter pulls requesting your review, default is false","in":"query","name":"review_requested","schema":{"type":"boolean"}},{"description":"filter pulls reviewed by you, default is false","in":"query","name":"reviewed","schema":{"type":"boolean"}},{"description":"filter by owner","in":"query","name":"owner","schema":{"type":"string"}},{"description":"filter by team (requires organization owner parameter to be provided)","in":"query","name":"team","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/IssueList"}},"summary":"Search for issues across the repositories that the user has access to","tags":["issue"]}},"/repos/migrate":{"post":{"operationId":"repoMigrate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MigrateRepoOptions"}}}},"responses":{"201":{"$ref":"#/components/responses/Repository"},"403":{"$ref":"#/components/responses/forbidden"},"409":{"description":"The repository with the same name already exists."},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Migrate a remote git repository","tags":["repository"]}},"/repos/search":{"get":{"operationId":"repoSearch","parameters":[{"description":"keyword","in":"query","name":"q","schema":{"type":"string"}},{"description":"Limit search to repositories with keyword as topic","in":"query","name":"topic","schema":{"type":"boolean"}},{"description":"include search of keyword within repository description","in":"query","name":"includeDesc","schema":{"type":"boolean"}},{"description":"search only for repos that the user with the given id owns or contributes to","in":"query","name":"uid","schema":{"format":"int64","type":"integer"}},{"description":"repo owner to prioritize in the results","in":"query","name":"priority_owner_id","schema":{"format":"int64","type":"integer"}},{"description":"search only for repos that belong to the given team id","in":"query","name":"team_id","schema":{"format":"int64","type":"integer"}},{"description":"search only for repos that the user with the given id has starred","in":"query","name":"starredBy","schema":{"format":"int64","type":"integer"}},{"description":"include private repositories this user has access to (defaults to true)","in":"query","name":"private","schema":{"type":"boolean"}},{"description":"show only pubic, private or all repositories (defaults to all)","in":"query","name":"is_private","schema":{"type":"boolean"}},{"description":"include template repositories this user has access to (defaults to true)","in":"query","name":"template","schema":{"type":"boolean"}},{"description":"show only archived, non-archived or all repositories (defaults to all)","in":"query","name":"archived","schema":{"type":"boolean"}},{"description":"type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"","in":"query","name":"mode","schema":{"type":"string"}},{"description":"if `uid` is given, search only for repos that the user owns","in":"query","name":"exclusive","schema":{"type":"boolean"}},{"description":"sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"","in":"query","name":"sort","schema":{"type":"string"}},{"description":"sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.","in":"query","name":"order","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/SearchResults"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Search for repositories","tags":["repository"]}},"/repos/{owner}/{repo}":{"delete":{"operationId":"repoDelete","parameters":[{"description":"owner of the repo to delete","in":"path","name":"owner","required":true,"schema":{"type":"string"}},{"description":"name of the repo to delete","in":"path","name":"repo","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/forbidden"}},"summary":"Delete a repository","tags":["repository"]},"get":{"operationId":"repoGet","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"}}],"responses":{"200":{"$ref":"#/components/responses/Repository"}},"summary":"Get a repository","tags":["repository"]},"patch":{"operationId":"repoEdit","parameters":[{"description":"owner of the repo to edit","in":"path","name":"owner","required":true,"schema":{"type":"string"}},{"description":"name of the repo to edit","in":"path","name":"repo","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRepoOption"}},"text/plain":{"schema":{"$ref":"#/components/schemas/EditRepoOption"}}},"description":"Properties of a repo that you can edit"},"responses":{"200":{"$ref":"#/components/responses/Repository"},"403":{"$ref":"#/components/responses/forbidden"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Edit a repository's properties. Only fields that are set will be changed.","tags":["repository"]}},"/repos/{owner}/{repo}/activities/feeds":{"get":{"operationId":"repoListActivityFeeds","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":"the date of the activities to be found","in":"query","name":"date","schema":{"format":"date","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/ActivityFeedsList"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"List a repository's activity feeds","tags":["repository"]}},"/repos/{owner}/{repo}/archive/{archive}":{"get":{"operationId":"repoGetArchive","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":"the git reference for download with attached archive format (e.g. master.zip)","in":"path","name":"archive","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"success"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Get an archive of a repository","tags":["repository"]}},"/repos/{owner}/{repo}/assignees":{"get":{"operationId":"repoGetAssignees","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"}}],"responses":{"200":{"$ref":"#/components/responses/UserList"}},"summary":"Return all users that have write access and can be assigned to issues","tags":["repository"]}},"/repos/{owner}/{repo}/branch_protections":{"get":{"operationId":"repoListBranchProtection","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"}}],"responses":{"200":{"$ref":"#/components/responses/BranchProtectionList"}},"summary":"List branch protections for a repository","tags":["repository"]},"post":{"operationId":"repoCreateBranchProtection","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchProtectionOption"}}}},"responses":{"201":{"$ref":"#/components/responses/BranchProtection"},"403":{"$ref":"#/components/responses/forbidden"},"404":{"$ref":"#/components/responses/notFound"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Create a branch protections for a repository","tags":["repository"]}},"/repos/{owner}/{repo}/branch_protections/{name}":{"delete":{"operationId":"repoDeleteBranchProtection","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":"name of protected branch","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Delete a specific branch protection for the repository","tags":["repository"]},"get":{"operationId":"repoGetBranchProtection","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":"name of protected branch","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/BranchProtection"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Get a specific branch protection for the repository","tags":["repository"]},"patch":{"operationId":"repoEditBranchProtection","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":"name of protected branch","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditBranchProtectionOption"}}}},"responses":{"200":{"$ref":"#/components/responses/BranchProtection"},"404":{"$ref":"#/components/responses/notFound"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Edit a branch protections for a repository. Only fields that are set will be changed","tags":["repository"]}},"/repos/{owner}/{repo}/branches":{"get":{"operationId":"repoListBranches","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":"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/BranchList"}},"summary":"List a repository's branches","tags":["repository"]},"post":{"operationId":"repoCreateBranch","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"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchRepoOption"}}}},"responses":{"201":{"$ref":"#/components/responses/Branch"},"404":{"description":"The old branch does not exist."},"409":{"description":"The branch with the same name already exists."}},"summary":"Create a branch","tags":["repository"]}},"/repos/{owner}/{repo}/branches/{branch}":{"delete":{"operationId":"repoDeleteBranch","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":"branch to delete","in":"path","name":"branch","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"403":{"$ref":"#/components/responses/error"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Delete a specific branch from a repository","tags":["repository"]},"get":{"operationId":"repoGetBranch","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":"branch to get","in":"path","name":"branch","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/Branch"},"404":{"$ref":"#/components/responses/notFound"}},"summary":"Retrieve a specific branch from a repository, including its effective branch protection","tags":["repository"]}},"/repos/{owner}/{repo}/collaborators":{"get":{"operationId":"repoListCollaborators","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":"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/UserList"}},"summary":"List a repository's collaborators","tags":["repository"]}},"/repos/{owner}/{repo}/collaborators/{collaborator}":{"delete":{"operationId":"repoDeleteCollaborator","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":"username of the collaborator to delete","in":"path","name":"collaborator","required":true,"schema":{"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/empty"},"422":{"$ref":"#/components/responses/validationError"}},"summary":"Delete a collaborator from a repository","tags":["repository"]},"get":{"operationId":"repoCheckCollaborator","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":"us