pulpcore.client.pulp_rpm.DocsApiJsonApi

All URIs are relative to https://pulp

Method	HTTP request	Description
get	GET /pulp/api/v3/docs/api.json

get

object get(lang=lang, fields=fields, exclude_fields=exclude_fields)

OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json

Example

from __future__ import print_function
import time
import pulpcore.client.pulp_rpm
from pulpcore.client.pulp_rpm.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://pulp
# See configuration.py for a list of all supported configuration parameters.
configuration = pulpcore.client.pulp_rpm.Configuration(
    host = "https://pulp"
)


# Enter a context with an instance of the API client
with pulpcore.client.pulp_rpm.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = pulpcore.client.pulp_rpm.DocsApiJsonApi(api_client)
    lang = 'lang_example' # str |  (optional)
fields = ['fields_example'] # list[str] | A list of fields to include in the response. (optional)
exclude_fields = ['exclude_fields_example'] # list[str] | A list of fields to exclude from the response. (optional)

    try:
        api_response = api_instance.get(lang=lang, fields=fields, exclude_fields=exclude_fields)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DocsApiJsonApi->get: %s\n" % e)

Parameters

Name	Type	Description	Notes
lang	str		[optional]
fields	list[str]	A list of fields to include in the response.	[optional]
exclude_fields	list[str]	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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to HOME]