api

Documentation

Overview

Package api Pipeliner API.

This documentation describes the Pipeliner API.

Schemes: http, https
BasePath: /v1
Version: 1.0.0
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
AccessToken:
     type: apiKey
     name: access_token
     in: query
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 NewServer(ctx context.Context, db *gorm.DB, port int, cookieSecret string, ...) *apiServer

Functions

func NewServer

func NewServer(
	ctx context.Context,
	db *gorm.DB,
	port int,
	cookieSecret string,
	storage *store.Uploader,
	cP *controllers.Pipelines,
	cB *controllers.Builds,
	nP chan *models.Pipeline,
	nB chan *models.Pipeline,
	notifyDatabaseChange chan []byte,
) *apiServer

NewServer --