개요

pipeline CRUD와 관련된 api 명세

PATH

{api 경로(메인페이지에서 명시)}/pipeline/{api name}

createPipeline

methods: POST

1. requests

{ // json
	"pipeline_name":string // pipeline에 붙일 이름
	"repo_url":string, // 검사할 code들이 있는 github url
	"jenkinsfile_path":string, // 해당 pipeline이 사용하는 jenkins파일 위치
	"owner_id":int // 사용자의 id값을 받도록 되어 있으나, 로그인 기능을 만들고 나면 변경 예정
}

2. response

{
	"msg": "create user success",
	"status": 201,
	"result": ""
}

3. error response

<하나라도 빈 값을 request했을 경우>
{
	"msg": "check your values"
	"status": 400
	"result": ""
}

<user table에 없는 user일 경우> // 추후 리펙토링 예정
{
	"msg": "create pipeline failed",
	"status": 400,
	"result": ""
}

<Exception이 발생했을 경우>
{
	"msg": "user create failed"
	"status": 500
	"result": ""
}

4. example

<request>
[POST]IP:PORT/api/v1/pipeline/createPipeline
{ // json
	"repo_url": "<https://github.com/nebulayoon/TEST-flask>",
	"jenkinsfile_path": "./jenkins_files/jenkinsfile_1",
	"owner_id": 1
}

<response>
-

pipelineList

methods: GET

1. requests

-

2. response