dependency-tracker-client 1.0.0

data/docs/ConfigPropertyApi.md

@@ -0,0 +1,167 @@
+# DependencyTracker::ConfigPropertyApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_config_properties**](ConfigPropertyApi.md#get_config_properties) | **GET** /v1/configProperty | Returns a list of all ConfigProperties for the specified groupName
+[**update_config_property**](ConfigPropertyApi.md#update_config_property) | **POST** /v1/configProperty | Updates a config property
+[**update_config_property1**](ConfigPropertyApi.md#update_config_property1) | **POST** /v1/configProperty/aggregate | Updates an array of config properties
+
+
+
+## get_config_properties
+
+> Array<ConfigProperty> get_config_properties
+
+Returns a list of all ConfigProperties for the specified groupName
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::ConfigPropertyApi.new
+
+begin
+  #Returns a list of all ConfigProperties for the specified groupName
+  result = api_instance.get_config_properties
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ConfigPropertyApi->get_config_properties: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<ConfigProperty>**](ConfigProperty.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_config_property
+
+> ConfigProperty update_config_property(opts)
+
+Updates a config property
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::ConfigPropertyApi.new
+opts = {
+  body: DependencyTracker::ConfigProperty.new # ConfigProperty | 
+}
+
+begin
+  #Updates a config property
+  result = api_instance.update_config_property(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ConfigPropertyApi->update_config_property: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ConfigProperty**](ConfigProperty.md)|  | [optional] 
+
+### Return type
+
+[**ConfigProperty**](ConfigProperty.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_config_property1
+
+> Array<ConfigProperty> update_config_property1(opts)
+
+Updates an array of config properties
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::ConfigPropertyApi.new
+opts = {
+  body: [DependencyTracker::ConfigProperty.new] # Array<ConfigProperty> | 
+}
+
+begin
+  #Updates an array of config properties
+  result = api_instance.update_config_property1(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ConfigPropertyApi->update_config_property1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Array&lt;ConfigProperty&gt;**](ConfigProperty.md)|  | [optional] 
+
+### Return type
+
+[**Array&lt;ConfigProperty&gt;**](ConfigProperty.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ContentDisposition.md

@@ -0,0 +1,29 @@
+# DependencyTracker::ContentDisposition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**parameters** | **Hash<String, String>** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+**creation_date** | **Integer** |  | [optional] 
+**modification_date** | **Integer** |  | [optional] 
+**read_date** | **Integer** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::ContentDisposition.new(type: null,
+                                 parameters: null,
+                                 file_name: null,
+                                 creation_date: null,
+                                 modification_date: null,
+                                 read_date: null,
+                                 size: null)
+```
+
+

data/docs/Cwe.md

@@ -0,0 +1,19 @@
+# DependencyTracker::Cwe
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cwe_id** | **Integer** |  | [optional] 
+**name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Cwe.new(cwe_id: null,
+                                 name: null)
+```
+
+

data/docs/CweApi.md

@@ -0,0 +1,110 @@
+# DependencyTracker::CweApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_cwe**](CweApi.md#get_cwe) | **GET** /v1/cwe/{cweId} | Returns a specific CWE
+[**get_cwes**](CweApi.md#get_cwes) | **GET** /v1/cwe | Returns a list of all CWEs
+
+
+
+## get_cwe
+
+> Cwe get_cwe(cwe_id)
+
+Returns a specific CWE
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::CweApi.new
+cwe_id = 56 # Integer | The CWE ID of the CWE to retrieve
+
+begin
+  #Returns a specific CWE
+  result = api_instance.get_cwe(cwe_id)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling CweApi->get_cwe: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cwe_id** | **Integer**| The CWE ID of the CWE to retrieve | 
+
+### Return type
+
+[**Cwe**](Cwe.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_cwes
+
+> Array<Cwe> get_cwes
+
+Returns a list of all CWEs
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::CweApi.new
+
+begin
+  #Returns a list of all CWEs
+  result = api_instance.get_cwes
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling CweApi->get_cwes: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Cwe>**](Cwe.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+