Add documentation about websockets #2017
Merged
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
| "url": "/uri/used/to/this/operation", | ||
| "params": {"key": "value"}, | ||
| "headers": {"key": "value"}, | ||
| "payload" : {Put a normal REST message here} |
There was a problem hiding this comment.
Instead of "Put a normal REST message here" I would suggest "Payload corresponding to the operation according to the REST API".
|
Apart of the documentation elements in this PR, please have a look to PR #1823 about building information. |
| } | ||
| } | ||
| ``` | ||
| A very important detail is the callback field, always must be "ws://" this say to Orion how notificacation must be send. |
There was a problem hiding this comment.
... callback field, which must always be exactly "ws://" - this tells Orion how notificacations are to be sent.
| { | ||
| "verb" : "POST", | ||
| "url" : "/v2/entities/E1", | ||
| "headers": {"Fiware-service": "my_Fiware-service"}, |
There was a problem hiding this comment.
Note that - is not allowed in service paths (http://fiware-orion.readthedocs.org/en/develop/user/service_path/):
only alphanum and underscore allowed
I'd suggest to use my_service.
|
LGTM |
1 similar comment
|
LGTM |
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.
Markdown documentation for websockets usage