Document federated-api configuration
#121
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
✅ Deploy Preview for open-terms-archive-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
MattiSG
reviewed
Mar 27, 2024
content/api/federated.en.md
Outdated
| "sendMailOnError": { // Can be set to `false` if sending email on error is not needed | ||
| "to": "The address to send the email to in case of an error", | ||
| "from": "The address from which to send the email", | ||
| "sendWarnings": "Boolean. Set to true to also send email in case of warning", |
There was a problem hiding this comment.
It would be useful to provide the default value.
content/api/federated.en.md
Outdated
|
|
||
| ```js | ||
| { | ||
| "port": "Port number on which the server will listen for incoming connections", |
There was a problem hiding this comment.
The default value should be provided.
clementbiron
approved these changes
Mar 27, 2024
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
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.