Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jérome Perrin
gitlab-ce
Commits
0a11ab48
Commit
0a11ab48
authored
May 13, 2017
by
Shinya Maeda
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Reflect doc to api desc
parent
359b1761
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
20 deletions
+20
-20
lib/api/pipeline_schedules.rb
lib/api/pipeline_schedules.rb
+20
-20
No files found.
lib/api/pipeline_schedules.rb
View file @
0a11ab48
...
@@ -6,7 +6,7 @@ module API
...
@@ -6,7 +6,7 @@ module API
requires
:id
,
type:
String
,
desc:
'The ID of a project'
requires
:id
,
type:
String
,
desc:
'The ID of a project'
end
end
resource
:projects
,
requirements:
{
id:
%r{[^/]+}
}
do
resource
:projects
,
requirements:
{
id:
%r{[^/]+}
}
do
desc
'Get
pipeline_schedules list
'
do
desc
'Get
a list of pipeline schedules
'
do
success
Entities
::
PipelineSchedule
success
Entities
::
PipelineSchedule
end
end
params
do
params
do
...
@@ -21,11 +21,11 @@ module API
...
@@ -21,11 +21,11 @@ module API
present
paginate
(
pipeline_schedules
),
with:
Entities
::
PipelineSchedule
present
paginate
(
pipeline_schedules
),
with:
Entities
::
PipelineSchedule
end
end
desc
'Get
specific pipeline_schedule of a project
'
do
desc
'Get
a single pipeline schedule
'
do
success
Entities
::
PipelineSchedule
success
Entities
::
PipelineSchedule
end
end
params
do
params
do
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
_schedule ID
'
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
schedule id
'
end
end
get
':id/pipeline_schedules/:pipeline_schedule_id'
do
get
':id/pipeline_schedules/:pipeline_schedule_id'
do
authenticate!
authenticate!
...
@@ -37,15 +37,15 @@ module API
...
@@ -37,15 +37,15 @@ module API
present
pipeline_schedule
,
with:
Entities
::
PipelineSchedule
present
pipeline_schedule
,
with:
Entities
::
PipelineSchedule
end
end
desc
'Create
a pipeline_
schedule'
do
desc
'Create
s a new pipeline
schedule'
do
success
Entities
::
PipelineSchedule
success
Entities
::
PipelineSchedule
end
end
params
do
params
do
requires
:description
,
type:
String
,
desc:
'The
pipeline_schedule description
'
requires
:description
,
type:
String
,
desc:
'The
description of pipeline schedule
'
requires
:ref
,
type:
String
,
desc:
'The
pipeline_schedule ref
'
requires
:ref
,
type:
String
,
desc:
'The
branch/tag name will be triggered
'
requires
:cron
,
type:
String
,
desc:
'The
pipeline_schedule
cron'
requires
:cron
,
type:
String
,
desc:
'The cron'
requires
:cron_timezone
,
type:
String
,
desc:
'The
pipeline_schedule cron_
timezone'
requires
:cron_timezone
,
type:
String
,
desc:
'The timezone'
requires
:active
,
type:
Boolean
,
desc:
'The
pipeline_schedule activ
e'
requires
:active
,
type:
Boolean
,
desc:
'The
activation of pipeline schedul
e'
end
end
post
':id/pipeline_schedules'
do
post
':id/pipeline_schedules'
do
authenticate!
authenticate!
...
@@ -61,16 +61,16 @@ module API
...
@@ -61,16 +61,16 @@ module API
end
end
end
end
desc
'Update
a pipeline_
schedule'
do
desc
'Update
s an existing pipeline
schedule'
do
success
Entities
::
PipelineSchedule
success
Entities
::
PipelineSchedule
end
end
params
do
params
do
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
_schedule ID
'
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
schedule id
'
optional
:description
,
type:
String
,
desc:
'The
pipeline_schedule description
'
optional
:description
,
type:
String
,
desc:
'The
description of pipeline schedule
'
optional
:ref
,
type:
String
,
desc:
'The
pipeline_schedule ref
'
optional
:ref
,
type:
String
,
desc:
'The
branch/tag name will be triggered
'
optional
:cron
,
type:
String
,
desc:
'The
pipeline_schedule
cron'
optional
:cron
,
type:
String
,
desc:
'The cron'
optional
:cron_timezone
,
type:
String
,
desc:
'The
pipeline_schedule cron_
timezone'
optional
:cron_timezone
,
type:
String
,
desc:
'The timezone'
optional
:active
,
type:
Boolean
,
desc:
'The
pipeline_schedule activ
e'
optional
:active
,
type:
Boolean
,
desc:
'The
activation of pipeline schedul
e'
end
end
put
':id/pipeline_schedules/:pipeline_schedule_id'
do
put
':id/pipeline_schedules/:pipeline_schedule_id'
do
authenticate!
authenticate!
...
@@ -86,11 +86,11 @@ module API
...
@@ -86,11 +86,11 @@ module API
end
end
end
end
desc
'
Take ownership of pipeline_
schedule'
do
desc
'
Update an owner of a pipeline
schedule'
do
success
Entities
::
PipelineSchedule
success
Entities
::
PipelineSchedule
end
end
params
do
params
do
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
_schedule ID
'
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
schedule id
'
end
end
post
':id/pipeline_schedules/:pipeline_schedule_id/take_ownership'
do
post
':id/pipeline_schedules/:pipeline_schedule_id/take_ownership'
do
authenticate!
authenticate!
...
@@ -107,11 +107,11 @@ module API
...
@@ -107,11 +107,11 @@ module API
end
end
end
end
desc
'Delete a pipeline
_
schedule'
do
desc
'Delete a pipeline
schedule'
do
success
Entities
::
PipelineSchedule
success
Entities
::
PipelineSchedule
end
end
params
do
params
do
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
_schedule ID
'
requires
:pipeline_schedule_id
,
type:
Integer
,
desc:
'The pipeline
schedule id
'
end
end
delete
':id/pipeline_schedules/:pipeline_schedule_id'
do
delete
':id/pipeline_schedules/:pipeline_schedule_id'
do
authenticate!
authenticate!
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment