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

Dev/foxglove dashboards #16

Closed
wants to merge 6 commits into from
Closed

Conversation

Guillaumebeuzeboc
Copy link
Collaborator

@Guillaumebeuzeboc Guillaumebeuzeboc commented Feb 19, 2024

  • Store foxglove layouts in the database
  • Expose foxglove layouts json files from the API

Successfully tested with Foxglove in ROB COS.

@Guillaumebeuzeboc Guillaumebeuzeboc changed the base branch from main to doc/docstrings February 21, 2024 09:35
@@ -9,4 +9,9 @@
# make a version API url
path("v1/devices", views.devices, name="devices"),
path("v1/devices/<str:uid>", views.device, name="device"),
path(
"v1/devices/<str:uid>/foxglove_layouts/<str:layout_uid>",
Copy link

Choose a reason for hiding this comment

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

Wouldn't it be better for the layout_uid to be a query param ? foxglove_layouts/some_name vs foxglove_layouts?layout=some_name.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No strong opinions but usually path are for resources on the server and parameters for performing action (download a file, connect to a remote, sort, filter).
The stack exchange doc seems to follow that: https://api.stackexchange.com/docs

Copy link

Choose a reason for hiding this comment

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

My (rough) understanding was that paths are for things that won't change while params are for things that may change (e.g. v1 or devices will never change while the name of a layout may change).
That's why we need to put that on paper ^^

Base automatically changed from doc/docstrings to main February 21, 2024 16:31
@Guillaumebeuzeboc Guillaumebeuzeboc marked this pull request as draft March 15, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants