pulp_maven_client 0.1.0b31570479795 → 0.1.0b31574282742

data/docs/RepositoriesMavenApi.md

@@ -0,0 +1,354 @@
+# PulpMavenClient::RepositoriesMavenApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RepositoriesMavenApi.md#create) | **POST** /pulp/api/v3/repositories/maven/maven/ | Create a maven repository
+[**delete**](RepositoriesMavenApi.md#delete) | **DELETE** {maven_repository_href} | Delete a maven repository
+[**list**](RepositoriesMavenApi.md#list) | **GET** /pulp/api/v3/repositories/maven/maven/ | List maven repositorys
+[**partial_update**](RepositoriesMavenApi.md#partial_update) | **PATCH** {maven_repository_href} | Partially update a maven repository
+[**read**](RepositoriesMavenApi.md#read) | **GET** {maven_repository_href} | Inspect a maven repository
+[**update**](RepositoriesMavenApi.md#update) | **PUT** {maven_repository_href} | Update a maven repository
+
+
+
+## create
+
+> MavenMavenRepository create(data)
+
+Create a maven repository
+
+A ViewSet for MavenRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenApi.new
+data = PulpMavenClient::MavenMavenRepository.new # MavenMavenRepository | 
+
+begin
+  #Create a maven repository
+  result = api_instance.create(data)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**MavenMavenRepository**](MavenMavenRepository.md)|  | 
+
+### Return type
+
+[**MavenMavenRepository**](MavenMavenRepository.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete
+
+> AsyncOperationResponse delete(maven_repository_href)
+
+Delete a maven repository
+
+Trigger an asynchronous task to delete a repository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenApi.new
+maven_repository_href = 'maven_repository_href_example' # String | URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/
+
+begin
+  #Delete a maven repository
+  result = api_instance.delete(maven_repository_href)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_repository_href** | **String**| URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2003 list(opts)
+
+List maven repositorys
+
+A ViewSet for MavenRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenApi.new
+opts = {
+  name: 'name_example', # String | 
+  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List maven repositorys
+  result = api_instance.list(opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | [optional] 
+ **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> MavenMavenRepository partial_update(maven_repository_href, data)
+
+Partially update a maven repository
+
+A ViewSet for MavenRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenApi.new
+maven_repository_href = 'maven_repository_href_example' # String | URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/
+data = PulpMavenClient::MavenMavenRepository.new # MavenMavenRepository | 
+
+begin
+  #Partially update a maven repository
+  result = api_instance.partial_update(maven_repository_href, data)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_repository_href** | **String**| URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/ | 
+ **data** | [**MavenMavenRepository**](MavenMavenRepository.md)|  | 
+
+### Return type
+
+[**MavenMavenRepository**](MavenMavenRepository.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## read
+
+> MavenMavenRepository read(maven_repository_href, opts)
+
+Inspect a maven repository
+
+A ViewSet for MavenRemote.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenApi.new
+maven_repository_href = 'maven_repository_href_example' # String | URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a maven repository
+  result = api_instance.read(maven_repository_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_repository_href** | **String**| URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**MavenMavenRepository**](MavenMavenRepository.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(maven_repository_href, data)
+
+Update a maven repository
+
+Trigger an asynchronous task to update a repository.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenApi.new
+maven_repository_href = 'maven_repository_href_example' # String | URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/
+data = PulpMavenClient::MavenMavenRepository.new # MavenMavenRepository | 
+
+begin
+  #Update a maven repository
+  result = api_instance.update(maven_repository_href, data)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_repository_href** | **String**| URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/ | 
+ **data** | [**MavenMavenRepository**](MavenMavenRepository.md)|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RepositoriesMavenVersionsApi.md

@@ -0,0 +1,214 @@
+# PulpMavenClient::RepositoriesMavenVersionsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](RepositoriesMavenVersionsApi.md#delete) | **DELETE** {maven_repository_version_href} | Delete a repository version
+[**list**](RepositoriesMavenVersionsApi.md#list) | **GET** {maven_repository_href}versions/ | List repository versions
+[**read**](RepositoriesMavenVersionsApi.md#read) | **GET** {maven_repository_version_href} | Inspect a repository version
+
+
+
+## delete
+
+> AsyncOperationResponse delete(maven_repository_version_href)
+
+Delete a repository version
+
+Trigger an asynchronous task to delete a repositroy version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenVersionsApi.new
+maven_repository_version_href = 'maven_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/maven/maven/1/versions/1/
+
+begin
+  #Delete a repository version
+  result = api_instance.delete(maven_repository_version_href)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/maven/maven/1/versions/1/ | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse2004 list(maven_maven_repository_href, opts)
+
+List repository versions
+
+MavenRepositoryVersion represents a single Maven repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenVersionsApi.new
+maven_maven_repository_href = 'maven_maven_repository_href_example' # String | URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/
+opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  number: 3.4, # Float | 
+  number__lt: 3.4, # Float | Filter results where number is less than value
+  number__lte: 3.4, # Float | Filter results where number is less than or equal to value
+  number__gt: 3.4, # Float | Filter results where number is greater than value
+  number__gte: 3.4, # Float | Filter results where number is greater than or equal to value
+  number__range: 3.4, # Float | Filter results where number is between two comma separated values
+  pulp_created__lt: 'pulp_created__lt_example', # String | Filter results where pulp_created is less than value
+  pulp_created__lte: 'pulp_created__lte_example', # String | Filter results where pulp_created is less than or equal to value
+  pulp_created__gt: 'pulp_created__gt_example', # String | Filter results where pulp_created is greater than value
+  pulp_created__gte: 'pulp_created__gte_example', # String | Filter results where pulp_created is greater than or equal to value
+  pulp_created__range: 'pulp_created__range_example', # String | Filter results where pulp_created is between two comma separated values
+  content: 'content_example', # String | Content Unit referenced by HREF
+  pulp_created: 'pulp_created_example', # String | ISO 8601 formatted dates are supported
+  limit: 56, # Integer | Number of results to return per page.
+  offset: 56, # Integer | The initial index from which to return the results.
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List repository versions
+  result = api_instance.list(maven_maven_repository_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_maven_repository_href** | **String**| URI of Maven Repository. e.g.: /pulp/api/v3/repositories/maven/maven/1/ | 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **number** | **Float**|  | [optional] 
+ **number__lt** | **Float**| Filter results where number is less than value | [optional] 
+ **number__lte** | **Float**| Filter results where number is less than or equal to value | [optional] 
+ **number__gt** | **Float**| Filter results where number is greater than value | [optional] 
+ **number__gte** | **Float**| Filter results where number is greater than or equal to value | [optional] 
+ **number__range** | **Float**| Filter results where number is between two comma separated values | [optional] 
+ **pulp_created__lt** | **String**| Filter results where pulp_created is less than value | [optional] 
+ **pulp_created__lte** | **String**| Filter results where pulp_created is less than or equal to value | [optional] 
+ **pulp_created__gt** | **String**| Filter results where pulp_created is greater than value | [optional] 
+ **pulp_created__gte** | **String**| Filter results where pulp_created is greater than or equal to value | [optional] 
+ **pulp_created__range** | **String**| Filter results where pulp_created is between two comma separated values | [optional] 
+ **content** | **String**| Content Unit referenced by HREF | [optional] 
+ **pulp_created** | **String**| ISO 8601 formatted dates are supported | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse2004**](InlineResponse2004.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> RepositoryVersion read(maven_repository_version_href, opts)
+
+Inspect a repository version
+
+MavenRepositoryVersion represents a single Maven repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_maven_client'
+# setup authorization
+PulpMavenClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpMavenClient::RepositoriesMavenVersionsApi.new
+maven_repository_version_href = 'maven_repository_version_href_example' # String | URI of Repository Version. e.g.: /pulp/api/v3/repositories/maven/maven/1/versions/1/
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a repository version
+  result = api_instance.read(maven_repository_version_href, opts)
+  p result
+rescue PulpMavenClient::ApiError => e
+  puts "Exception when calling RepositoriesMavenVersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **maven_repository_version_href** | **String**| URI of Repository Version. e.g.: /pulp/api/v3/repositories/maven/maven/1/versions/1/ | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**RepositoryVersion**](RepositoryVersion.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+