fix: restore port to overload type hint and json schema #5501
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
JoanFM
requested changes
Dec 7, 2022
docs/concepts/flow/executor-args.md
Outdated
| @@ -7,14 +7,14 @@ | |||
| | `quiet_error` | If set, then exception stack information will not be added to the log | `boolean` | `False` | | |||
| | `timeout_ctrl` | The timeout in milliseconds of the control request, -1 for waiting forever | `number` | `60` | | |||
| | `polling` | The polling strategy of the Deployment and its endpoints (when `shards>1`).<br> Can be defined for all endpoints of a Deployment or by endpoint.<br> Define per Deployment:<br> - ANY: only one (whoever is idle) Pod polls the message<br> - ALL: all Pods poll the message (like a broadcast)<br> Define per Endpoint:<br> JSON dict, {endpoint: PollingType}<br> {'/custom': 'ALL', '/search': 'ANY', '*': 'ANY'} | `string` | `ANY` | | |||
| | `shards` | The number of shards in the deployment running at the same time. For more details check https://docs.jina.ai/concepts/flow/create-flow/#complex-flow-topologies | `number` | `1` | | |||
| | `shards` | The number of shards in the deployment running at the same time. For more details check https://docs.jina.ai/fundamentals/flow/create-flow/#complex-flow-topologies | `number` | `1` | | |||
github-actions
bot
added
size/L
area/cli
JoanFM
approved these changes
Dec 7, 2022
|
📝 Docs are deployed on https://fix-port-protocol-type-hint--jina-docs.netlify.app 🎉 |
Codecov Report
@@ Coverage Diff @@
## master #5501 +/- ##
==========================================
+ Coverage 74.87% 84.81% +9.94%
==========================================
Files 99 101 +2
Lines 6678 6724 +46
==========================================
+ Hits 5000 5703 +703
+ Misses 1678 1021 -657
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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.
As multi port and protocol feature was added, the port argument accepts a CastToIntAction.
Parsing arguments depends on knowing which action is attached to the argument.
Therefore, json schema and inject-cli-overload failed to show the port argument.
This PR fixes this issue and makes the port argument detectable when generating json schema and injecting CLI overload.