pulp_maven_client 0.8.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37207515145fe9cae4d6b938af17d5318ee80f8fe02b0b6da85e3c8b65984b7a
-  data.tar.gz: 1c8fdc6ee34600a49b46c1fb375c849c1967097b3e0b7e3c9901c2ea62579341
+  metadata.gz: bba4422c7d45be1a9fe2f178e8a5a73f70e68d780da250369f533aa2c9d916df
+  data.tar.gz: e779556f4d6cfac4ff81b7f8c6d1215c6180185f90113bee0719a43a41723824
 SHA512:
-  metadata.gz: e965909476296c32264b54ba47a79b43e5d83de17d0ac9b729f62f416424a8dc5454eff0a6350c6abd63e989e3badcc05979bd43e901f36ba24ab79d6fcc68eb
-  data.tar.gz: 7b7a809cf81711843f0889441f0916b2e9d583258c755f35f2527b66eb4326cbc9072cf404412bdefc63d7bd71af6881dfba07be225be5ba83c31877d6a19912
+  metadata.gz: e5a2d480cb8f04e57d3749d66bdbab32471d8c8794e038a2172c39c83aaf350c50ec7766de1a4a611c77d3a3cf53b33edcdb1cec21998387e7a62e7bbc1cbc46
+  data.tar.gz: f4054adfcca341bf97427278ab40b3897e6437504da27621c30e484e605bc80ee98f0db7c8241c7eccfa69ae3d7ebb596a1920598ddb4257f54b59bffbe601a9

data/README.md

@@ -7,7 +7,8 @@ Fetch, Upload, Organize, and Distribute Software Packages
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v3
-- Package version: 0.8.1
+- Package version: 0.8.3
+- Generator version: 7.10.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://pulpproject.org](https://pulpproject.org)
 
@@ -24,16 +25,16 @@ gem build pulp_maven_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pulp_maven_client-0.8.1.gem
+gem install ./pulp_maven_client-0.8.3.gem
 ```
 
-(for development, run `gem install --dev ./pulp_maven_client-0.8.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pulp_maven_client-0.8.3.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'pulp_maven_client', '~> 0.8.1'
+    gem 'pulp_maven_client', '~> 0.8.3'
 
 ### Install from Git
 
@@ -62,10 +63,12 @@ PulpMavenClient.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR_USERNAME'
   config.password = 'YOUR_PASSWORD'
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
 end
 
 api_instance = PulpMavenClient::ContentArtifactApi.new
-maven_maven_artifact = PulpMavenClient::MavenMavenArtifact.new # MavenMavenArtifact | 
+maven_maven_artifact = PulpMavenClient::MavenMavenArtifact.new({artifact: 'artifact_example', relative_path: 'relative_path_example'}) # MavenMavenArtifact | 
 
 begin
   #Create a maven artifact
@@ -79,7 +82,7 @@ end
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *http://pulp*
+All URIs are relative to *http://localhost:24817*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -129,7 +132,7 @@ Class | Method | HTTP request | Description
  - [PulpMavenClient::MavenMavenDistributionResponse](docs/MavenMavenDistributionResponse.md)
  - [PulpMavenClient::MavenMavenRemote](docs/MavenMavenRemote.md)
  - [PulpMavenClient::MavenMavenRemoteResponse](docs/MavenMavenRemoteResponse.md)
- - [PulpMavenClient::MavenMavenRemoteResponseHiddenFields](docs/MavenMavenRemoteResponseHiddenFields.md)
+ - [PulpMavenClient::MavenMavenRemoteResponseHiddenFieldsInner](docs/MavenMavenRemoteResponseHiddenFieldsInner.md)
  - [PulpMavenClient::MavenMavenRepository](docs/MavenMavenRepository.md)
  - [PulpMavenClient::MavenMavenRepositoryResponse](docs/MavenMavenRepositoryResponse.md)
  - [PulpMavenClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
@@ -153,6 +156,7 @@ Class | Method | HTTP request | Description
 ## Documentation for Authorization
 
 
+Authentication schemes defined for the API:
 ### basicAuth
 
 - **Type**: HTTP basic authentication

data/docs/AsyncOperationResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task** | **String** | The href of the task. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task** | **String** | The href of the task. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpMavenClient'
+require 'pulp_maven_client'
 
-instance = PulpMavenClient::AsyncOperationResponse.new(task: null)
+instance = PulpMavenClient::AsyncOperationResponse.new(
+  task: null
+)
 ```
 
-

data/docs/ContentArtifactApi.md

@@ -1,27 +1,26 @@
 # PulpMavenClient::ContentArtifactApi
 
-All URIs are relative to *http://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ContentArtifactApi.md#create) | **POST** /pulp/api/v3/content/maven/artifact/ | Create a maven artifact
-[**list**](ContentArtifactApi.md#list) | **GET** /pulp/api/v3/content/maven/artifact/ | List maven artifacts
-[**read**](ContentArtifactApi.md#read) | **GET** {maven_maven_artifact_href} | Inspect a maven artifact
+All URIs are relative to *http://localhost:24817*
 
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ContentArtifactApi.md#create) | **POST** /pulp/api/v3/content/maven/artifact/ | Create a maven artifact |
+| [**list**](ContentArtifactApi.md#list) | **GET** /pulp/api/v3/content/maven/artifact/ | List maven artifacts |
+| [**read**](ContentArtifactApi.md#read) | **GET** {maven_maven_artifact_href} | Inspect a maven artifact |
 
 
 ## create
 
-> MavenMavenArtifactResponse create(maven_maven_artifact)
+> <MavenMavenArtifactResponse> create(maven_maven_artifact)
 
 Create a maven artifact
 
 A ViewSet for MavenArtifact.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_maven_client'
 # setup authorization
 PulpMavenClient.configure do |config|
@@ -31,23 +30,40 @@ PulpMavenClient.configure do |config|
 end
 
 api_instance = PulpMavenClient::ContentArtifactApi.new
-maven_maven_artifact = PulpMavenClient::MavenMavenArtifact.new # MavenMavenArtifact | 
+maven_maven_artifact = PulpMavenClient::MavenMavenArtifact.new({artifact: 'artifact_example', relative_path: 'relative_path_example'}) # MavenMavenArtifact | 
 
 begin
-  #Create a maven artifact
+  # Create a maven artifact
   result = api_instance.create(maven_maven_artifact)
   p result
 rescue PulpMavenClient::ApiError => e
-  puts "Exception when calling ContentArtifactApi->create: #{e}"
+  puts "Error when calling ContentArtifactApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MavenMavenArtifactResponse>, Integer, Hash)> create_with_http_info(maven_maven_artifact)
+
+```ruby
+begin
+  # Create a maven artifact
+  data, status_code, headers = api_instance.create_with_http_info(maven_maven_artifact)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MavenMavenArtifactResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling ContentArtifactApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **maven_maven_artifact** | [**MavenMavenArtifact**](MavenMavenArtifact.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_artifact** | [**MavenMavenArtifact**](MavenMavenArtifact.md) |  |  |
 
 ### Return type
 
@@ -65,16 +81,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatedmavenMavenArtifactResponseList list(opts)
+> <PaginatedmavenMavenArtifactResponseList> list(opts)
 
 List maven artifacts
 
 A ViewSet for MavenArtifact.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_maven_client'
 # setup authorization
 PulpMavenClient.configure do |config|
@@ -90,49 +106,68 @@ opts = {
   group_id: 'group_id_example', # String | Filter results where group_id matches value
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `group_id` - Group id * `-group_id` - Group id (descending) * `artifact_id` - Artifact id * `-artifact_id` - Artifact id (descending) * `version` - Version * `-version` - Version (descending) * `filename` - Filename * `-filename` - Filename (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  orphaned_for: 3.4, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
-  q: 'q_example', # String | 
-  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
-  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
-  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  ordering: ['-artifact_id'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `group_id` - Group id * `-group_id` - Group id (descending) * `artifact_id` - Artifact id * `-artifact_id` - Artifact id (descending) * `version` - Version * `-version` - Version (descending) * `filename` - Filename * `-filename` - Filename (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
   version: 'version_example', # String | Filter results where version matches value
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List maven artifacts
+  # List maven artifacts
   result = api_instance.list(opts)
   p result
 rescue PulpMavenClient::ApiError => e
-  puts "Exception when calling ContentArtifactApi->list: #{e}"
+  puts "Error when calling ContentArtifactApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **artifact_id** | **String**| Filter results where artifact_id matches value | [optional] 
- **filename** | **String**| Filter results where filename matches value | [optional] 
- **group_id** | **String**| Filter results where group_id matches value | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;group_id&#x60; - Group id * &#x60;-group_id&#x60; - Group id (descending) * &#x60;artifact_id&#x60; - Artifact id * &#x60;-artifact_id&#x60; - Artifact id (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;filename&#x60; - Filename * &#x60;-filename&#x60; - Filename (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **orphaned_for** | **Float**| Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] 
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **q** | **String**|  | [optional] 
- **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
- **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
- **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
- **version** | **String**| Filter results where version matches value | [optional] 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+> <Array(<PaginatedmavenMavenArtifactResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List maven artifacts
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedmavenMavenArtifactResponseList>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling ContentArtifactApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **artifact_id** | **String** | Filter results where artifact_id matches value | [optional] |
+| **filename** | **String** | Filter results where filename matches value | [optional] |
+| **group_id** | **String** | Filter results where group_id matches value | [optional] |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;group_id&#x60; - Group id * &#x60;-group_id&#x60; - Group id (descending) * &#x60;artifact_id&#x60; - Artifact id * &#x60;-artifact_id&#x60; - Artifact id (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;filename&#x60; - Filename * &#x60;-filename&#x60; - Filename (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
+| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_href__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **pulp_id__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
+| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **version** | **String** | Filter results where version matches value | [optional] |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 
@@ -150,16 +185,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> MavenMavenArtifactResponse read(maven_maven_artifact_href, opts)
+> <MavenMavenArtifactResponse> read(maven_maven_artifact_href, opts)
 
 Inspect a maven artifact
 
 A ViewSet for MavenArtifact.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_maven_client'
 # setup authorization
 PulpMavenClient.configure do |config|
@@ -171,27 +206,44 @@ end
 api_instance = PulpMavenClient::ContentArtifactApi.new
 maven_maven_artifact_href = 'maven_maven_artifact_href_example' # String | 
 opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect a maven artifact
+  # Inspect a maven artifact
   result = api_instance.read(maven_maven_artifact_href, opts)
   p result
 rescue PulpMavenClient::ApiError => e
-  puts "Exception when calling ContentArtifactApi->read: #{e}"
+  puts "Error when calling ContentArtifactApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MavenMavenArtifactResponse>, Integer, Hash)> read_with_http_info(maven_maven_artifact_href, opts)
 
+```ruby
+begin
+  # Inspect a maven artifact
+  data, status_code, headers = api_instance.read_with_http_info(maven_maven_artifact_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MavenMavenArtifactResponse>
+rescue PulpMavenClient::ApiError => e
+  puts "Error when calling ContentArtifactApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **maven_maven_artifact_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **maven_maven_artifact_href** | **String** |  |  |
+| **fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to include in the response. | [optional] |
+| **exclude_fields** | [**Array&lt;String&gt;**](String.md) | A list of fields to exclude from the response. | [optional] |
 
 ### Return type
 

data/docs/ContentSummaryResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**added** | **Hash<String, Object>** |  | 
-**removed** | **Hash<String, Object>** |  | 
-**present** | **Hash<String, Object>** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added** | **Hash<String, Object>** |  |  |
+| **removed** | **Hash<String, Object>** |  |  |
+| **present** | **Hash<String, Object>** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpMavenClient'
+require 'pulp_maven_client'
 
-instance = PulpMavenClient::ContentSummaryResponse.new(added: null,
-                                 removed: null,
-                                 present: null)
+instance = PulpMavenClient::ContentSummaryResponse.new(
+  added: null,
+  removed: null,
+  present: null
+)
 ```
 
-