Skip to content

Commit

Permalink
More on items/updates subscriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewDonkin-Gallagher committed Nov 22, 2024
1 parent a6651d1 commit 4bcd626
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
6 changes: 3 additions & 3 deletions ref/events.html
Original file line number Diff line number Diff line change
Expand Up @@ -4261,11 +4261,11 @@ <h2 class="operation-title">
<div class="doc-copy">
<section class="swagger-operation-description">
<p>Creates a subscription to status changes. You POST a list of item IDs and the server returns the status flags of those items plus a link. When you GET that link some time later the server will return the items that changed state between the two calls.</p>
<p>If you do not GET the link within thirty seconds of the POST returning, the server will drop your subscription and free up the resources it had allocated to servicing it. Then you will need to send this POST again to create a new subscription.</p>
<p>Your operator must have view privileges on every item in the subscription.</p>
<p>If you do not GET the link within thirty seconds of the POST returning, the server will drop your subscription and free up the resources it had allocated to servicing it. If that happens you will need to send this POST again to create a new subscription.</p>
<p>Your operator must have view privileges on every item in the subscription otherwise you will receive a 4xx.</p>
<p>The subscription notices changes in state, not in configuration, so an operator modifying an item will not cause anything to come out of this API unless the change in configuration also causes a change in state.</p>
<p>Because this call returns the status of items, this call requires the RESTStatus licence.</p>
<p>Added in 8.30.</p>
<p>Added in 8.30. 9.30 corrected the 401 response to a 403.</p>
</section>
</div>
</div>
Expand Down
9 changes: 5 additions & 4 deletions swagger/eventsApi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1940,18 +1940,19 @@ paths:
later the server will return the items that changed state between the two calls.
If you do not GET the link within thirty seconds of the POST returning, the server will drop
your subscription and free up the resources it had allocated to servicing it. Then you will
need to send this POST again to create a new subscription.
your subscription and free up the resources it had allocated to servicing it. If that
happens you will need to send this POST again to create a new subscription.
Your operator must have view privileges on every item in the subscription.
Your operator must have view privileges on every item in the subscription otherwise you will
receive a 4xx.
The subscription notices changes in state, not in configuration, so an operator modifying an
item will not cause anything to come out of this API unless the change in configuration also
causes a change in state.
Because this call returns the status of items, this call requires the RESTStatus licence.
Added in 8.30.
Added in 8.30. 9.30 corrected the 401 response to a 403.
parameters:
- name: "name not rendered for body params"
Expand Down

0 comments on commit 4bcd626

Please sign in to comment.