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

Added method to update viewset description #12218

Merged
merged 6 commits into from
Apr 25, 2023
Merged

Added method to update viewset description #12218

merged 6 commits into from
Apr 25, 2023

Conversation

abhi1693
Copy link
Member

@abhi1693 abhi1693 commented Apr 10, 2023

Closes: #12217

@abhi1693 abhi1693 linked an issue Apr 11, 2023 that may be closed by this pull request
Copy link
Collaborator

@arthanson arthanson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gives much better description then default:
"Extend DRF's ModelViewSet to support bulk update and delete functions." -> "Get a list of circuit termination objects."
Did a spot check of Get, Post, Patch, Put, Delete all looked good, also the @action overriden ones returned the correct docstring.

@jeremystretch
Copy link
Member

Thanks @abhi1693 and @arthanson!

@jeremystretch jeremystretch merged commit d3206d9 into netbox-community:feature Apr 25, 2023
@abhi1693 abhi1693 deleted the feat/12217-viewset-description branch April 25, 2023 18:47
jeremystretch added a commit that referenced this pull request Apr 25, 2023
@jeremystretch jeremystretch mentioned this pull request Apr 27, 2023
glennmatthews added a commit to nautobot/nautobot that referenced this pull request May 19, 2023
Heavily based on netbox-community/netbox#12218

Co-authored-by: Abhimanyu Saharan <asaharan@onemindservices.com>
glennmatthews added a commit to nautobot/nautobot that referenced this pull request May 22, 2023
…#3786)

* Fix default descriptions of REST API endpoints in the schema.

Heavily based on netbox-community/netbox#12218

Co-authored-by: Abhimanyu Saharan <asaharan@onemindservices.com>

* Change fragment

---------

Co-authored-by: Abhimanyu Saharan <asaharan@onemindservices.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 26, 2023
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.

Update API viewset descriptions
3 participants