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

Use with APIs besides IS-04 #17

Open
garethsb opened this issue May 13, 2023 · 2 comments
Open

Use with APIs besides IS-04 #17

garethsb opened this issue May 13, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@garethsb
Copy link
Contributor

garethsb commented May 13, 2023

IS-11 introduces Input and Output resources, which both have a /properties endpoint that uses the same IS-04 resource_core.json schema. Like IS-04, the label, description and tags of these resources are currently read-only.

Should IS-13 support these IS-11 resources or future additions to the shared NMOS data model somehow?

One difference that would currently make updating these Input/Output resources less useful is that they aren't registered and discoverable via the Query API.

In any case, another possibility would be that IS-11 directly adds support for an IS-13-like PATCH since it's not published yet...

(IS-08 also introduced Input and Output resources though I think these seem second tier, acting as they do as the interface between the Channel Map and Sources, Receivers or non-network I/O interfaces. IS-08 Inputs and Outputs do also have a read-only /properties endpoint, but it doesn't follow the same schema, having name (cf. label) and description but no tags. IS-08 also uses a more general identifier format rather than UUIDs.)

@garethsb
Copy link
Contributor Author

During 2022-05-18 call, we discussed whether IS-13 Read/Write Node API functionality should actually be provided by the Node API itself, e.g. in an IS-04 v1.4.

Possible pros and cons:

  • maybe simplify a Node implementation as it doesn't need to provide different filtered views on the same data (or keep two copies in sync!), though nodes already need to do this to support multiple versions of the Node API
  • maybe simplify a Controller implementation as it doesn't need to discover the Read/Write Node API via Node services but can just use the new PATCH verb if the API supports v1.4, though clients already have to do similar to discover Connection API, Channel Mapping API, etc.

We also considered the IS-13 API being "write only" (PATCH but no GET verbs at all) but decided this isn't discoverable.

@peterbrightwell
Copy link
Contributor

peterbrightwell commented Nov 23, 2023

2023-11-23 call: group decided this could be part of v1.1 if there is support from IS-11 implementers/users. Add enhancement label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants