Patch of documentation to address #267 (lack of statusInfo in SessionInfo)
#269
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hdamker
changed the title
statusInfo in SessionInfostatusInfo in SessionInfo)
Added correct version number
Co-authored-by: Randy Levensalor <randymartini@gmail.com>
|
@RandyLevensalor @eric-murray Would you do your final review ... I will prepare the patch release as soon this is merged. |
jlurien
reviewed
Mar 18, 2024
| @@ -104,7 +104,7 @@ paths: | |||
| NOTE: in case of a `QOS_STATUS_CHANGED` event with `qosStatus` as `UNAVAILABLE` and `statusInfo` as `NETWORK_TERMINATED` the resources of the QoS session | |||
| are not directly released, but will get deleted automatically at earliest 360 seconds after the event. | |||
| This behavior allows clients which are not receiving notification events but are polling to get the session information with | |||
| the `qosStatus` `UNAVAILABLE` and `statusInfo` `NETWORK_TERMINATED`. Before a client can attempt to create a new QoD session | |||
| the `qosStatus` `UNAVAILABLE` (the `statusInfo` parameter is not included in the current version but will be adding to `SessionInfo` in an upcoming release). Before a client can attempt to create a new QoD session | |||
There was a problem hiding this comment.
Suggested change
| the `qosStatus` `UNAVAILABLE` (the `statusInfo` parameter is not included in the current version but will be adding to `SessionInfo` in an upcoming release). Before a client can attempt to create a new QoD session | |
| the `qosStatus` `UNAVAILABLE` (the `statusInfo` parameter is not included in the current version but will be added to `SessionInfo` in an upcoming release). Before a client can attempt to create a new QoD session |
jlurien
approved these changes
Mar 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
Clarifying that only the
qosStatuscan be polled, but not thestatusInfowhich is provided only withinEventQosStatusChangedWhich issue(s) this PR fixes:
This documentation patch does not fix the issue #267 finally.
Special notes for reviewers:
While creating this PR, I'm not any more sure that we should fix the issue in this way, even short-term. Instead there is the option to create a patch release v0.10.1 which adds the
statusInfoalso toSessionInfo.Left the version number open for discussion.
Changelog input
Additional documentation
This section can be blank.