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

Docs: Update doc for Viewset lookup field to note that UI elements may be missing #3477

Closed
scetron opened this issue Mar 23, 2023 · 2 comments · Fixed by #3478
Closed

Docs: Update doc for Viewset lookup field to note that UI elements may be missing #3477

scetron opened this issue Mar 23, 2023 · 2 comments · Fixed by #3478
Assignees
Labels
type: documentation Improvements or additions to documentation

Comments

@scetron
Copy link
Contributor

scetron commented Mar 23, 2023

Environment

  • Nautobot version (Docker tag too if applicable): 1.5.10 / latest docs
  • Python version: n/a
  • Database platform, version: n/a
  • Middleware(s): n/a

Steps to Reproduce

Expected Behavior

Docs should specify caveats of changing lookup field.

Observed Behavior

Docs don't mention using id or other lookup fields over using pk or slug. Viewset router is looking for key pk rather than id to assemble URLs which makes buttons not show up on object detail (retrieve) screens.

@scetron scetron added the type: documentation Improvements or additions to documentation label Mar 23, 2023
@scetron scetron self-assigned this Mar 23, 2023
@smk4664
Copy link
Contributor

smk4664 commented Mar 23, 2023

This already exists the documentation: https://docs.nautobot.com/projects/core/en/stable/plugins/development/?h=lookup_field#setting-viewset-attributes

Also, the Example Plugin makes use of this.

@scetron
Copy link
Contributor Author

scetron commented Apr 3, 2023

The documentation is not specific enough.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants