[Pulp-dev] pulp 3 bindings change proposal

Dennis Kliban dkliban at redhat.com
Wed Jun 19 12:54:30 UTC 2019

As pointed out in a recent issue[0], the method names in the bindings
generated from Pulp's OpenAPI schema are unnecessarily verbose. Each method
name corresponds to an Operation Id in the OpenAPI schema. The Operation Id
is also used as an HTML anchor in the REST API docs[1].

It is possible to generate a schema where each Operation Id is shorter, but
then the Operation Ids are not unique and all the linking in the REST API
documentation breaks. We can avoid this problem by keeping the long
Operation Id for the schema generated for the docs and only using short
Operation Ids when generating the schema for the bindings.

The difference in usage of the bindings can be seen here[2].

Is there any objection to including such a change in time for RC 3?

[0] https://pulp.plan.io/issues/4989
[1] https://docs.pulpproject.org/en/3.0/nightly/restapi.html
[2] https://pulp.plan.io/issues/4989#note-1
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20190619/ef5a9167/attachment.htm>

More information about the Pulp-dev mailing list