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

Entire resources or just ID/path lists under resource types? #20

Closed
garethsb opened this issue May 22, 2023 · 0 comments · Fixed by #21
Closed

Entire resources or just ID/path lists under resource types? #20

garethsb opened this issue May 22, 2023 · 0 comments · Fixed by #21

Comments

@garethsb
Copy link
Contributor

Under /node/{resourceType}/ we currently have an array of whole resources like Node API.
But now that we're not slavishly following the Node API, since we have that /node/ base path, would it be cleaner to just have just ID/path list responses like from e.g. Connection API /single/senders/?

I.e.

GET /x-nmos/annotation/v1.0/node/senders/

would return

[
  "c72cca5b-01db-47aa-bb00-03893defbfae/",
  "171d5c80-7fff-4c23-9383-46503eb1c63e/",
  "a2655c48-8a46-4c82-b9bc-98760d59d7f8/"
]

instead of

[
  {
    "id": "c72cca5b-01db-47aa-bb00-03893defbfae",
    "label": "Foo",
    ...
  },
  {
    "id": "171d5c80-7fff-4c23-9383-46503eb1c63e",
    "label": "Bar",
    ...
  },
  {
    "id": "a2655c48-8a46-4c82-b9bc-98760d59d7f8"
    "label": "Baz",
    ...
  }
]
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 a pull request may close this issue.

1 participant