Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI Schema inconsistent operationId casing #6875

Closed
6 tasks done
peterfarrell opened this issue Aug 19, 2019 · 2 comments
Closed
6 tasks done

OpenAPI Schema inconsistent operationId casing #6875

peterfarrell opened this issue Aug 19, 2019 · 2 comments

Comments

@peterfarrell
Copy link
Contributor

peterfarrell commented Aug 19, 2019

Checklist

  • I have verified that that issue exists against the master branch of Django REST framework.
  • I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
  • This is not a usage question. (Those should be directed to the discussion group instead.)
  • This cannot be dealt with as a third party library. (We prefer new functionality to be in the form of third party libraries where possible.)
  • I have reduced the issue to the simplest possible case.
  • I have included a failing test as a pull request. (If you are unable to do so we can still accept the issue.)

Steps to reproduce

There is inconsistent casing of titles in the the OpenAPI operationId naming.

Expected behavior

Expected behavior is that the method names are consistent in case between them. I.e.

RetrieveRegistrant
ListRegistrant

or

retrieveRegistrant
listRegistrant

Given that the rest of the method names are lowercase, I would opt for listRegistrant (initial lower camel case) over CamelCase.

Actual behavior

It lowercases all methods names accept for List which is hardcoded.

retrieveRegistrant
ListRegistrants

Problem area:

[https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas/openapi.py#L112](https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas/openapi.py#L112

@carltongibson
Copy link
Collaborator

Hi @peterfarrell. Want to make a PR correcting that L?

peterfarrell added a commit to peterfarrell/django-rest-framework that referenced this issue Aug 19, 2019
peterfarrell added a commit to peterfarrell/django-rest-framework that referenced this issue Aug 19, 2019
peterfarrell added a commit to peterfarrell/django-rest-framework that referenced this issue Aug 19, 2019
carltongibson pushed a commit to peterfarrell/django-rest-framework that referenced this issue Sep 3, 2019
@domingues
Copy link
Contributor

domingues commented Jan 25, 2020

We still have inconsistency when using APIView:

  • ViewSet:
    imagem
  • APIView:
    imagem

One option is to lower case in this line:

action = self.method_mapping[method.lower()]

pchiquet pushed a commit to pchiquet/django-rest-framework that referenced this issue Nov 17, 2020
sigvef pushed a commit to sigvef/django-rest-framework that referenced this issue Dec 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants