Add Styx API Overview page to the developer docs. #171
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
dvlato
approved these changes
May 23, 2018
|
|
||
| * Styx API: https://mvnrepository.com/artifact/com.hotels.styx/styx-api | ||
| * Styx API Test Support: https://mvnrepository.com/artifact/com.hotels.styx/styx-api-testsupport | ||
| * Styx Server: https://mvnrepository.com/artifact/com.hotels.styx/styx-server |
There was a problem hiding this comment.
Should we include styx-test-api?
There was a problem hiding this comment.
Yes. Lets do that as a separate increment.
docs/developer-guide/api-overview.md
Outdated
| Note that the HTTP content streams represents live network traffic streaming | ||
| through Styx core. The content stream is not memoized nor stored. | ||
| When the content is gone, it is gone for good. | ||
| Therefore a `HttpRequest` (`HttpResponse`) can be aggreaged to a full |
docs/developer-guide/api-overview.md
Outdated
| aggregated asynchronously. Obviously because the rest of the content | ||
| stream are yet to be received from the network. | ||
|
|
||
| * The `maxContentBytes` is the maximum sets the upper limit for the message |
There was a problem hiding this comment.
can you revise the he 'is the maximum / sets the upper limit ' part?
docs/developer-guide/api-overview.md
Outdated
| public HttpRequest toStreamingRequest() | ||
| ``` | ||
|
|
||
| As the method sinature reveals a `HttpResponse` is available immediately. |
docs/developer-guide/api-overview.md
Outdated
| ``` | ||
|
|
||
| As the method sinature reveals a `HttpResponse` is available immediately. | ||
| Also because the content is permanently stored in full, you can clone a |
There was a problem hiding this comment.
Maybe someone can review this. Since instead of because?
docs/developer-guide/api-overview.md
Outdated
|
|
||
| ### Http Interceptor Interface | ||
|
|
||
| A HTTP interceptor is an object transforms, responds, or runs side-effecting actions |
docs/developer-guide/api-overview.md
Outdated
|
|
||
| The chain also contains a request context which can be obtained with a | ||
| call to `chain.context()`. It is a set of key-value properties associated | ||
| with the request. Plugins may store some information in the context. So does |
There was a problem hiding this comment.
Review the "So does styx core..." bit?
docs/developer-guide/api-overview.md
Outdated
| facilitates asynchronous event handling, modelled after Rx | ||
| [observables](http://reactivex.io/documentation/observable.html). | ||
|
|
||
| However `rx.Observable` is very generic reactive stream abstraction. |
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.
No description provided.