Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add toc #6

Merged
merged 1 commit into from
Feb 22, 2023
Merged

add toc #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
# Python wrapper for JFROG Xray REST API
`jfrog-xray-api` is a live python package for JFrog Xray REST API.

# Tables of Contents

<!-- toc -->
- [Install](#install)
- [Usage](#usage)
* [Authentication](#authentication)
* [Components](#components)
+ [Find Component by Name](#find-component-by-name)
+ [Find Components by CVEs](#find-components-by-cves)
+ [Find CVEs by Components](#find-cves-by-components)
+ [Get Component List Per Watch](#get-component-list-per-watch)
+ [Get Artifact Dependency Graph](#get-artifact-dependency-graph)
+ [Compare Artifacts](#compare-artifacts)
+ [Get Build Dependency Graph](#get-build-dependency-graph)
+ [Compare Builds](#compare-builds)
+ [Export Component Details](#export-component-details)
* [SUMMARY](#summary)
+ [Build Summary](#build-summary)
+ [Artifact Summary](#artifact-summary)
* [ISSUES](#issues)
+ [Create Issue Event](#create-issue-event)
+ [Update Issue Event](#update-issue-event)
+ [Get Issue Event](#get-issue-event)
<!-- tocstop -->

# Install
```
pip install jfrog-xray-api
Expand Down