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

UI and docs updates for plugin-to-App #5353

Merged
merged 9 commits into from
Feb 29, 2024

Conversation

glennmatthews
Copy link
Contributor

@glennmatthews glennmatthews commented Feb 26, 2024

Closes #5241

Closes #5341

What's Changed

  • Add /apps/installed-apps/ URL patterns (just a mirror of /plugins/installed-plugins/ for now)
  • Add /api/apps/installed-apps/ URL patterns (just a mirror of /api/apps/installed-apps/ for now)
  • Update "Installed Plugins" view and dependent views to use App rather than plugin terminology throughout
  • Update docs (not including old release-notes) to use App rather than plugin terminology throughout
  • Remove is_staff restriction to access the "Installed Apps" view (irrelevant since similar information is exposed via the /api/status/ endpoint accessible to any authenticated user)

Screenshots

image

image

image

image

TODO

  • Explanation of Change(s)
  • Added change log fragment(s) (for more information see the documentation)
  • Attached Screenshots, Payload Example
  • Unit, Integration Tests
  • Documentation Updates (when adding/changing features)
  • Example Plugin Updates (when adding/changing features)
  • Outline Remaining Work, Constraints from Design

@glennmatthews glennmatthews marked this pull request as ready for review February 27, 2024 18:04
Copy link
Contributor

@gsnider2195 gsnider2195 left a comment

Choose a reason for hiding this comment

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

Still seeing some old URL references:

mkdocs.yml:566:      - Nautobot Firewall Models: "https://nautobot-plugin-firewall-models.readthedocs.io/en/latest/"
nautobot/docs/apps/index.md:19:| ![Logo](../assets/app-icons/icon-FirewallModels.png) | [Nautobot Firewall Models](https://nautobot-plugin-firewall-models.readthedocs.io/en/latest/) | Construct firewall policies in Nautobot with the help of the provided collection of relevant models. |
nautobot/docs/apps/index.md:22:| ![Logo](../assets/app-icons/icon-SSoT.png) | [Nautobot Single Source of Truth (SSoT)](https://nautobot-plugin-ssot.readthedocs.io/en/latest/)  | Integrate and synchronize data between various "source of truth" (SoT) systems, with Nautobot acting as a central clearinghouse for data - a Single Source of Truth |

Co-authored-by: Gary Snider <75227981+gsnider2195@users.noreply.github.com>
@@ -60,7 +60,8 @@
path("swagger.yaml", SpectacularYAMLAPIView.as_view(), name="schema_yaml"),
# GraphQL
path("graphql/", GraphQLDRFAPIView.as_view(), name="graphql-api"),
# Plugins
# Apps
path("apps/", include((apps_api_patterns, "apps-api"))),
Copy link
Contributor

Choose a reason for hiding this comment

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

Just to confirm my understanding, would this cause duplicate endpoints?

  • /api/apps/my-app/mymodel/
  • /api/plugins/my-app/mymodel/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not currently no, /api/apps/ only contains /installed-apps/ at present. We have a longer-term deliverable to do something with /plugins/app/model/ and /api/plugins/app/model as a generalized solution.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you for clarifying, was concerned on potential bloat of the openAPI schema generation if all app api endpoints where duplicated.



class InstalledPluginsView(AdminRequiredMixin, View):
class InstalledAppsView(LoginRequiredMixin, View):
Copy link
Contributor

Choose a reason for hiding this comment

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

Yay!!! UI has the same permissions now!

@gsnider2195 gsnider2195 merged commit 7499b53 into next Feb 29, 2024
17 checks passed
@gsnider2195 gsnider2195 deleted the u/glennmatthews-5341-plugins-to-apps-ui branch February 29, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants