@ -20,45 +20,40 @@ import (
"code.gitea.io/gitea/routers/api/v1/convert" "code.gitea.io/gitea/routers/api/v1/convert"
) )
// SearchRepoOption options when searching repositories
// swagger:parameters repoSearch
type SearchRepoOption struct { // TODO: Move SearchRepoOption to Gitea SDK
// Keyword to search
//
// in: query
Keyword string ` json:"q" `
// Repository owner to search
//
// in: query
OwnerID int64 ` json:"uid" `
// Limit of result
//
// maximum: setting.ExplorePagingNum
// in: query
PageSize int ` json:"limit" `
// Type of repository to search, related to owner
//
// in: query
SearchMode string ` json:"mode" `
// Search only owners repositories
// Has effect only if owner is provided and mode is not "collaborative"
//
// in: query
OwnerExclusive bool ` json:"exclusive" `
}
// Search repositories via options
// Search repositories via options
func Search ( ctx * context . APIContext ) { func Search ( ctx * context . APIContext ) {
// swagger:route GET /repos/search repository repoSearch
// swagger:operation GET /repos/search repository repoSearch
//
// ---
// Produces:
// summary: Search for repositories
// - application/json
// produces:
//
// - application/json
// Responses:
// parameters:
// 200: SearchResults
// - name: q
// 422: validationError
// in: query
// 500: SearchError
// description: keyword
// type: string
// - name: uid
// in: query
// description: if provided, will return only repos owned by the user with the given id
// type: integer
// - name: limit
// in: query
// description: maximum number of repos to return
// type: integer
// - name: mode
// in: query
// description: type of repository to search for. Supported values are
// "fork", "source", "mirror" and "collaborative"
// type: string
// - name: exclusive
// in: query
// description: only search for repositories owned by the authenticated user
// type: boolean
// responses:
// "200":
// "$ref": "#/responses/SearchResults"
// "422":
// "$ref": "#/responses/validationError"
opts := & models . SearchRepoOptions { opts := & models . SearchRepoOptions {
Keyword : strings . Trim ( ctx . Query ( "q" ) , " " ) , Keyword : strings . Trim ( ctx . Query ( "q" ) , " " ) ,
OwnerID : ctx . QueryInt64 ( "uid" ) , OwnerID : ctx . QueryInt64 ( "uid" ) ,
@ -187,22 +182,23 @@ func CreateUserRepo(ctx *context.APIContext, owner *models.User, opt api.CreateR
// Create one repository of mine
// Create one repository of mine
func Create ( ctx * context . APIContext , opt api . CreateRepoOption ) { func Create ( ctx * context . APIContext , opt api . CreateRepoOption ) {
// swagger:route POST /user/repos repository user createCurrentUserRepo
// swagger:operation POST /user/repos repository user createCurrentUserRepo
//
// ---
// Consumes:
// summary: Create a repository
// - application/json
// consumes:
//
// - application/json
// P roduces:
// p roduces:
// - application/json
// - application/json
//
// parameters:
// Responses:
// - name: body
// 201: Repositor y
// in: bod y
// 403: forbidden
// schema:
// 422: validationError
// "$ref": "#/definitions/CreateRepoOption"
// 500: error
// responses:
// "201":
// Shouldn't reach this condition, but just in case.
// "$ref": "#/responses/Repository"
if ctx . User . IsOrganization ( ) { if ctx . User . IsOrganization ( ) {
// Shouldn't reach this condition, but just in case.
ctx . Error ( 422 , "" , "not allowed creating repository for organization" ) ctx . Error ( 422 , "" , "not allowed creating repository for organization" )
return return
} }
@ -211,20 +207,30 @@ func Create(ctx *context.APIContext, opt api.CreateRepoOption) {
// CreateOrgRepo create one repository of the organization
// CreateOrgRepo create one repository of the organization
func CreateOrgRepo ( ctx * context . APIContext , opt api . CreateRepoOption ) { func CreateOrgRepo ( ctx * context . APIContext , opt api . CreateRepoOption ) {
// swagger:route POST /org/{org}/repos organization createOrgRepo
// swagger:operation POST /org/{org}/repos organization createOrgRepo
//
// ---
// Consumes:
// summary: Create a repository in an organization
// - application/json
// consumes:
//
// - application/json
// Produces:
// produces:
// - application/json
// - application/json
//
// parameters:
// Responses:
// - name: org
// 201: Repository
// in: path
// 422: validationError
// description: name of organization
// 403: forbidden
// type: string
// 500: error
// required: true
// - name: body
// in: body
// schema:
// "$ref": "#/definitions/CreateRepoOption"
// responses:
// "201":
// "$ref": "#/responses/Repository"
// "422":
// "$ref": "#/responses/validationError"
// "403":
// "$ref": "#/responses/forbidden"
org , err := models . GetOrgByName ( ctx . Params ( ":org" ) ) org , err := models . GetOrgByName ( ctx . Params ( ":org" ) )
if err != nil { if err != nil {
if models . IsErrOrgNotExist ( err ) { if models . IsErrOrgNotExist ( err ) {
@ -244,19 +250,21 @@ func CreateOrgRepo(ctx *context.APIContext, opt api.CreateRepoOption) {
// Migrate migrate remote git repository to gitea
// Migrate migrate remote git repository to gitea
func Migrate ( ctx * context . APIContext , form auth . MigrateRepoForm ) { func Migrate ( ctx * context . APIContext , form auth . MigrateRepoForm ) {
// swagger:route POST /repos/migrate repository repoMigrate
// swagger:operation POST /repos/migrate repository repoMigrate
//
// ---
// Consumes:
// summary: Migrate a remote git repository
// - application/json
// consumes:
//
// - application/json
// Produces:
// produces:
// - application/json
// - application/json
//
// parameters:
// Responses:
// - name: body
// 201: Repository
// in: body
// 422: validationError
// schema:
// 500: error
// "$ref": "#/definitions/MigrateRepoForm"
// responses:
// "201":
// "$ref": "#/responses/Repository"
ctxUser := ctx . User ctxUser := ctx . User
// Not equal means context user is an organization,
// Not equal means context user is an organization,
// or is another user/organization if current user is admin.
// or is another user/organization if current user is admin.
@ -329,29 +337,44 @@ func Migrate(ctx *context.APIContext, form auth.MigrateRepoForm) {
// Get one repository
// Get one repository
func Get ( ctx * context . APIContext ) { func Get ( ctx * context . APIContext ) {
// swagger:route GET /repos/{username}/{reponame} repository repoGet
// swagger:operation GET /repos/{owner}/{repo} repository repoGet
//
// ---
// Produces:
// summary: Get a repository
// - application/json
// produces:
//
// - application/json
// Responses:
// parameters:
// 200: Repository
// - name: owner
// 500: error
// in: path
// description: owner of the repo
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/Repository"
ctx . JSON ( 200 , ctx . Repo . Repository . APIFormat ( ctx . Repo . AccessMode ) ) ctx . JSON ( 200 , ctx . Repo . Repository . APIFormat ( ctx . Repo . AccessMode ) )
} }
// GetByID returns a single Repository
// GetByID returns a single Repository
func GetByID ( ctx * context . APIContext ) { func GetByID ( ctx * context . APIContext ) {
// swagger:route GET /repositories/{id} repository repoGetByID
// swagger:operation GET /repositories/{id} repository repoGetByID
//
// ---
// Produces:
// summary: Get a repository by id
// - application/json
// produces:
//
// - application/json
// Responses:
// parameters:
// 200: Repository
// - name: id
// 500: error
// in: path
// description: id of the repo to get
// type: integer
// required: true
// responses:
// "200":
// "$ref": "#/responses/Repository"
repo , err := models . GetRepositoryByID ( ctx . ParamsInt64 ( ":id" ) ) repo , err := models . GetRepositoryByID ( ctx . ParamsInt64 ( ":id" ) )
if err != nil { if err != nil {
if models . IsErrRepoNotExist ( err ) { if models . IsErrRepoNotExist ( err ) {
@ -375,16 +398,27 @@ func GetByID(ctx *context.APIContext) {
// Delete one repository
// Delete one repository
func Delete ( ctx * context . APIContext ) { func Delete ( ctx * context . APIContext ) {
// swagger:route DELETE /repos/{username}/{reponame} repository repoDelete
// swagger:operation DELETE /repos/{owner}/{repo} repository repoDelete
//
// ---
// Produces:
// summary: Delete a repository
// - application/json
// produces:
//
// - application/json
// Responses:
// parameters:
// 204: empty
// - name: owner
// 403: forbidden
// in: path
// 500: error
// description: owner of the repo to delete
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo to delete
// type: string
// required: true
// responses:
// "204":
// "$ref": "#/responses/empty"
// "403":
// "$ref": "#/responses/forbidden"
if ! ctx . Repo . IsAdmin ( ) { if ! ctx . Repo . IsAdmin ( ) {
ctx . Error ( 403 , "" , "Must have admin rights" ) ctx . Error ( 403 , "" , "Must have admin rights" )
return return
@ -408,15 +442,25 @@ func Delete(ctx *context.APIContext) {
// MirrorSync adds a mirrored repository to the sync queue
// MirrorSync adds a mirrored repository to the sync queue
func MirrorSync ( ctx * context . APIContext ) { func MirrorSync ( ctx * context . APIContext ) {
// swagger:route POST /repos/{username}/{reponame}/mirror-sync repository repoMirrorSync
// swagger:operation POST /repos/{owner}/{repo}/mirror-sync repository repoMirrorSync
//
// ---
// Produces:
// summary: Sync a mirrored repository
// - application/json
// produces:
//
// - application/json
// Responses:
// parameters:
// 200: empty
// - name: owner
// 403: forbidden
// in: path
// description: owner of the repo to sync
// type: string
// required: true
// - name: repo
// in: path
// description: name of the repo to sync
// type: string
// required: true
// responses:
// "200":
// "$ref": "#/responses/empty"
repo := ctx . Repo . Repository repo := ctx . Repo . Repository
if ! ctx . Repo . IsWriter ( ) { if ! ctx . Repo . IsWriter ( ) {
Ethan Koenig
7 years ago
committed by
Lauris BH