Overview

Swagger Specification Management APIs.

Version information

Version : 0.8.0

Contact information

Contact : suwa-sh
Contact Email : suwash01@gmail.com

License information

License : Apache 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service : null

URI scheme

Host : localhost:8081
BasePath : /

Tags

  • branches-api-controller : Git Branch Management API

  • environment-mvc-endpoint : Environment Mvc Endpoint

  • specs-api-controller : Swagger Specification Management API

  • tags-api-controller : Git Tag Management API

  • users-api-controller : Commit User Management API

Paths

/branches GET

GET /branches

Description

Returns all branches

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Responses

HTTP Code Description Schema

200

successful operation

BranchListApiModelGen

401

Unauthorized

No Content

403

Forbidden

No Content

404

Branch not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • branches-api-controller

/branches/{branch} POST

POST /branches/{branch}

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

branch
required

ID of branch that needs to be add

string

Query

object
required

the SHA of the git object this is branching

string

Responses

HTTP Code Description Schema

200

OK

BranchesApiModelGen

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

Invalid input

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • branches-api-controller

/branches/{branch} GET

GET /branches/{branch}

Description

Returns a single branch

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

branch
required

ID of branch to return

string

Responses

HTTP Code Description Schema

200

successful operation

BranchesApiModelGen

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Branch not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • branches-api-controller

/branches/{branch} PUT

PUT /branches/{branch}

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

branch
required

target ID of branch that needs to be update

string

Query

to
required

new ID of branch that needs to be update

string

Responses

HTTP Code Description Schema

200

OK

BranchesApiModelGen

201

Created

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

branch not found

No Content

405

Validation exception

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • branches-api-controller

/branches/{branch} DELETE

DELETE /branches/{branch}

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

branch
required

ID of branch to delete

string

Responses

HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Branch not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • branches-api-controller

invoke

GET /env

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • environment-mvc-endpoint

/merges POST

POST /merges

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Query

source
required

source ID of branch that needs to be merge

string

Query

target
required

target ID of branch that needs to be merge

string

Responses

HTTP Code Description Schema

200

OK

BranchesApiModelGen

201

Created

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

branch not found

No Content

405

Validation exception

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • branches-api-controller

/specs GET

GET /specs

Description

Returns all specifications

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Responses

HTTP Code Description Schema

200

successful operation

IdListApiModelGen

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specification not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • specs-api-controller

/specs/{specId} POST

POST /specs/{specId}

Parameters

Type Name Description Schema

Header

X-Commit-Message
optional

message for commit

string

Header

X-Commit-User
optional

user name for commit

string

Path

specId
required

ID of specification that needs to be add

string

Body

payload
required

Specification object that needs to be add

object

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

400

Invalid input

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

  • application/x-yaml

Produces

  • application/x-yaml

Tags

  • specs-api-controller

/specs/{specId} GET

GET /specs/{specId}

Description

Returns a single specification

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

specId
required

ID of specification to return

string

Responses

HTTP Code Description Schema

200

successful operation

object

400

Invalid input

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specification not found

No Content

Consumes

  • application/json

Produces

  • application/x-yaml

Tags

  • specs-api-controller

/specs/{specId} PUT

PUT /specs/{specId}

Parameters

Type Name Description Schema

Header

X-Commit-Message
optional

message for commit

string

Header

X-Commit-User
optional

user name for commit

string

Path

specId
required

ID of specification that needs to be update

string

Body

payload
required

Specification object that needs to be update

object

Responses

HTTP Code Description Schema

200

OK

object

201

Created

No Content

400

Invalid input

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specification not found

No Content

Consumes

  • application/json

  • application/x-yaml

Produces

  • application/x-yaml

Tags

  • specs-api-controller

/specs/{specId} DELETE

DELETE /specs/{specId}

Parameters

Type Name Description Schema

Header

X-Commit-Message
optional

message for commit

string

Header

X-Commit-User
optional

user name for commit

string

Path

specId
required

ID of specification to delete

string

Responses

HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Invalid input

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Specification not found

No Content

Consumes

  • application/json

Produces

  • application/x-yaml

Tags

  • specs-api-controller

/switch/{branch} POST

POST /switch/{branch}

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

branch
required

ID of branch to switch

string

Responses

HTTP Code Description Schema

200

OK

BranchesApiModelGen

201

Created

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Branch not found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • branches-api-controller

/tags GET

GET /tags

Description

Returns all tags

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Responses

HTTP Code Description Schema

200

successful operation

IdListApiModelGen

401

Unauthorized

No Content

403

Forbidden

No Content

404

Tag not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • tags-api-controller

/tags/{tag} POST

POST /tags/{tag}

Parameters

Type Name Description Schema

Header

X-Commit-Message
optional

message for tag

string

Header

X-Commit-User
optional

user name for commit

string

Path

tag
required

ID of tag that needs to be add

string

Query

object
required

the SHA of the git object this is tagging

string

Responses

HTTP Code Description Schema

200

OK

TagsApiModelGen

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

Invalid input

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • tags-api-controller

/tags/{tag} GET

GET /tags/{tag}

Description

Returns a single tag

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

tag
required

ID of tag to return

string

Responses

HTTP Code Description Schema

200

successful operation

TagsApiModelGen

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Tag not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • tags-api-controller

/tags/{tag} PUT

PUT /tags/{tag}

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

tag
required

target ID of tag that needs to be update

string

Query

to
required

new ID of tag that needs to be update

string

Responses

HTTP Code Description Schema

200

OK

TagsApiModelGen

201

Created

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Tag not found

No Content

405

Validation exception

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • tags-api-controller

/tags/{tag} DELETE

DELETE /tags/{tag}

Parameters

Type Name Description Schema

Header

X-Commit-User
optional

user name for commit

string

Path

tag
required

ID of tag to delete

string

Responses

HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Tag not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • tags-api-controller

/users POST

POST /users

Description

Add a default user

Responses

HTTP Code Description Schema

200

OK

UsersApiModelGen

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

Invalid input

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • users-api-controller

/users GET

GET /users

Description

Returns all users

Responses

HTTP Code Description Schema

200

successful operation

IdListApiModelGen

401

Unauthorized

No Content

403

Forbidden

No Content

404

Tag not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • users-api-controller

/users{userId} POST

POST /users/{userId}

Parameters

Type Name Description Schema

Path

userId
required

user name for commit

string

Query

email
required

email address for commit

string

Responses

HTTP Code Description Schema

200

OK

UsersApiModelGen

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

405

Invalid input

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • users-api-controller

/users{userId} GET

GET /users/{userId}

Description

Returns a single user

Parameters

Type Name Description Schema

Path

userId
required

user name for commit

string

Responses

HTTP Code Description Schema

200

successful operation

UsersApiModelGen

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

User not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • users-api-controller

/users{userId} DELETE

DELETE /users/{userId}

Parameters

Type Name Description Schema

Path

userId
required

user name for commit

string

Responses

HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Invalid ID supplied

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

User not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • users-api-controller

Definitions

BranchListApiModelGen

Name Schema

current
optional

string

idList
optional

< string > array

BranchesApiModelGen

Name Schema

id
optional

string

IdListApiModelGen

Name Schema

idList
optional

< string > array

TagsApiModelGen

Name Schema

id
optional

string

UsersApiModelGen

Name Schema

id
optional

string