pulp_file_client 3.55.1 → 3.55.2

data/docs/DistributionsArtifactsApi.md

@@ -0,0 +1,172 @@
+# PulpFileClient::DistributionsArtifactsApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**distributions_core_artifacts_list**](DistributionsArtifactsApi.md#distributions_core_artifacts_list) | **GET** /pulp/api/v3/distributions/core/artifacts/ | List artifact distributions
+[**distributions_core_artifacts_read**](DistributionsArtifactsApi.md#distributions_core_artifacts_read) | **GET** {artifact_distribution_href} | Inspect an artifact distribution
+
+
+
+## distributions_core_artifacts_list
+
+> PaginatedArtifactDistributionResponseList distributions_core_artifacts_list(opts)
+
+List artifact distributions
+
+ViewSet for ArtifactDistribution.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsArtifactsApi.new
+opts = {
+  base_path: 'base_path_example', # String | Filter results where base_path matches value
+  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
+  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
+  base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__iexact: 'name__iexact_example', # String | Filter results where name matches value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
+  name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
+  name__regex: 'name__regex_example', # String | Filter results where name matches regex value
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  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.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  q: 'q_example', # String | 
+  repository: 'repository_example', # String | Filter results where repository matches value
+  repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
+  with_content: 'with_content_example', # String | Filter distributions based on the content served by them
+  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.
+}
+
+begin
+  #List artifact distributions
+  result = api_instance.distributions_core_artifacts_list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsArtifactsApi->distributions_core_artifacts_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **base_path** | **String**| Filter results where base_path matches value | [optional] 
+ **base_path__contains** | **String**| Filter results where base_path contains value | [optional] 
+ **base_path__icontains** | **String**| Filter results where base_path contains value | [optional] 
+ **base_path__in** | [**Array&lt;String&gt;**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__iexact** | **String**| Filter results where name matches value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__iregex** | **String**| Filter results where name matches regex value | [optional] 
+ **name__istartswith** | **String**| Filter results where name starts with value | [optional] 
+ **name__regex** | **String**| Filter results where name matches regex value | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [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] 
+ **pulp_label_select** | **String**| Filter labels by search string | [optional] 
+ **q** | **String**|  | [optional] 
+ **repository** | [**String**](.md)| Filter results where repository matches value | [optional] 
+ **repository__in** | [**Array&lt;String&gt;**](String.md)| Filter results where repository is in a comma-separated list of values | [optional] 
+ **with_content** | **String**| Filter distributions based on the content served by them | [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
+
+[**PaginatedArtifactDistributionResponseList**](PaginatedArtifactDistributionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## distributions_core_artifacts_read
+
+> ArtifactDistributionResponse distributions_core_artifacts_read(artifact_distribution_href, opts)
+
+Inspect an artifact distribution
+
+ViewSet for ArtifactDistribution.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::DistributionsArtifactsApi.new
+artifact_distribution_href = 'artifact_distribution_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.
+}
+
+begin
+  #Inspect an artifact distribution
+  result = api_instance.distributions_core_artifacts_read(artifact_distribution_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DistributionsArtifactsApi->distributions_core_artifacts_read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **artifact_distribution_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
+
+[**ArtifactDistributionResponse**](ArtifactDistributionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DistributionsFileApi.md

@@ -1,27 +1,27 @@
 # PulpFileClient::DistributionsFileApi
 
-All URIs are relative to *http://pulp*
+All URIs are relative to *http://localhost:24817*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**add_role**](DistributionsFileApi.md#add_role) | **POST** {file_file_distribution_href}add_role/ | Add a role
-[**create**](DistributionsFileApi.md#create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution
-[**delete**](DistributionsFileApi.md#delete) | **DELETE** {file_file_distribution_href} | Delete a file distribution
-[**list**](DistributionsFileApi.md#list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions
-[**list_roles**](DistributionsFileApi.md#list_roles) | **GET** {file_file_distribution_href}list_roles/ | List roles
-[**my_permissions**](DistributionsFileApi.md#my_permissions) | **GET** {file_file_distribution_href}my_permissions/ | List user permissions
-[**partial_update**](DistributionsFileApi.md#partial_update) | **PATCH** {file_file_distribution_href} | Update a file distribution
-[**read**](DistributionsFileApi.md#read) | **GET** {file_file_distribution_href} | Inspect a file distribution
-[**remove_role**](DistributionsFileApi.md#remove_role) | **POST** {file_file_distribution_href}remove_role/ | Remove a role
-[**set_label**](DistributionsFileApi.md#set_label) | **POST** {file_file_distribution_href}set_label/ | Set a label
-[**unset_label**](DistributionsFileApi.md#unset_label) | **POST** {file_file_distribution_href}unset_label/ | Unset a label
-[**update**](DistributionsFileApi.md#update) | **PUT** {file_file_distribution_href} | Update a file distribution
+[**distributions_file_file_add_role**](DistributionsFileApi.md#distributions_file_file_add_role) | **POST** {file_file_distribution_href}add_role/ | Add a role
+[**distributions_file_file_create**](DistributionsFileApi.md#distributions_file_file_create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution
+[**distributions_file_file_delete**](DistributionsFileApi.md#distributions_file_file_delete) | **DELETE** {file_file_distribution_href} | Delete a file distribution
+[**distributions_file_file_list**](DistributionsFileApi.md#distributions_file_file_list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions
+[**distributions_file_file_list_roles**](DistributionsFileApi.md#distributions_file_file_list_roles) | **GET** {file_file_distribution_href}list_roles/ | List roles
+[**distributions_file_file_my_permissions**](DistributionsFileApi.md#distributions_file_file_my_permissions) | **GET** {file_file_distribution_href}my_permissions/ | List user permissions
+[**distributions_file_file_partial_update**](DistributionsFileApi.md#distributions_file_file_partial_update) | **PATCH** {file_file_distribution_href} | Update a file distribution
+[**distributions_file_file_read**](DistributionsFileApi.md#distributions_file_file_read) | **GET** {file_file_distribution_href} | Inspect a file distribution
+[**distributions_file_file_remove_role**](DistributionsFileApi.md#distributions_file_file_remove_role) | **POST** {file_file_distribution_href}remove_role/ | Remove a role
+[**distributions_file_file_set_label**](DistributionsFileApi.md#distributions_file_file_set_label) | **POST** {file_file_distribution_href}set_label/ | Set a label
+[**distributions_file_file_unset_label**](DistributionsFileApi.md#distributions_file_file_unset_label) | **POST** {file_file_distribution_href}unset_label/ | Unset a label
+[**distributions_file_file_update**](DistributionsFileApi.md#distributions_file_file_update) | **PUT** {file_file_distribution_href} | Update a file distribution
 
 
 
-## add_role
+## distributions_file_file_add_role
 
-> NestedRoleResponse add_role(file_file_distribution_href, nested_role)
+> NestedRoleResponse distributions_file_file_add_role(file_file_distribution_href, nested_role)
 
 Add a role
 
@@ -45,10 +45,10 @@ nested_role = PulpFileClient::NestedRole.new # NestedRole |
 
 begin
   #Add a role
-  result = api_instance.add_role(file_file_distribution_href, nested_role)
+  result = api_instance.distributions_file_file_add_role(file_file_distribution_href, nested_role)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->add_role: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_add_role: #{e}"
 end
 ```
 
@@ -74,9 +74,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## create
+## distributions_file_file_create
 
-> AsyncOperationResponse create(file_file_distribution)
+> AsyncOperationResponse distributions_file_file_create(file_file_distribution)
 
 Create a file distribution
 
@@ -99,10 +99,10 @@ file_file_distribution = PulpFileClient::FileFileDistribution.new # FileFileDist
 
 begin
   #Create a file distribution
-  result = api_instance.create(file_file_distribution)
+  result = api_instance.distributions_file_file_create(file_file_distribution)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->create: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_create: #{e}"
 end
 ```
 
@@ -127,9 +127,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## delete
+## distributions_file_file_delete
 
-> AsyncOperationResponse delete(file_file_distribution_href)
+> AsyncOperationResponse distributions_file_file_delete(file_file_distribution_href)
 
 Delete a file distribution
 
@@ -152,10 +152,10 @@ file_file_distribution_href = 'file_file_distribution_href_example' # String |
 
 begin
   #Delete a file distribution
-  result = api_instance.delete(file_file_distribution_href)
+  result = api_instance.distributions_file_file_delete(file_file_distribution_href)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->delete: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_delete: #{e}"
 end
 ```
 
@@ -180,9 +180,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## list
+## distributions_file_file_list
 
-> PaginatedfileFileDistributionResponseList list(opts)
+> PaginatedfileFileDistributionResponseList distributions_file_file_list(opts)
 
 List file distributions
 
@@ -231,10 +231,10 @@ opts = {
 
 begin
   #List file distributions
-  result = api_instance.list(opts)
+  result = api_instance.distributions_file_file_list(opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->list: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_list: #{e}"
 end
 ```
 
@@ -283,9 +283,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## list_roles
+## distributions_file_file_list_roles
 
-> ObjectRolesResponse list_roles(file_file_distribution_href, opts)
+> ObjectRolesResponse distributions_file_file_list_roles(file_file_distribution_href, opts)
 
 List roles
 
@@ -312,10 +312,10 @@ opts = {
 
 begin
   #List roles
-  result = api_instance.list_roles(file_file_distribution_href, opts)
+  result = api_instance.distributions_file_file_list_roles(file_file_distribution_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->list_roles: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_list_roles: #{e}"
 end
 ```
 
@@ -342,9 +342,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## my_permissions
+## distributions_file_file_my_permissions
 
-> MyPermissionsResponse my_permissions(file_file_distribution_href, opts)
+> MyPermissionsResponse distributions_file_file_my_permissions(file_file_distribution_href, opts)
 
 List user permissions
 
@@ -371,10 +371,10 @@ opts = {
 
 begin
   #List user permissions
-  result = api_instance.my_permissions(file_file_distribution_href, opts)
+  result = api_instance.distributions_file_file_my_permissions(file_file_distribution_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->my_permissions: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_my_permissions: #{e}"
 end
 ```
 
@@ -401,9 +401,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## partial_update
+## distributions_file_file_partial_update
 
-> AsyncOperationResponse partial_update(file_file_distribution_href, patchedfile_file_distribution)
+> AsyncOperationResponse distributions_file_file_partial_update(file_file_distribution_href, patchedfile_file_distribution)
 
 Update a file distribution
 
@@ -427,10 +427,10 @@ patchedfile_file_distribution = PulpFileClient::PatchedfileFileDistribution.new
 
 begin
   #Update a file distribution
-  result = api_instance.partial_update(file_file_distribution_href, patchedfile_file_distribution)
+  result = api_instance.distributions_file_file_partial_update(file_file_distribution_href, patchedfile_file_distribution)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->partial_update: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_partial_update: #{e}"
 end
 ```
 
@@ -456,9 +456,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## read
+## distributions_file_file_read
 
-> FileFileDistributionResponse read(file_file_distribution_href, opts)
+> FileFileDistributionResponse distributions_file_file_read(file_file_distribution_href, opts)
 
 Inspect a file distribution
 
@@ -485,10 +485,10 @@ opts = {
 
 begin
   #Inspect a file distribution
-  result = api_instance.read(file_file_distribution_href, opts)
+  result = api_instance.distributions_file_file_read(file_file_distribution_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->read: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_read: #{e}"
 end
 ```
 
@@ -515,9 +515,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## remove_role
+## distributions_file_file_remove_role
 
-> NestedRoleResponse remove_role(file_file_distribution_href, nested_role)
+> NestedRoleResponse distributions_file_file_remove_role(file_file_distribution_href, nested_role)
 
 Remove a role
 
@@ -541,10 +541,10 @@ nested_role = PulpFileClient::NestedRole.new # NestedRole |
 
 begin
   #Remove a role
-  result = api_instance.remove_role(file_file_distribution_href, nested_role)
+  result = api_instance.distributions_file_file_remove_role(file_file_distribution_href, nested_role)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->remove_role: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_remove_role: #{e}"
 end
 ```
 
@@ -570,9 +570,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## set_label
+## distributions_file_file_set_label
 
-> SetLabelResponse set_label(file_file_distribution_href, set_label)
+> SetLabelResponse distributions_file_file_set_label(file_file_distribution_href, set_label)
 
 Set a label
 
@@ -596,10 +596,10 @@ set_label = PulpFileClient::SetLabel.new # SetLabel |
 
 begin
   #Set a label
-  result = api_instance.set_label(file_file_distribution_href, set_label)
+  result = api_instance.distributions_file_file_set_label(file_file_distribution_href, set_label)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->set_label: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_set_label: #{e}"
 end
 ```
 
@@ -625,9 +625,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## unset_label
+## distributions_file_file_unset_label
 
-> UnsetLabelResponse unset_label(file_file_distribution_href, unset_label)
+> UnsetLabelResponse distributions_file_file_unset_label(file_file_distribution_href, unset_label)
 
 Unset a label
 
@@ -651,10 +651,10 @@ unset_label = PulpFileClient::UnsetLabel.new # UnsetLabel |
 
 begin
   #Unset a label
-  result = api_instance.unset_label(file_file_distribution_href, unset_label)
+  result = api_instance.distributions_file_file_unset_label(file_file_distribution_href, unset_label)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->unset_label: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_unset_label: #{e}"
 end
 ```
 
@@ -680,9 +680,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## update
+## distributions_file_file_update
 
-> AsyncOperationResponse update(file_file_distribution_href, file_file_distribution)
+> AsyncOperationResponse distributions_file_file_update(file_file_distribution_href, file_file_distribution)
 
 Update a file distribution
 
@@ -706,10 +706,10 @@ file_file_distribution = PulpFileClient::FileFileDistribution.new # FileFileDist
 
 begin
   #Update a file distribution
-  result = api_instance.update(file_file_distribution_href, file_file_distribution)
+  result = api_instance.distributions_file_file_update(file_file_distribution_href, file_file_distribution)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsFileApi->update: #{e}"
+  puts "Exception when calling DistributionsFileApi->distributions_file_file_update: #{e}"
 end
 ```
 

data/docs/DocsApiJsonApi.md

@@ -0,0 +1,61 @@
+# PulpFileClient::DocsApiJsonApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**docs_api_json_get**](DocsApiJsonApi.md#docs_api_json_get) | **GET** /pulp/api/v3/docs/api.json | 
+
+
+
+## docs_api_json_get
+
+> Object docs_api_json_get(opts)
+
+
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+
+api_instance = PulpFileClient::DocsApiJsonApi.new
+opts = {
+  lang: 'lang_example', # String | 
+  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.
+}
+
+begin
+  result = api_instance.docs_api_json_get(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DocsApiJsonApi->docs_api_json_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **lang** | **String**|  | [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
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.oai.openapi+json, application/json
+

data/docs/DocsApiYamlApi.md

@@ -0,0 +1,61 @@
+# PulpFileClient::DocsApiYamlApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**docs_api_yaml_get**](DocsApiYamlApi.md#docs_api_yaml_get) | **GET** /pulp/api/v3/docs/api.yaml | 
+
+
+
+## docs_api_yaml_get
+
+> Object docs_api_yaml_get(opts)
+
+
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+
+api_instance = PulpFileClient::DocsApiYamlApi.new
+opts = {
+  lang: 'lang_example', # String | 
+  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.
+}
+
+begin
+  result = api_instance.docs_api_yaml_get(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling DocsApiYamlApi->docs_api_yaml_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **lang** | **String**|  | [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
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.oai.openapi, application/yaml
+

data/docs/Domain.md

@@ -0,0 +1,27 @@
+# PulpFileClient::Domain
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A name for this domain. | 
+**description** | **String** | An optional description. | [optional] 
+**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain.  * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | 
+**storage_settings** | [**Object**](.md) | Settings for storage class. | 
+**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
+**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::Domain.new(name: null,
+                                 description: null,
+                                 storage_class: null,
+                                 storage_settings: null,
+                                 redirect_to_object_storage: null,
+                                 hide_guarded_distributions: null)
+```
+
+