diff options
| author | Achilleas Pipinellis <axil@gitlab.com> | 2019-08-23 11:34:06 +0000 |
|---|---|---|
| committer | Achilleas Pipinellis <axil@gitlab.com> | 2019-08-23 11:34:06 +0000 |
| commit | 40295b25ab382f87f84e27a16f46be2345fe94c0 (patch) | |
| tree | 3264bfc64c82127585bcad61e7399489760d915a | |
| parent | 497ba83f15b20601f18a1675e6bde80048cca839 (diff) | |
| parent | 6642d5471d65086d5a28f55205dd350bc1244aff (diff) | |
| download | gitlab-ce-40295b25ab382f87f84e27a16f46be2345fe94c0.tar.gz | |
Merge branch 'docs-12713-vulnerabilities-dl-api' into 'master'
Update dependencies api doc
See merge request gitlab-org/gitlab-ce!32061
| -rw-r--r-- | doc/api/dependencies.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/api/dependencies.md b/doc/api/dependencies.md index 5767d3572dd..5296d4e316f 100644 --- a/doc/api/dependencies.md +++ b/doc/api/dependencies.md @@ -5,7 +5,8 @@ This API is in an alpha stage and considered unstable. The response payload may be subject to change or breakage across GitLab releases. -Every call to this endpoint requires authentication. To perform this call, user should be authorized to read +Every call to this endpoint requires authentication. To perform this call, user should be authorized to read repository. +To see vulnerabilities in response, user should be authorized to read [Project Security Dashboard](../user/application_security/security_dashboard/index.md#project-security-dashboard). ## List project dependencies @@ -17,8 +18,8 @@ supported by Gemnasium. ``` GET /projects/:id/dependencies -GET /projects/:id/vulnerabilities?package_manager=maven -GET /projects/:id/vulnerabilities?package_manager=yarn,bundler +GET /projects/:id/dependencies?package_manager=maven +GET /projects/:id/dependencies?package_manager=yarn,bundler ``` | Attribute | Type | Required | Description | @@ -38,13 +39,18 @@ Example response: "name": "rails", "version": "5.0.1", "package_manager": "bundler", - "dependency_file_path": "Gemfile.lock" + "dependency_file_path": "Gemfile.lock", + "vulnerabilities": [{ + "name": "DDoS", + "severity": "unknown" + }] }, { "name": "hanami", "version": "1.3.1", "package_manager": "bundler", - "dependency_file_path": "Gemfile.lock" + "dependency_file_path": "Gemfile.lock", + "vulnerabilities": [] } ] ``` |