Task #3579
closedPublish REST API bindings for Python on PyPI
0%
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
Updated by dkliban@redhat.com over 6 years ago
- Tracker changed from Issue to Task
- % Done set to 0
Updated by bizhang over 6 years ago
Would this be used for generating a CLI or is there some other value being proposed from this? Who is the intended audience of this binding?
Updated by dkliban@redhat.com over 6 years ago
This package will be used to build a CLI for Pulp 3. However, this is not actually the CLI.
I am filing a separate task to publish bindings for Ruby on rubygems.org. That package will be recommended to Katello.
Updated by bizhang over 6 years ago
- Groomed changed from No to Yes
Oh nice the generated package comes with its own setup.py and everything,
Updated by dkliban@redhat.com over 6 years ago
- Copied to Task #3580: Document how to generate REST API bindings using swagger-codegen added
Updated by rchan over 6 years ago
- Sprint deleted (
Sprint 37)
This item won't be moving forward to Sprint 38.
Updated by bmbouter over 5 years ago
- Project changed from Pulp to Python Support
- Sprint/Milestone deleted (
3.0.0)
Updated by dalley over 4 years ago
- Status changed from NEW to CLOSED - COMPLETE