REST API Documentation¶
The REST API documentation for pulpcore can be found here.
The documentation is auto generated based on the OpenAPI schema for the REST API. The hosted
documentation is broken up between
pulpcore and each of the plugin’s documentation sites.
Users can view the REST API documentation for their instance of Pulp by pointing their browser at
Python Client for pulpcore’s REST API¶
pulpcore-client Python package is available on PyPI. It is currently published daily and with every RC.
Each plugin is responsible for publishing it’s own client to PyPI. The client libraries for plugins
should follow the``pulp_<slug>-client`` naming scheme.
Ruby Client for pulpcore’s REST API¶
pulpcore_client Ruby Gem is available on
rubygems.org. It is currently published daily and
with every RC. Each plugin is responsible for publishing it’s own client to Rubygems.org. The
client libraries for plugins should follow the``pulp_<slug>_client`` naming scheme.
Client in a language of your choice¶
A client can be generated using Pulp’s OpenAPI schema and any of the available generators.
Generating a client is a two step process:
1) Download the OpenAPI schema for pulpcore and all installed plugins:
curl -o api.json http://<pulp-hostname>:24817/pulp/api/v3/docs/api.json
The OpenAPI schema for a specific plugin can be downloaded by specifying the plugin’s module name as a GET parameter. For example for pulp_rpm only endpoints use a query like this:
curl -o api.json http://<pulp-hostname>:24817/pulp/api/v3/docs/api.json?plugin=pulp_rpm
2) Generate a client using openapi-generator.
The schema can then be used as input to the openapi-generator-cli. The documentation on getting started with openapi-generator-cli is available on openapi-generator.tech.