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.

Sign up for GitHub

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

Update Interoperability - IS-04.md #32

Merged
merged 1 commit into from
Nov 23, 2023
Merged

Update Interoperability - IS-04.md #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/Interoperability - IS-04.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ When the Node does not support annotation of Sources or Flows, the response to a

## Version Increments

In order to prevent unnecessary polling of the APIs, changes to any resource properties via the Annotation API also update the corresponding IS-04 resource and are therefore signalled via the IS-04 versioning mechanism.
In order to prevent unnecessary polling of the APIs, changes to any resource properties via the Annotation API also update the corresponding IS-04 resource and are therefore signalled via the [IS-04 versioning mechanism](https://specs.amwa.tv/is-04/latest/docs/APIs_-_Common_Keys.html#version).
When a successful `PATCH` request is made, the `version` attribute is incremented.
The `version` reported in the Annotation API is also updated whenever the corresponding IS-04 resource is updated.

Note: In registered operation, [IS-04 registration updates](https://specs.amwa.tv/is-04/latest/docs/Behaviour_-_Registration.html#registration-updates) enable Controllers to receive notifications of the changes via Query API WebSocket subscriptions.