Project

Profile

Help

Task #3579

closed

Publish REST API bindings for Python on PyPI

Added by dkliban@redhat.com over 6 years ago. Updated over 4 years ago.

Status:
CLOSED - COMPLETE
Priority:
Normal
Assignee:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Platform Release:
Target Release - Python:
Groomed:
Yes
Sprint Candidate:
No
Tags:
Sprint:
Quarter:

Description

With help from swagger-codegen[0], Pulp's API schema can be used to generate bindings in many different languages.

I was able to GET the schema in JSON format from http://localhost:8000/api/v3/docs/api.json and then uploaded the JSON file to swagger editor[1]. I then clicked on "Generate Client" and selected "Python". This produced a ZIP archive that contained a python package with the bindings and documentation.

The hosted solution is backed by a Java application called swagger-codegen[2]. The goal of this task is to use swagger-codegen to generate a package called pulpcore-api-bindings and upload it to PyPI. The version should be the same as the version of pulpcore that was used to generate the bindings.

[0] https://swagger.io/swagger-codegen/
[1] http://editor.swagger.io/#/
[2] https://github.com/swagger-api/swagger-codegen


Related issues

Copied to Pulp - Task #3580: Document how to generate REST API bindings using swagger-codegenCLOSED - COMPLETEdkliban@redhat.com

Actions

Also available in: Atom PDF