Sha256: 5d208fe7ea3a2a8d4fd75a36a0ac9aee19b61df6bb99b5cff63de02de525cd07
Contents?: true
Size: 1.42 KB
Versions: 2
Compression:
Stored size: 1.42 KB
Contents
# PulpPythonClient::PypiApi All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- [**read**](PypiApi.md#read) | **GET** /pypi/{path}/ | Get index summary ## read > SummaryResponse read(path, opts) Get index summary Gets package summary stats of index. ### Example ```ruby # load the gem require 'pulp_python_client' api_instance = PulpPythonClient::PypiApi.new path = 'path_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 #Get index summary result = api_instance.read(path, opts) p result rescue PulpPythonClient::ApiError => e puts "Exception when calling PypiApi->read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **path** | **String**| | **fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional] **exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional] ### Return type [**SummaryResponse**](SummaryResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json
Version data entries
2 entries across 2 versions & 1 rubygems
Version | Path |
---|---|
pulp_python_client-3.11.4 | docs/PypiApi.md |
pulp_python_client-3.11.3 | docs/PypiApi.md |