Project

Profile

Help

Task #3579

Publish REST API bindings for Python on PyPI

Added by dkliban@redhat.com over 1 year ago. Updated about 1 month ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

0%

Platform Release:
Blocks Release:
Target Release - Python:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
No
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

With help from swagger-codegen0, 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 editor1. 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-codegen2. 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-codegen CLOSED - COMPLETE Actions

History

#1 Updated by dkliban@redhat.com over 1 year ago

  • Tracker changed from Issue to Task
  • % Done set to 0

#2 Updated by dkliban@redhat.com over 1 year ago

  • Description updated (diff)

#3 Updated by bizhang over 1 year 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?

#4 Updated by dkliban@redhat.com over 1 year 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.

#5 Updated by bizhang over 1 year ago

  • Groomed changed from No to Yes

Oh nice the generated package comes with its own setup.py and everything,

#6 Updated by dkliban@redhat.com over 1 year ago

  • Copied to Task #3580: Document how to generate REST API bindings using swagger-codegen added

#7 Updated by dkliban@redhat.com over 1 year ago

  • Description updated (diff)

#8 Updated by ttereshc over 1 year ago

  • Sprint set to Sprint 37

#9 Updated by rchan over 1 year ago

  • Sprint deleted (Sprint 37)

This item won't be moving forward to Sprint 38.

#10 Updated by rchan over 1 year ago

  • Sprint Candidate changed from Yes to No

#11 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

#12 Updated by bmbouter about 1 month ago

  • Project changed from Pulp to Python Support
  • Sprint/Milestone deleted (3.0)

Please register to edit this issue

Also available in: Atom PDF