v1

Documentation

Overview

Package v1 Gitea API

This documentation describes the Gitea API.

Schemes: https, http
BasePath: /api/v1
Version: {{AppVer | JSEscape}}
License: MIT http://opensource.org/licenses/MIT

Consumes:
- application/json
- text/plain

Produces:
- application/json
- text/html

Security:
- BasicAuth :
- Token :
- AccessToken :
- AuthorizationHeaderToken :
- SudoParam :
- SudoHeader :
- TOTPHeader :

SecurityDefinitions:
BasicAuth:
     type: basic
Token:
     type: apiKey
     name: token
     in: query
     description: This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.
AccessToken:
     type: apiKey
     name: access_token
     in: query
     description: This authentication option is deprecated for removal in Gitea 1.23. Please use AuthorizationHeaderToken instead.
AuthorizationHeaderToken:
     type: apiKey
     name: Authorization
     in: header
     description: API tokens must be prepended with "token" followed by a space.
SudoParam:
     type: apiKey
     name: sudo
     in: query
     description: Sudo API request as the user provided as the key. Admin privileges are required.
SudoHeader:
     type: apiKey
     name: Sudo
     in: header
     description: Sudo API request as the user provided as the key. Admin privileges are required.
TOTPHeader:
     type: apiKey
     name: X-GITEA-OTP
     in: header
     description: Must be used in combination with BasicAuth if two-factor authentication is enabled.

swagger:meta

Index

• func Routes() *web.Route

Functions

func Routes

func Routes() *web.Route

Routes registers all v1 APIs routes to web application.