From eeaf8948d423249347abafec104f4a91a40f29c3 Mon Sep 17 00:00:00 2001 From: donhui <977675308@qq.com> Date: Thu, 23 Feb 2023 00:21:19 +0800 Subject: [PATCH] add doc for system --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index bca2ce3..8a68b5f 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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