Added docs for the tree api (#5834)
* Added docs for the tree api * Added missing response definition * Fixed swagger docs
This commit is contained in:
parent
62da3bee1a
commit
9a137faaaf
3 changed files with 135 additions and 0 deletions
|
@ -16,6 +16,30 @@ import (
|
|||
|
||||
// GetTree get the tree of a repository.
|
||||
func GetTree(ctx *context.APIContext) {
|
||||
// swagger:operation GET /repos/{owner}/{repo}/git/trees/{sha} repository GetTree
|
||||
// ---
|
||||
// summary: Gets the tree of a repository.
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: name of the repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: sha
|
||||
// in: path
|
||||
// description: sha of the commit
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/GitTreeResponse"
|
||||
sha := ctx.Params("sha")
|
||||
if len(sha) == 0 {
|
||||
ctx.Error(400, "sha not provided", nil)
|
||||
|
|
|
@ -133,3 +133,10 @@ type swaggerResponseAttachment struct {
|
|||
//in: body
|
||||
Body api.Attachment `json:"body"`
|
||||
}
|
||||
|
||||
// GitTreeResponse
|
||||
// swagger:response GitTreeResponse
|
||||
type swaggerGitTreeResponse struct {
|
||||
//in: body
|
||||
Body api.GitTreeResponse `json:"body"`
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue