Contents

# 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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
pulp_file_client-3.55.2	docs/DocsApiYamlApi.md
pulp_file_client-3.49.14	docs/DocsApiYamlApi.md