Format ID as uppercase in API descriptions

parent 4527bca5
...@@ -25,10 +25,10 @@ module API ...@@ -25,10 +25,10 @@ module API
desc 'Update epic issue association' do desc 'Update epic issue association' do
end end
params do params do
requires :epic_iid, type: Integer, desc: 'The iid of the epic' requires :epic_iid, type: Integer, desc: 'The IID of the epic'
requires :epic_issue_id, type: Integer, desc: 'The id of the epic issue association to update' requires :epic_issue_id, type: Integer, desc: 'The ID of the epic issue association to update'
optional :move_before_id, type: Integer, desc: 'The id of the epic issue association that should be positioned before the actual issue' optional :move_before_id, type: Integer, desc: 'The ID of the epic issue association that should be positioned before the actual issue'
optional :move_after_id, type: Integer, desc: 'The id of the epic issue association that should be positioned after the actual issue' optional :move_after_id, type: Integer, desc: 'The ID of the epic issue association that should be positioned after the actual issue'
end end
put ':id/(-/)epics/:epic_iid/issues/:epic_issue_id' do put ':id/(-/)epics/:epic_iid/issues/:epic_issue_id' do
authorize_can_admin_epic! authorize_can_admin_epic!
...@@ -55,7 +55,7 @@ module API ...@@ -55,7 +55,7 @@ module API
success EE::API::Entities::EpicIssue success EE::API::Entities::EpicIssue
end end
params do params do
requires :epic_iid, type: Integer, desc: 'The iid of the epic' requires :epic_iid, type: Integer, desc: 'The IID of the epic'
end end
[':id/epics/:epic_iid/issues', ':id/-/epics/:epic_iid/issues'].each do |path| [':id/epics/:epic_iid/issues', ':id/-/epics/:epic_iid/issues'].each do |path|
get path do get path do
...@@ -71,7 +71,7 @@ module API ...@@ -71,7 +71,7 @@ module API
success EE::API::Entities::EpicIssueLink success EE::API::Entities::EpicIssueLink
end end
params do params do
requires :epic_iid, type: Integer, desc: 'The iid of the epic' requires :epic_iid, type: Integer, desc: 'The IID of the epic'
end end
# rubocop: disable CodeReuse/ActiveRecord # rubocop: disable CodeReuse/ActiveRecord
post ':id/(-/)epics/:epic_iid/issues/:issue_id' do post ':id/(-/)epics/:epic_iid/issues/:issue_id' do
...@@ -97,8 +97,8 @@ module API ...@@ -97,8 +97,8 @@ module API
success EE::API::Entities::EpicIssueLink success EE::API::Entities::EpicIssueLink
end end
params do params do
requires :epic_iid, type: Integer, desc: 'The iid of the epic' requires :epic_iid, type: Integer, desc: 'The IID of the epic'
requires :epic_issue_id, type: Integer, desc: 'The id of the association' requires :epic_issue_id, type: Integer, desc: 'The ID of the association'
end end
delete ':id/(-/)epics/:epic_iid/issues/:epic_issue_id' do delete ':id/(-/)epics/:epic_iid/issues/:epic_issue_id' do
authorize_can_admin_epic! authorize_can_admin_epic!
......
...@@ -109,8 +109,8 @@ module API ...@@ -109,8 +109,8 @@ module API
desc 'Reorder child epics' desc 'Reorder child epics'
params do params do
use :child_epic_id use :child_epic_id
optional :move_before_id, type: Integer, desc: 'The id of the epic that should be positioned before the child epic' optional :move_before_id, type: Integer, desc: 'The ID of the epic that should be positioned before the child epic'
optional :move_after_id, type: Integer, desc: 'The id of the epic that should be positioned after the child epic' optional :move_after_id, type: Integer, desc: 'The ID of the epic that should be positioned after the child epic'
end end
put ':id/(-/)epics/:epic_iid/epics/:child_epic_id' do put ':id/(-/)epics/:epic_iid/epics/:child_epic_id' do
authorize_subepics_feature! authorize_subepics_feature!
......
...@@ -54,7 +54,7 @@ module API ...@@ -54,7 +54,7 @@ module API
end end
params do params do
requires :iid, type: String, desc: 'The internal id of the user list' requires :iid, type: String, desc: 'The internal ID of the user list'
end end
resource 'feature_flags_user_lists/:iid' do resource 'feature_flags_user_lists/:iid' do
desc 'Get a single feature flag user list belonging to a project' do desc 'Get a single feature flag user list belonging to a project' do
......
...@@ -66,7 +66,7 @@ module API ...@@ -66,7 +66,7 @@ module API
success Entities::GroupLabel success Entities::GroupLabel
end end
params do params do
optional :label_id, type: Integer, desc: 'The id of the label to be updated' optional :label_id, type: Integer, desc: 'The ID of the label to be updated'
optional :name, type: String, desc: 'The name of the label to be updated' optional :name, type: String, desc: 'The name of the label to be updated'
use :group_label_update_params use :group_label_update_params
exactly_one_of :label_id, :name exactly_one_of :label_id, :name
......
...@@ -57,7 +57,7 @@ module API ...@@ -57,7 +57,7 @@ module API
success Entities::ProjectLabel success Entities::ProjectLabel
end end
params do params do
optional :label_id, type: Integer, desc: 'The id of the label to be updated' optional :label_id, type: Integer, desc: 'The ID of the label to be updated'
optional :name, type: String, desc: 'The name of the label to be updated' optional :name, type: String, desc: 'The name of the label to be updated'
use :project_label_update_params use :project_label_update_params
exactly_one_of :label_id, :name exactly_one_of :label_id, :name
...@@ -71,7 +71,7 @@ module API ...@@ -71,7 +71,7 @@ module API
success Entities::ProjectLabel success Entities::ProjectLabel
end end
params do params do
optional :label_id, type: Integer, desc: 'The id of the label to be deleted' optional :label_id, type: Integer, desc: 'The ID of the label to be deleted'
optional :name, type: String, desc: 'The name of the label to be deleted' optional :name, type: String, desc: 'The name of the label to be deleted'
exactly_one_of :label_id, :name exactly_one_of :label_id, :name
end end
......
...@@ -57,7 +57,7 @@ module API ...@@ -57,7 +57,7 @@ module API
end end
params do params do
requires :link_id, type: String, desc: 'The id of the link' requires :link_id, type: String, desc: 'The ID of the link'
end end
resource 'links/:link_id' do resource 'links/:link_id' do
desc 'Get a link detail of a release' do desc 'Get a link detail of a release' do
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment