Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings
This repository was archived by the owner on Mar 18, 2019. It is now read-only.

Fill parameter name from Link object instead of using "data"#42

Open
wrsulliv wants to merge 1 commit into
core-api:mastercore-api/python-openapi-codec:masterfrom
wrsulliv:fill-parameter-name-from-linkwrsulliv/python-openapi-codec:fill-parameter-name-from-linkCopy head branch name to clipboard
Open

Fill parameter name from Link object instead of using "data"#42
wrsulliv wants to merge 1 commit into
core-api:mastercore-api/python-openapi-codec:masterfrom
wrsulliv:fill-parameter-name-from-linkwrsulliv/python-openapi-codec:fill-parameter-name-from-linkCopy head branch name to clipboard

Conversation

@wrsulliv
Copy link
Copy Markdown

@wrsulliv wrsulliv commented Jul 15, 2017

As described by #28, the "name" field of the generated Swagger JSON is currently hard-coded to "data". When using swagger-codegen, the generated models are labeled <Data*> which breaks the reusability of the generated SDKs.

The proposed solution allows a user to set a "title" property on a view (or viewset) which is then used to generate the "name" field in this format: <Title><Action>Params.

For example, the "post" action of the following viewset will be given a name of "CommentPostParams" instead of "data".

class CommentViewSet(viewsets.ModelViewSet):
    queryset = Comment.objects.all()
    serializer_class = CommentSerializer
    title = "comment"

This pull request has an associated pull request at encode/django-rest-framework#5275, both of which act to drive further discussion on #28.

Assuming views and viewsets are named <ViewName>View and <ViewSetName>ViewSet, it would also be possible to extract the view name automatically with a small code change.

Related issue: marcgibbons/django-rest-swagger#595

… parameter name instead of hard-coding to "data".

This is part of a proposed solution to core-api#28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Morty Proxy This is a proxified and sanitized view of the page, visit original site.