Project

Profile

Help

Issue #3856

In the bindings, href docstring is ambiguous and sometimes has the wrong type

Added by daviddavis over 1 year ago. Updated 8 months ago.

Status:
MODIFIED
Priority:
Normal
Category:
-
Sprint/Milestone:
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
API Bindings
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 42

Description

Looking at the API bindings:

class RepositoriesApi(object):

    def repositories_versions_create(self, href, data, **kwargs):  # noqa: E501
        """repositories_versions_create  # noqa: E501

        :param str href: A relative URI for the resource. (required)
        :param RepositoryVersion data: (required)
        :return: AsnycOperationResponse
                 If the method is called asynchronously,
                 returns the request thread.
        """ 
        pass

    def repositories_versions_delete(self, href, **kwargs):  # noqa: E501                               
        """repositories_versions_delete  # noqa: E501                                                   

        :param int href: A relative URI for the resource. (required)                                    
        :return: AsnycOperationResponse
                 If the method is called asynchronously,
                 returns the request thread.
        """ 

It's not totally clear what href means. Also, for repositories_versions_delete() it says the href type is an int.

Associated revisions

Revision b9399bcd View on GitHub
Added by dkliban@redhat.com over 1 year ago

Problem: OpenAPI schema doesn't use URIs to identify resources

Solution: Create a custom OpenAPI generator that refers to resources by their URI.

closes #3856
https://pulp.plan.io/issues/3856

closes #3851
https://pulp.plan.io/issues/3851

Revision b9399bcd View on GitHub
Added by dkliban@redhat.com over 1 year ago

Problem: OpenAPI schema doesn't use URIs to identify resources

Solution: Create a custom OpenAPI generator that refers to resources by their URI.

closes #3856
https://pulp.plan.io/issues/3856

closes #3851
https://pulp.plan.io/issues/3851

History

#1 Updated by daviddavis over 1 year ago

  • Tags API Bindings added

#2 Updated by daviddavis over 1 year ago

  • Subject changed from In the bindings, href docstring is ambiguous and sometimes wrong has the wrong type to In the bindings, href docstring is ambiguous and sometimes has the wrong type

#3 Updated by CodeHeeler over 1 year ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 40

#4 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 40 to Sprint 41

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

  • Status changed from NEW to POST
  • Assignee set to dkliban@redhat.com

#6 Updated by rchan over 1 year ago

  • Sprint changed from Sprint 41 to Sprint 42

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

  • Status changed from POST to MODIFIED

#8 Updated by bmbouter 8 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF