Merge branch 'add-public-param-to-project-api' into 'master'
Add public params to GET /projects api. Closes #3788 See merge request !2409
This commit is contained in:
commit
20cc4bc475
6 changed files with 37 additions and 0 deletions
|
@ -1,6 +1,7 @@
|
||||||
Please view this file on the master branch, on stable branches it's out of date.
|
Please view this file on the master branch, on stable branches it's out of date.
|
||||||
|
|
||||||
v 8.5.0 (unreleased)
|
v 8.5.0 (unreleased)
|
||||||
|
- Add "visibility" flag to GET /projects api endpoint
|
||||||
|
|
||||||
v 8.4.0 (unreleased)
|
v 8.4.0 (unreleased)
|
||||||
- Ensure Gravatar host looks like an actual host
|
- Ensure Gravatar host looks like an actual host
|
||||||
|
|
|
@ -272,6 +272,10 @@ class Project < ActiveRecord::Base
|
||||||
query: "%#{query.try(:downcase)}%")
|
query: "%#{query.try(:downcase)}%")
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def search_by_visibility(level)
|
||||||
|
where(visibility_level: Gitlab::VisibilityLevel.const_get(level.upcase))
|
||||||
|
end
|
||||||
|
|
||||||
def search_by_title(query)
|
def search_by_title(query)
|
||||||
where('projects.archived = ?', false).where('LOWER(projects.name) LIKE :query', query: "%#{query.downcase}%")
|
where('projects.archived = ?', false).where('LOWER(projects.name) LIKE :query', query: "%#{query.downcase}%")
|
||||||
end
|
end
|
||||||
|
|
|
@ -33,6 +33,7 @@ GET /groups/:id/projects
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `archived` (optional) - if passed, limit by archived status
|
- `archived` (optional) - if passed, limit by archived status
|
||||||
|
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
|
||||||
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
||||||
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
||||||
- `search` (optional) - Return list of authorized projects according to a search criteria
|
- `search` (optional) - Return list of authorized projects according to a search criteria
|
||||||
|
|
|
@ -29,6 +29,7 @@ GET /projects
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `archived` (optional) - if passed, limit by archived status
|
- `archived` (optional) - if passed, limit by archived status
|
||||||
|
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
|
||||||
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
||||||
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
||||||
- `search` (optional) - Return list of authorized projects according to a search criteria
|
- `search` (optional) - Return list of authorized projects according to a search criteria
|
||||||
|
@ -152,6 +153,7 @@ GET /projects/owned
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `archived` (optional) - if passed, limit by archived status
|
- `archived` (optional) - if passed, limit by archived status
|
||||||
|
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
|
||||||
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
||||||
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
||||||
- `search` (optional) - Return list of authorized projects according to a search criteria
|
- `search` (optional) - Return list of authorized projects according to a search criteria
|
||||||
|
@ -167,6 +169,7 @@ GET /projects/starred
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `archived` (optional) - if passed, limit by archived status
|
- `archived` (optional) - if passed, limit by archived status
|
||||||
|
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
|
||||||
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
||||||
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
||||||
- `search` (optional) - Return list of authorized projects according to a search criteria
|
- `search` (optional) - Return list of authorized projects according to a search criteria
|
||||||
|
@ -182,6 +185,7 @@ GET /projects/all
|
||||||
Parameters:
|
Parameters:
|
||||||
|
|
||||||
- `archived` (optional) - if passed, limit by archived status
|
- `archived` (optional) - if passed, limit by archived status
|
||||||
|
- `visibility` (optional) - if passed, limit by visibility `public`, `internal`, `private`
|
||||||
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
- `order_by` (optional) - Return requests ordered by `id`, `name`, `path`, `created_at`, `updated_at` or `last_activity_at` fields. Default is `created_at`
|
||||||
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
- `sort` (optional) - Return requests sorted in `asc` or `desc` order. Default is `desc`
|
||||||
- `search` (optional) - Return list of authorized projects according to a search criteria
|
- `search` (optional) - Return list of authorized projects according to a search criteria
|
||||||
|
|
|
@ -264,6 +264,10 @@ module API
|
||||||
projects = projects.search(params[:search])
|
projects = projects.search(params[:search])
|
||||||
end
|
end
|
||||||
|
|
||||||
|
if params[:visibility].present?
|
||||||
|
projects = projects.search_by_visibility(params[:visibility])
|
||||||
|
end
|
||||||
|
|
||||||
projects.reorder(project_order_by => project_sort)
|
projects.reorder(project_order_by => project_sort)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -90,6 +90,29 @@ describe API::API, api: true do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
context 'and using the visibility filter' do
|
||||||
|
it 'should filter based on private visibility param' do
|
||||||
|
get api('/projects', user), { visibility: 'private' }
|
||||||
|
expect(response.status).to eq(200)
|
||||||
|
expect(json_response).to be_an Array
|
||||||
|
expect(json_response.length).to eq(user.namespace.projects.where(visibility_level: Gitlab::VisibilityLevel::PRIVATE).count)
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'should filter based on internal visibility param' do
|
||||||
|
get api('/projects', user), { visibility: 'internal' }
|
||||||
|
expect(response.status).to eq(200)
|
||||||
|
expect(json_response).to be_an Array
|
||||||
|
expect(json_response.length).to eq(user.namespace.projects.where(visibility_level: Gitlab::VisibilityLevel::INTERNAL).count)
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'should filter based on public visibility param' do
|
||||||
|
get api('/projects', user), { visibility: 'public' }
|
||||||
|
expect(response.status).to eq(200)
|
||||||
|
expect(json_response).to be_an Array
|
||||||
|
expect(json_response.length).to eq(user.namespace.projects.where(visibility_level: Gitlab::VisibilityLevel::PUBLIC).count)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
context 'and using sorting' do
|
context 'and using sorting' do
|
||||||
before do
|
before do
|
||||||
project2
|
project2
|
||||||
|
|
Loading…
Reference in a new issue