Editorial updates of documentation QoD_API.md #76
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
added
documentation
hdamker
requested review from
akoshunyadi,
eric-murray,
jlurien,
jpengar,
patrice-conil and
SylMOREL
|
@akoshunyadi @shilpa-padgaonkar @eric-murray @jlurien @jpengar @patrice-conil @SylMOREL @tlohmar: would be great if some of you can have a look and approve the changes. Also further suggestions for editorial changes/corrections are welcome. |
shilpa-padgaonkar
approved these changes
Jan 3, 2023
jlurien
reviewed
Jan 3, 2023
| </tr> | ||
| <tr> | ||
| <td rowspan=7><b>Response</b></td> | ||
| <td><b>200: Session created</b></td> |
There was a problem hiding this comment.
Suggested change
| <td><b>200: Session created</b></td> | |
| <td><b>201: Session created</b></td> |
| <td> | ||
| <p>The identifier for the user equipment (device). The developer can choose to provide the below specified user equipment identifiers:</p> | ||
| <ul> | ||
| <li>IPv4 address (supports mask) e.g. 192.168.0.1/24</li> |
There was a problem hiding this comment.
Suggested change
| <li>IPv4 address (supports mask) e.g. 192.168.0.1/24</li> | |
| <li>ipv4addr: IPv4 address (supports mask) e.g. 192.168.0.1/24</li> |
| <p>The identifier for the user equipment (device). The developer can choose to provide the below specified user equipment identifiers:</p> | ||
| <ul> | ||
| <li>IPv4 address (supports mask) e.g. 192.168.0.1/24</li> | ||
| <li>ipv6 address (supports mask) e.g. 2001:db8:85a3:8d3:1319:8a2e:370:7344</li> |
There was a problem hiding this comment.
Suggested change
| <li>ipv6 address (supports mask) e.g. 2001:db8:85a3:8d3:1319:8a2e:370:7344</li> | |
| <li>ipv6addr: IPv6 address (supports mask) e.g. 2001:db8:85a3:8d3:1319:8a2e:370:7344</li> |
| <td> | ||
| <p>The identifier used for application server. The developer can choose from the below application server identifiers:</p> | ||
| <ul> | ||
| <li>ipv4 address (supports mask) e.g. 192.168.0.1/24</li> |
There was a problem hiding this comment.
Suggested change
| <li>ipv4 address (supports mask) e.g. 192.168.0.1/24</li> | |
| <li>ipv4addr: IPv4 address (supports mask) e.g. 192.168.0.1/24</li> |
| <p>The identifier used for application server. The developer can choose from the below application server identifiers:</p> | ||
| <ul> | ||
| <li>ipv4 address (supports mask) e.g. 192.168.0.1/24</li> | ||
| <li>ipv6 address (supports mask) e.g. 2001:db8:85a3:8d3:1319:8a2e:370:7344 |
There was a problem hiding this comment.
Suggested change
| <li>ipv6 address (supports mask) e.g. 2001:db8:85a3:8d3:1319:8a2e:370:7344 | |
| <li>ipv6addr: IPv6 address (supports mask) e.g. 2001:db8:85a3:8d3:1319:8a2e:370:7344 |
|
@hdamker I see you have just merged this branch. At least we should correct 201 for createSession, other suggestions are more cosmetic |
|
@jlurien thanks for your comments, will change them within a new PR. |
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.
After the content update for v0.8.0 with #71 here some editorial fixes within QoD_API.md, also to create a stable base for further updates/PRs:
Will close #58
NOTE: this PR is not about correcting content issues (like error code etc), these should be raised as issues, especially if also the API definition YAML need to be changed