Skip to content

Commit

Permalink
Merge pull request #7 from donhui/system-doc
Browse files Browse the repository at this point in the history
add doc for system
  • Loading branch information
donhui committed Feb 22, 2023
2 parents 3af679b + eeaf894 commit 54211e3
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
- [Install](#install)
- [Usage](#usage)
* [Authentication](#authentication)
* [SYSTEM](#system)
+ [Create Bundle](#create-bundle)
+ [Ping Request](#ping-request)
+ [Get Version](#get-version)
+ [Metrics](#metrics)
* [Components](#components)
+ [Find Component by Name](#find-component-by-name)
+ [Find Components by CVEs](#find-components-by-cves)
Expand Down Expand Up @@ -43,6 +48,32 @@ xray_rest_client = XrayRestClient(
)
```

## SYSTEM
### Create Bundle
```python
system = xray_rest_client.system
response = system.create_bundle("bundle-2023-001")
print(response.json())
```
### Ping Request
```python
system = xray_rest_client.system
response = system.system.send_ping()
print(response.json())
```
### Get Version
```python
system = xray_rest_client.system
response = system.get_version()
print(response.json())
```
### Metrics
```python
system = xray_rest_client.system
response = system.get_metrics()
print(response.json())
```

## Components
### Find Component by Name
```python
Expand Down

0 comments on commit 54211e3

Please sign in to comment.