pulp_deb_client 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ba679d90a0d2806b7795f0fb310cd9327c6ac93f078424cb989328e3e515850
-  data.tar.gz: 1a0ad4df73fcff33823177d3ef7fced66438fc41a1af1f309ac84d2d0bc047d9
+  metadata.gz: a7655b4cb886f3f75430dfdef3e34a142f3979367b6eb0c473ac4717368d999c
+  data.tar.gz: 20d888fc2e3d6054c071c32127ade1fa106d4eb04da7a525dff66df432e1adec
 SHA512:
-  metadata.gz: 32d817d8aa79814aebc2db4984599027ffe114d9d3e05738a2069b448b83558047bb935a58d651022c747093d52af39ef0c30ed38969bf3c965ced909dc33d14
-  data.tar.gz: 5d1ac04189fec6a643c3ad474c5b78d293f051acae316371dbf433493390b23903a7f441f0ea06aa74278a3542e56db692450b894ae4e8e65672b83299bb6202
+  metadata.gz: 9dd3728b6000da4f57558cb2ab5727ef80331b41dfb23cc55e4ef23d8c8e33961ad5969f4dae1d0633f9344260f53521fd07f36faf0b9e4673a471530d683058
+  data.tar.gz: 3200225f172d3575c43b120353659a3ce91c697d14e9db50aced289a4522fd6a79eac5fbcc5c589901ded44e17953f98eb4e4ca23fcc7095ad27c1af6444a2ff

data/README.md

@@ -7,7 +7,7 @@ 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: 3.0.1
+- Package version: 3.1.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://pulpproject.org](https://pulpproject.org)
 
@@ -24,16 +24,16 @@ gem build pulp_deb_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./pulp_deb_client-3.0.1.gem
+gem install ./pulp_deb_client-3.1.0.gem
 ```
 
-(for development, run `gem install --dev ./pulp_deb_client-3.0.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./pulp_deb_client-3.1.0.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_deb_client', '~> 3.0.1'
+    gem 'pulp_deb_client', '~> 3.1.0'
 
 ### Install from Git
 
@@ -69,8 +69,8 @@ relative_path = 'relative_path_example' # String | Path where the artifact is lo
 opts = {
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
-  upload: 'upload_example' # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the content unit.
+  upload: 'upload_example' # String | An uncommitted upload that may be turned into the content unit.
 }
 
 begin
@@ -119,6 +119,15 @@ Class | Method | HTTP request | Description
 *PulpDebClient::ContentReleasesApi* | [**create**](docs/ContentReleasesApi.md#create) | **POST** /pulp/api/v3/content/deb/releases/ | Create a release
 *PulpDebClient::ContentReleasesApi* | [**list**](docs/ContentReleasesApi.md#list) | **GET** /pulp/api/v3/content/deb/releases/ | List releases
 *PulpDebClient::ContentReleasesApi* | [**read**](docs/ContentReleasesApi.md#read) | **GET** {deb_release_href} | Inspect a release
+*PulpDebClient::ContentSourceIndicesApi* | [**create**](docs/ContentSourceIndicesApi.md#create) | **POST** /pulp/api/v3/content/deb/source_indices/ | Create a source index
+*PulpDebClient::ContentSourceIndicesApi* | [**list**](docs/ContentSourceIndicesApi.md#list) | **GET** /pulp/api/v3/content/deb/source_indices/ | List SourceIndices
+*PulpDebClient::ContentSourceIndicesApi* | [**read**](docs/ContentSourceIndicesApi.md#read) | **GET** {deb_source_index_href} | Inspect a source index
+*PulpDebClient::ContentSourcePackagesApi* | [**create**](docs/ContentSourcePackagesApi.md#create) | **POST** /pulp/api/v3/content/deb/source_packages/ | Create a source package
+*PulpDebClient::ContentSourcePackagesApi* | [**list**](docs/ContentSourcePackagesApi.md#list) | **GET** /pulp/api/v3/content/deb/source_packages/ | List source packages
+*PulpDebClient::ContentSourcePackagesApi* | [**read**](docs/ContentSourcePackagesApi.md#read) | **GET** {deb_source_package_href} | Inspect a source package
+*PulpDebClient::ContentSourceReleaseComponentsApi* | [**create**](docs/ContentSourceReleaseComponentsApi.md#create) | **POST** /pulp/api/v3/content/deb/source_release_components/ | Create a source package release component
+*PulpDebClient::ContentSourceReleaseComponentsApi* | [**list**](docs/ContentSourceReleaseComponentsApi.md#list) | **GET** /pulp/api/v3/content/deb/source_release_components/ | List source package release components
+*PulpDebClient::ContentSourceReleaseComponentsApi* | [**read**](docs/ContentSourceReleaseComponentsApi.md#read) | **GET** {deb_source_package_release_component_href} | Inspect a source package release component
 *PulpDebClient::DebCopyApi* | [**copy_content**](docs/DebCopyApi.md#copy_content) | **POST** /pulp/api/v3/deb/copy/ | Copy content
 *PulpDebClient::DistributionsAptApi* | [**create**](docs/DistributionsAptApi.md#create) | **POST** /pulp/api/v3/distributions/deb/apt/ | Create an apt distribution
 *PulpDebClient::DistributionsAptApi* | [**delete**](docs/DistributionsAptApi.md#delete) | **DELETE** {deb_apt_distribution_href} | Delete an apt distribution
@@ -195,6 +204,12 @@ Class | Method | HTTP request | Description
  - [PulpDebClient::DebReleaseFile](docs/DebReleaseFile.md)
  - [PulpDebClient::DebReleaseFileResponse](docs/DebReleaseFileResponse.md)
  - [PulpDebClient::DebReleaseResponse](docs/DebReleaseResponse.md)
+ - [PulpDebClient::DebSourceIndex](docs/DebSourceIndex.md)
+ - [PulpDebClient::DebSourceIndexResponse](docs/DebSourceIndexResponse.md)
+ - [PulpDebClient::DebSourcePackage](docs/DebSourcePackage.md)
+ - [PulpDebClient::DebSourcePackageReleaseComponent](docs/DebSourcePackageReleaseComponent.md)
+ - [PulpDebClient::DebSourcePackageReleaseComponentResponse](docs/DebSourcePackageReleaseComponentResponse.md)
+ - [PulpDebClient::DebSourcePackageResponse](docs/DebSourcePackageResponse.md)
  - [PulpDebClient::DebVerbatimPublication](docs/DebVerbatimPublication.md)
  - [PulpDebClient::DebVerbatimPublicationResponse](docs/DebVerbatimPublicationResponse.md)
  - [PulpDebClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
@@ -212,6 +227,9 @@ Class | Method | HTTP request | Description
  - [PulpDebClient::PaginateddebReleaseComponentResponseList](docs/PaginateddebReleaseComponentResponseList.md)
  - [PulpDebClient::PaginateddebReleaseFileResponseList](docs/PaginateddebReleaseFileResponseList.md)
  - [PulpDebClient::PaginateddebReleaseResponseList](docs/PaginateddebReleaseResponseList.md)
+ - [PulpDebClient::PaginateddebSourceIndexResponseList](docs/PaginateddebSourceIndexResponseList.md)
+ - [PulpDebClient::PaginateddebSourcePackageReleaseComponentResponseList](docs/PaginateddebSourcePackageReleaseComponentResponseList.md)
+ - [PulpDebClient::PaginateddebSourcePackageResponseList](docs/PaginateddebSourcePackageResponseList.md)
  - [PulpDebClient::PaginateddebVerbatimPublicationResponseList](docs/PaginateddebVerbatimPublicationResponseList.md)
  - [PulpDebClient::PatcheddebAptDistribution](docs/PatcheddebAptDistribution.md)
  - [PulpDebClient::PatcheddebAptRemote](docs/PatcheddebAptRemote.md)

data/docs/ContentGenericContentsApi.md

@@ -35,8 +35,8 @@ relative_path = 'relative_path_example' # String | Path where the artifact is lo
 opts = {
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
-  upload: 'upload_example' # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the content unit.
+  upload: 'upload_example' # String | An uncommitted upload that may be turned into the content unit.
 }
 
 begin
@@ -56,8 +56,8 @@ Name | Type | Description  | Notes
  **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | 
  **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
  **artifact** | **String**| Artifact file representing the physical content | [optional] 
- **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional] 
- **upload** | **String**| An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
+ **file** | **File**| An uploaded file that may be turned into the content unit. | [optional] 
+ **upload** | **String**| An uncommitted upload that may be turned into the content unit. | [optional] 
 
 ### Return type
 

data/docs/ContentInstallerPackagesApi.md

@@ -35,8 +35,8 @@ opts = {
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
   relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
-  upload: 'upload_example' # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the content unit.
+  upload: 'upload_example' # String | An uncommitted upload that may be turned into the content unit.
 }
 
 begin
@@ -56,8 +56,8 @@ Name | Type | Description  | Notes
  **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
  **artifact** | **String**| Artifact file representing the physical content | [optional] 
  **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | [optional] 
- **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional] 
- **upload** | **String**| An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
+ **file** | **File**| An uploaded file that may be turned into the content unit. | [optional] 
+ **upload** | **String**| An uncommitted upload that may be turned into the content unit. | [optional] 
 
 ### Return type
 

data/docs/ContentPackagesApi.md

@@ -35,8 +35,8 @@ opts = {
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
   relative_path: 'relative_path_example', # String | Path where the artifact is located relative to distributions base_path
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the artifact of the content unit.
-  upload: 'upload_example', # String | An uncommitted upload that may be turned into the artifact of the content unit.
+  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the content unit.
+  upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
   distribution: 'distribution_example', # String | Name of the distribution.
   component: 'component_example' # String | Name of the component.
 }
@@ -58,8 +58,8 @@ Name | Type | Description  | Notes
  **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
  **artifact** | **String**| Artifact file representing the physical content | [optional] 
  **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | [optional] 
- **file** | **File**| An uploaded file that may be turned into the artifact of the content unit. | [optional] 
- **upload** | **String**| An uncommitted upload that may be turned into the artifact of the content unit. | [optional] 
+ **file** | **File**| An uploaded file that may be turned into the content unit. | [optional] 
+ **upload** | **String**| An uncommitted upload that may be turned into the content unit. | [optional] 
  **distribution** | **String**| Name of the distribution. | [optional] 
  **component** | **String**| Name of the component. | [optional] 
 
@@ -113,6 +113,14 @@ opts = {
   origin: 'origin_example', # String | Filter results where origin matches value
   original_maintainer: 'original_maintainer_example', # String | Filter results where original_maintainer matches value
   package: 'package_example', # String | Filter results where package matches value
+  package__contains: 'package__contains_example', # String | Filter results where package contains value
+  package__icontains: 'package__icontains_example', # String | Filter results where package contains value
+  package__iexact: 'package__iexact_example', # String | Filter results where package matches value
+  package__in: ['package__in_example'], # Array<String> | Filter results where package is in a comma-separated list of values
+  package__iregex: 'package__iregex_example', # String | Filter results where package matches regex value
+  package__istartswith: 'package__istartswith_example', # String | Filter results where package starts with value
+  package__regex: 'package__regex_example', # String | Filter results where package matches regex value
+  package__startswith: 'package__startswith_example', # String | Filter results where package starts with value
   priority: 'priority_example', # String | Filter results where priority matches value
   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.
@@ -160,6 +168,14 @@ Name | Type | Description  | Notes
  **origin** | **String**| Filter results where origin matches value | [optional] 
  **original_maintainer** | **String**| Filter results where original_maintainer matches value | [optional] 
  **package** | **String**| Filter results where package matches value | [optional] 
+ **package__contains** | **String**| Filter results where package contains value | [optional] 
+ **package__icontains** | **String**| Filter results where package contains value | [optional] 
+ **package__iexact** | **String**| Filter results where package matches value | [optional] 
+ **package__in** | [**Array&lt;String&gt;**](String.md)| Filter results where package is in a comma-separated list of values | [optional] 
+ **package__iregex** | **String**| Filter results where package matches regex value | [optional] 
+ **package__istartswith** | **String**| Filter results where package starts with value | [optional] 
+ **package__regex** | **String**| Filter results where package matches regex value | [optional] 
+ **package__startswith** | **String**| Filter results where package starts with value | [optional] 
  **priority** | **String**| Filter results where priority matches value | [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] 

data/docs/ContentSourceIndicesApi.md

@@ -0,0 +1,204 @@
+# PulpDebClient::ContentSourceIndicesApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentSourceIndicesApi.md#create) | **POST** /pulp/api/v3/content/deb/source_indices/ | Create a source index
+[**list**](ContentSourceIndicesApi.md#list) | **GET** /pulp/api/v3/content/deb/source_indices/ | List SourceIndices
+[**read**](ContentSourceIndicesApi.md#read) | **GET** {deb_source_index_href} | Inspect a source index
+
+
+
+## create
+
+> DebSourceIndexResponse create(deb_source_index)
+
+Create a source index
+
+A SourceIndex represents the source indices of a single component.  Associated artifacts: Exactly one 'Sources' file. May optionally include one or more of 'Sources.gz', 'Sources.xz', 'Release'. If included, the 'Release' file is a legacy per-component-and-architecture Release file (with architecture always being 'source').  Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any 'Sources' files it needs when creating the publication. It does not make use of SourceIndex content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentSourceIndicesApi.new
+deb_source_index = PulpDebClient::DebSourceIndex.new # DebSourceIndex | 
+
+begin
+  #Create a source index
+  result = api_instance.create(deb_source_index)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentSourceIndicesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_source_index** | [**DebSourceIndex**](DebSourceIndex.md)|  | 
+
+### Return type
+
+[**DebSourceIndexResponse**](DebSourceIndexResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## list
+
+> PaginateddebSourceIndexResponseList list(opts)
+
+List SourceIndices
+
+A SourceIndex represents the source indices of a single component.  Associated artifacts: Exactly one 'Sources' file. May optionally include one or more of 'Sources.gz', 'Sources.xz', 'Release'. If included, the 'Release' file is a legacy per-component-and-architecture Release file (with architecture always being 'source').  Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any 'Sources' files it needs when creating the publication. It does not make use of SourceIndex content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentSourceIndicesApi.new
+opts = {
+  component: 'component_example', # String | Filter results where component 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) * `component` - Component * `-component` - Component (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (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.
+  q: 'q_example', # String | 
+  relative_path: 'relative_path_example', # String | Filter results where relative_path matches value
+  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
+  sha256: 'sha256_example', # String | Filter results where sha256 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.
+}
+
+begin
+  #List SourceIndices
+  result = api_instance.list(opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentSourceIndicesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **component** | **String**| Filter results where component 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;component&#x60; - Component * &#x60;-component&#x60; - Component (descending) * &#x60;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (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] 
+ **q** | **String**|  | [optional] 
+ **relative_path** | **String**| Filter results where relative_path matches value | [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] 
+ **sha256** | **String**| Filter results where sha256 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
+
+[**PaginateddebSourceIndexResponseList**](PaginateddebSourceIndexResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> DebSourceIndexResponse read(deb_source_index_href, opts)
+
+Inspect a source index
+
+A SourceIndex represents the source indices of a single component.  Associated artifacts: Exactly one 'Sources' file. May optionally include one or more of 'Sources.gz', 'Sources.xz', 'Release'. If included, the 'Release' file is a legacy per-component-and-architecture Release file (with architecture always being 'source').  Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any 'Sources' files it needs when creating the publication. It does not make use of SourceIndex content.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentSourceIndicesApi.new
+deb_source_index_href = 'deb_source_index_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 a source index
+  result = api_instance.read(deb_source_index_href, opts)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Exception when calling ContentSourceIndicesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deb_source_index_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
+
+[**DebSourceIndexResponse**](DebSourceIndexResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+