Commit 6642d547 authored by Tetiana Chupryna's avatar Tetiana Chupryna Committed by Achilleas Pipinellis

Update dependencies api doc

parent 497ba83f
...@@ -5,7 +5,8 @@ This API is in an alpha stage and considered unstable. ...@@ -5,7 +5,8 @@ This API is in an alpha stage and considered unstable.
The response payload may be subject to change or breakage The response payload may be subject to change or breakage
across GitLab releases. 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). [Project Security Dashboard](../user/application_security/security_dashboard/index.md#project-security-dashboard).
## List project dependencies ## List project dependencies
...@@ -17,8 +18,8 @@ supported by Gemnasium. ...@@ -17,8 +18,8 @@ supported by Gemnasium.
``` ```
GET /projects/:id/dependencies GET /projects/:id/dependencies
GET /projects/:id/vulnerabilities?package_manager=maven GET /projects/:id/dependencies?package_manager=maven
GET /projects/:id/vulnerabilities?package_manager=yarn,bundler GET /projects/:id/dependencies?package_manager=yarn,bundler
``` ```
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
...@@ -38,13 +39,18 @@ Example response: ...@@ -38,13 +39,18 @@ Example response:
"name": "rails", "name": "rails",
"version": "5.0.1", "version": "5.0.1",
"package_manager": "bundler", "package_manager": "bundler",
"dependency_file_path": "Gemfile.lock" "dependency_file_path": "Gemfile.lock",
"vulnerabilities": [{
"name": "DDoS",
"severity": "unknown"
}]
}, },
{ {
"name": "hanami", "name": "hanami",
"version": "1.3.1", "version": "1.3.1",
"package_manager": "bundler", "package_manager": "bundler",
"dependency_file_path": "Gemfile.lock" "dependency_file_path": "Gemfile.lock",
"vulnerabilities": []
} }
] ]
``` ```
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