Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'lib/api/snippets.rb')
-rw-r--r--lib/api/snippets.rb46
1 files changed, 45 insertions, 1 deletions
diff --git a/lib/api/snippets.rb b/lib/api/snippets.rb
index 5f8e6c806cb..36698a220bd 100644
--- a/lib/api/snippets.rb
+++ b/lib/api/snippets.rb
@@ -28,6 +28,11 @@ module API
desc 'Get a snippets list for an authenticated user' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::Snippet
+ failure [
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
+ is_array true
end
params do
optional :created_after, type: DateTime, desc: 'Return snippets created after the specified time'
@@ -45,6 +50,11 @@ module API
desc 'List all public personal snippets current_user has access to' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
+ failure [
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
+ is_array true
end
params do
optional :created_after, type: DateTime, desc: 'Return snippets created after the specified time'
@@ -62,6 +72,10 @@ module API
desc 'Get a single snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
+ failure [
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
@@ -77,6 +91,12 @@ module API
desc 'Create new snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
+ failure [
+ { code: 400, message: 'Validation error' },
+ { code: 404, message: 'Not found' },
+ { code: 422, message: 'Unprocessable entity' }
+ ]
+ tags %w[snippets]
end
params do
requires :title, type: String, allow_blank: false, desc: 'The title of a snippet'
@@ -110,6 +130,12 @@ module API
desc 'Update an existing snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
+ failure [
+ { code: 400, message: 'Validation error' },
+ { code: 404, message: 'Not found' },
+ { code: 422, message: 'Unprocessable entity' }
+ ]
+ tags %w[snippets]
end
params do
@@ -154,6 +180,11 @@ module API
desc 'Remove snippet' do
detail 'This feature was introduced in GitLab 8.15.'
success Entities::PersonalSnippet
+ failure [
+ { code: 400, message: 'Validation error' },
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
@@ -178,6 +209,10 @@ module API
desc 'Get a raw snippet' do
detail 'This feature was introduced in GitLab 8.15.'
+ failure [
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'
@@ -189,7 +224,12 @@ module API
present content_for(snippet)
end
- desc 'Get raw snippet file contents from the repository'
+ desc 'Get raw snippet file contents from the repository' do
+ failure [
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
+ end
params do
use :raw_file_params
end
@@ -202,6 +242,10 @@ module API
desc 'Get the user agent details for a snippet' do
success Entities::UserAgentDetail
+ failure [
+ { code: 404, message: 'Not found' }
+ ]
+ tags %w[snippets]
end
params do
requires :id, type: Integer, desc: 'The ID of a snippet'