Version 3.0.0 #9
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
JakeChampion
approved these changes
Jan 10, 2017
JakeChampion
approved these changes
Jan 11, 2017
lucas42
reviewed
Jan 11, 2017
| - `about`: (Optional) Object containing standard runbook properties as defined in the [ft about endpoint standard], or a Promise that resolves to an object containing these properties | ||
| - `goodToGoTest`: (Optional) A function that can be used to indicate the good to go status of the service, the function should return a Promise resolved with `true` to indicate a positive good to go status, and `false` to indicate a negative good to go status | ||
| - `healthCheck`: (Optional) A function that can be used to generate structured healthcheck information, the function should return a Promise resolved with an array of healthcheck objects | ||
| - `routes`: (Optional) An array of routes to install. Possible values are `health`, `gtg`, `about` and `error`. Defaults to `["health", "gtg", "about"]` |
There was a problem hiding this comment.
I'm not sure this is immediately clear. I had to read the code before I got what it means. Perhaps an example would help?
There was a problem hiding this comment.
Good idea, will add an issue for this
| - `about`: (Optional) Object containing standard runbook properties as defined in the [ft about endpoint standard], or a Promise that resolves to an object containing these properties | ||
| - `goodToGoTest`: (Optional) A function that can be used to indicate the good to go status of the service, the function should return a Promise resolved with `true` to indicate a positive good to go status, and `false` to indicate a negative good to go status | ||
| - `healthCheck`: (Optional) A function that can be used to generate structured healthcheck information, the function should return a Promise resolved with an array of healthcheck objects | ||
| - `routes`: (Optional) An array of routes to install. Possible values are `health`, `gtg`, `about` and `error`. Defaults to `["health", "gtg", "about"]` |
There was a problem hiding this comment.
I'm not sure this is immediately clear. I had to read the code before I got what it means. Perhaps an example would help?
| }; | ||
|
|
||
| // Serve the __gtg endpoint | ||
| // TODO |
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.
This work forms the basis of v3.0.0 switches to a middleware-based API. Aside from the rename from
express-ftwebserviceto@financial-times/express-web-service, the key differences are illustrated here:This partly resolves #5 – we now create standard Express middleware. You can't access the
requestobject in the about endpoint, but it can now be generated asynchronously.The best way to view any breaking changes is to read the migration guide.