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 2.0: /api/ui/ Endpoint for Detail View Layout #3526

Closed
1 task
Tracked by #3142
bryanculver opened this issue Apr 3, 2023 · 1 comment · Fixed by #3816
Closed
1 task
Tracked by #3142

UI 2.0: /api/ui/ Endpoint for Detail View Layout #3526

bryanculver opened this issue Apr 3, 2023 · 1 comment · Fixed by #3816
Assignees
Labels
type: feature Introduction of new or enhanced functionality to the application
Milestone

Comments

@bryanculver
Copy link
Member

bryanculver commented Apr 3, 2023

For the 2.0 UI, data will be retrieved from the existing REST API endpoints. However, the UI will need to have some way to determine where the attributes should live in a section on the view.

For example here:
image

The UI will need to know the grouping, ordering, and potentially tab location for what is returned from the REST API response.

This should be viewed as the 80% case (models without heavy view customization) as anything sufficiently more nuanced will need to register its own view.

Models that don't define their own, should still get a response from this endpoint that is fairly generic (all models fields under one section, things like tags can be broken out). Things like Status, Created, Last Updated appears in the title bar and are special cases. API response should inform you of those.

TODO

  • Design and define the convention, and provide Device as an example that overrides the default

Follow-on:

  • Update views to take advantage of this endpoint exists (currently would be blocked by the base views and presentation not existing at the moment)
  • Create backlog for defining overloaded model view definitions
  • Need to address/be able to extend this endpoint for the related objects on detail views (Images, Services, etc from above)
@bryanculver bryanculver added this to the v2.0.0 milestone Apr 3, 2023
@timizuoebideri1 timizuoebideri1 self-assigned this May 23, 2023
@bryanculver bryanculver linked a pull request May 30, 2023 that will close this issue
7 tasks
@bryanculver bryanculver mentioned this issue May 30, 2023
7 tasks
@bryanculver bryanculver added the type: feature Introduction of new or enhanced functionality to the application label May 30, 2023
@bryanculver
Copy link
Member Author

Implemented with #3816

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: feature Introduction of new or enhanced functionality to the application
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants