harbor_swagger_client 1.0.2 → 1.0.3

data/spec/docs/Project.md

@@ -0,0 +1,21 @@
+# SwaggerClient::Project
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_id** | **Integer** | Project ID | [optional] 
+**owner_id** | **Integer** | The owner ID of the project always means the creator of the project. | [optional] 
+**name** | **String** | The name of the project. | [optional] 
+**creation_time** | **String** | The creation time of the project. | [optional] 
+**update_time** | **String** | The update time of the project. | [optional] 
+**deleted** | **BOOLEAN** | A deletion mark of the project. | [optional] 
+**owner_name** | **String** | The owner name of the project. | [optional] 
+**togglable** | **BOOLEAN** | Correspond to the UI about whether the project's publicity is  updatable (for UI) | [optional] 
+**current_user_role_id** | **Integer** | The role ID with highest permission of the current user who triggered the API (for UI) | [optional] 
+**current_user_role_ids** | **Array<Integer>** | The list of role ID of the current user who triggered the API (for UI) | [optional] 
+**repo_count** | **Integer** | The number of the repositories under this project. | [optional] 
+**chart_count** | **Integer** | The total number of charts under this project. | [optional] 
+**metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 
+**cve_whitelist** | [**CVEWhitelist**](CVEWhitelist.md) | The CVE whitelist of this project. | [optional] 
+
+

data/spec/docs/ProjectMember.md

@@ -0,0 +1,10 @@
+# SwaggerClient::ProjectMember
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role_id** | **Integer** | The role id 1 for projectAdmin, 2 for developer, 3 for guest, 4 for master | [optional] 
+**member_user** | [**UserEntity**](UserEntity.md) |  | [optional] 
+**member_group** | [**UserGroup**](UserGroup.md) |  | [optional] 
+
+

data/spec/docs/ProjectMemberEntity.md

@@ -0,0 +1,14 @@
+# SwaggerClient::ProjectMemberEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | the project member id | [optional] 
+**project_id** | **Integer** | the project id | [optional] 
+**entity_name** | **String** | the name of the group member. | [optional] 
+**role_name** | **String** | the name of the role | [optional] 
+**role_id** | **Integer** | the role id | [optional] 
+**entity_id** | **Integer** | the id of entity, if the member is a user, it is user_id in user table. if the member is a user group, it is the user group's ID in user_group table. | [optional] 
+**entity_type** | **String** | the entity's type, u for user entity, g for group entity. | [optional] 
+
+

data/spec/docs/ProjectMetadata.md

@@ -0,0 +1,13 @@
+# SwaggerClient::ProjectMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public** | **String** | The public status of the project. The valid values are \"true\", \"false\". | [optional] 
+**enable_content_trust** | **String** | Whether content trust is enabled or not. If it is enabled, user can't pull unsigned images from this project. The valid values are \"true\", \"false\". | [optional] 
+**prevent_vul** | **String** | Whether prevent the vulnerable images from running. The valid values are \"true\", \"false\". | [optional] 
+**severity** | **String** | If the vulnerability is high than severity defined here, the images can't be pulled. The valid values are \"none\", \"low\", \"medium\", \"high\", \"critical\". | [optional] 
+**auto_scan** | **String** | Whether scan images automatically when pushing. The valid values are \"true\", \"false\". | [optional] 
+**reuse_sys_cve_whitelist** | **String** | Whether this project reuse the system level CVE whitelist as the whitelist of its own.  The valid values are \"true\", \"false\". If it is set to \"true\" the actual whitelist associate with this project, if any, will be ignored. | [optional] 
+
+

data/spec/docs/ProjectReq.md

@@ -0,0 +1,12 @@
+# SwaggerClient::ProjectReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_name** | **String** | The name of the project. | [optional] 
+**metadata** | [**ProjectMetadata**](ProjectMetadata.md) | The metadata of the project. | [optional] 
+**cve_whitelist** | [**CVEWhitelist**](CVEWhitelist.md) | The CVE whitelist of the project. | [optional] 
+**count_limit** | **Integer** | The count quota of the project. | [optional] 
+**storage_limit** | **Integer** | The storage quota of the project. | [optional] 
+
+

data/spec/docs/ProjectScanner.md

@@ -0,0 +1,8 @@
+# SwaggerClient::ProjectScanner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** | The identifier of the scanner registration | [optional] 
+
+

data/spec/docs/ProjectSummary.md

@@ -0,0 +1,14 @@
+# SwaggerClient::ProjectSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**repo_count** | **Integer** | The number of the repositories under this project. | [optional] 
+**chart_count** | **Integer** | The total number of charts under this project. | [optional] 
+**project_admin_count** | **Integer** | The total number of project admin members. | [optional] 
+**master_count** | **Integer** | The total number of master members. | [optional] 
+**developer_count** | **Integer** | The total number of developer members. | [optional] 
+**guest_count** | **Integer** | The total number of guest members. | [optional] 
+**quota** | [**ProjectSummaryQuota**](ProjectSummaryQuota.md) |  | [optional] 
+
+

data/spec/docs/ProjectSummaryQuota.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ProjectSummaryQuota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional] 
+**used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional] 
+
+

data/spec/docs/PutRegistry.md

@@ -0,0 +1,14 @@
+# SwaggerClient::PutRegistry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The registry name. | [optional] 
+**description** | **String** | Description of the registry. | [optional] 
+**url** | **String** | The registry address URL string. | [optional] 
+**credential_type** | **String** | Credential type of the registry, e.g. 'basic'. | [optional] 
+**access_key** | **String** | The registry access key. | [optional] 
+**access_secret** | **String** | The registry access secret. | [optional] 
+**insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the server. | [optional] 
+
+

data/spec/docs/Quota.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Quota
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | ID of the quota | [optional] 
+**ref** | [**QuotaRefObject**](QuotaRefObject.md) | The reference object of the quota | [optional] 
+**hard** | [**ResourceList**](ResourceList.md) | The hard limits of the quota | [optional] 
+**used** | [**ResourceList**](ResourceList.md) | The used status of the quota | [optional] 
+**creation_time** | **String** | the creation time of the quota | [optional] 
+**update_time** | **String** | the update time of the quota | [optional] 
+
+

data/spec/docs/QuotaApi.md

@@ -0,0 +1,118 @@
+# SwaggerClient::QuotaApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**quotas_id_get**](QuotaApi.md#quotas_id_get) | **GET** /quotas/{id} | Get the specified quota
+[**quotas_id_put**](QuotaApi.md#quotas_id_put) | **PUT** /quotas/{id} | Update the specified quota
+
+
+# **quotas_id_get**
+> Quota quotas_id_get(id)
+
+Get the specified quota
+
+Get the specified quota
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::QuotaApi.new
+
+id = 56 # Integer | Quota ID
+
+
+begin
+  #Get the specified quota
+  result = api_instance.quotas_id_get(id)
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling QuotaApi->quotas_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Quota ID | 
+
+### Return type
+
+[**Quota**](Quota.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+
+# **quotas_id_put**
+> quotas_id_put(id, hard)
+
+Update the specified quota
+
+Update hard limits of the specified quota
+
+### Example
+```ruby
+# load the gem
+require 'harbor_swagger_client'
+# setup authorization
+SwaggerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = SwaggerClient::QuotaApi.new
+
+id = 56 # Integer | Quota ID
+
+hard = SwaggerClient::QuotaUpdateReq.new # QuotaUpdateReq | The new hard limits for the quota
+
+
+begin
+  #Update the specified quota
+  api_instance.quotas_id_put(id, hard)
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling QuotaApi->quotas_id_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Quota ID | 
+ **hard** | [**QuotaUpdateReq**](QuotaUpdateReq.md)| The new hard limits for the quota | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, text/plain
+
+
+

data/spec/docs/QuotaRefObject.md

@@ -0,0 +1,7 @@
+# SwaggerClient::QuotaRefObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/spec/docs/QuotaSwitcher.md

@@ -0,0 +1,8 @@
+# SwaggerClient::QuotaSwitcher
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**enabled** | **BOOLEAN** | The quota is enable or disable | [optional] 
+
+

data/spec/docs/QuotaUpdateReq.md

@@ -0,0 +1,8 @@
+# SwaggerClient::QuotaUpdateReq
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hard** | [**ResourceList**](ResourceList.md) | The new hard limits for the quota | [optional] 
+
+

data/spec/docs/Registry.md

@@ -0,0 +1,17 @@
+# SwaggerClient::Registry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The registry ID. | [optional] 
+**url** | **String** | The registry URL string. | [optional] 
+**name** | **String** | The registry name. | [optional] 
+**credential** | [**RegistryCredential**](RegistryCredential.md) |  | [optional] 
+**type** | **String** | Type of the registry, e.g. 'harbor'. | [optional] 
+**insecure** | **BOOLEAN** | Whether or not the certificate will be verified when Harbor tries to access the server. | [optional] 
+**description** | **String** | Description of the registry. | [optional] 
+**status** | **String** | Health status of the registry. | [optional] 
+**creation_time** | **String** | The create time of the policy. | [optional] 
+**update_time** | **String** | The update time of the policy. | [optional] 
+
+

data/spec/docs/RegistryCredential.md

@@ -0,0 +1,10 @@
+# SwaggerClient::RegistryCredential
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Credential type, such as 'basic', 'oauth'. | [optional] 
+**access_key** | **String** | Access key, e.g. user name when credential type is 'basic'. | [optional] 
+**access_secret** | **String** | Access secret, e.g. password when credential type is 'basic'. | [optional] 
+
+

data/spec/docs/RegistryInfo.md

@@ -0,0 +1,11 @@
+# SwaggerClient::RegistryInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The registry type | [optional] 
+**description** | **String** | The description | [optional] 
+**supported_resource_filters** | [**Array<FilterStyle>**](FilterStyle.md) | The filters that the registry supports | [optional] 
+**supported_triggers** | **Array<String>** | The triggers that the registry supports | [optional] 
+
+

data/spec/docs/ReplicationExecution.md

@@ -0,0 +1,19 @@
+# SwaggerClient::ReplicationExecution
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID | [optional] 
+**policy_id** | **Integer** | The policy ID | [optional] 
+**status** | **String** | The status | [optional] 
+**status_text** | **String** | The status text | [optional] 
+**trigger** | **String** | The trigger mode | [optional] 
+**total** | **Integer** | The total count of all tasks | [optional] 
+**failed** | **Integer** | The count of failed tasks | [optional] 
+**succeed** | **Integer** | The count of succeed tasks | [optional] 
+**in_progress** | **Integer** | The count of in_progress tasks | [optional] 
+**stopped** | **Integer** | The count of stopped tasks | [optional] 
+**start_time** | **String** | The start time | [optional] 
+**end_time** | **String** | The end time | [optional] 
+
+

data/spec/docs/ReplicationFilter.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ReplicationFilter
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The replication policy filter type. | [optional] 
+**value** | **String** | The value of replication policy filter. | [optional] 
+
+

data/spec/docs/ReplicationPolicy.md

@@ -0,0 +1,20 @@
+# SwaggerClient::ReplicationPolicy
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The policy ID. | [optional] 
+**name** | **String** | The policy name. | [optional] 
+**description** | **String** | The description of the policy. | [optional] 
+**src_registry** | [**Registry**](Registry.md) | The source registry. | [optional] 
+**dest_registry** | [**Registry**](Registry.md) | The destination registry. | [optional] 
+**dest_namespace** | **String** | The destination namespace. | [optional] 
+**trigger** | [**ReplicationTrigger**](ReplicationTrigger.md) |  | [optional] 
+**filters** | [**Array<ReplicationFilter>**](ReplicationFilter.md) | The replication policy filter array. | [optional] 
+**deletion** | **BOOLEAN** | Whether to replicate the deletion operation. | [optional] 
+**override** | **BOOLEAN** | Whether to override the resources on the destination registry. | [optional] 
+**enabled** | **BOOLEAN** | Whether the policy is enabled or not. | [optional] 
+**creation_time** | **String** | The create time of the policy. | [optional] 
+**update_time** | **String** | The update time of the policy. | [optional] 
+
+

data/spec/docs/ReplicationTask.md

@@ -0,0 +1,16 @@
+# SwaggerClient::ReplicationTask
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | The ID | [optional] 
+**execution_id** | **Integer** | The execution ID | [optional] 
+**resource_type** | **String** | The resource type | [optional] 
+**src_resource** | **String** | The source resource | [optional] 
+**dst_resource** | **String** | The destination resource | [optional] 
+**job_id** | **String** | The job ID | [optional] 
+**status** | **String** | The status | [optional] 
+**start_time** | **String** | The start time | [optional] 
+**end_time** | **String** | The end time | [optional] 
+
+

data/spec/docs/ReplicationTrigger.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ReplicationTrigger
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The replication policy trigger type. The valid values are manual, event_based and scheduled. | [optional] 
+**trigger_settings** | [**TriggerSettings**](TriggerSettings.md) |  | [optional] 
+
+

data/spec/docs/RepoSignature.md

@@ -0,0 +1,9 @@
+# SwaggerClient::RepoSignature
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag** | **String** | The tag of image. | [optional] 
+**hashes** | **Object** | The JSON object of the hash of the image. | [optional] 
+
+

data/spec/docs/Report.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Report
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**generated_at** | **String** | Time of generating this report | [optional] 
+**severity** | **String** | A standard scale for measuring the severity of a vulnerability. | [optional] 
+**vulnerabilities** | [**Array<VulnerabilityItem>**](VulnerabilityItem.md) |  | [optional] 
+**scanner** | [**Scanner**](Scanner.md) |  | [optional] 
+
+