Fix typo on --http-api-update environment variable and add warning note for --http-api-periodic-polls #1195
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
Fix a typo for the environment variable to enable HTTP API mode.
--http-api-periodic-polls is a new option which isn't available currently, until a new release is made.
Codecov Report
@@ Coverage Diff @@
## main #1195 +/- ##
=======================================
Coverage 62.75% 62.75%
=======================================
Files 23 23
Lines 1490 1490
=======================================
Hits 935 935
Misses 471 471
Partials 84 84 Continue to review full report at Codecov.
|
piksel
approved these changes
Jan 22, 2022
Co-authored-by: nils måsén <nils@piksel.se>
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.
Minor docs issue, but the --http-api-update parameter has a typo on it's env var equivalent. Using the env var provided by the docs will not enable the HTTP API update only endpoint and you'll get a 404.
In addition due to #1127, the docs are currently listing a parameter which isn't actually available in any official release currently, so I thought a warning may be useful until a new release is made, which can then be removed.Thanks!