Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix port and protocol description for the gateway #5456

Merged
merged 5 commits into from Nov 28, 2022

Conversation

alaeddine-13
Copy link
Contributor

Provide more accurate description for port and protocol parameters of the gateway

@github-actions github-actions bot added size/XS area/core This issue/PR affects the core codebase labels Nov 25, 2022
@alaeddine-13 alaeddine-13 reopened this Nov 25, 2022
@github-actions github-actions bot added size/S area/docs This issue/PR affects the docs labels Nov 25, 2022
@codecov
Copy link

codecov bot commented Nov 25, 2022

Codecov Report

Merging #5456 (75efad9) into master (f66a381) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #5456   +/-   ##
=======================================
  Coverage   87.28%   87.28%           
=======================================
  Files         101      101           
  Lines        6615     6616    +1     
=======================================
+ Hits         5774     5775    +1     
  Misses        841      841           
Flag Coverage Δ
jina 87.28% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
jina/orchestrate/flow/base.py 90.48% <ø> (ø)
jina/parsers/orchestrate/runtimes/remote.py 100.00% <ø> (ø)
jina/parsers/orchestrate/pod.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@@ -19,7 +19,7 @@
| `ssl_certfile` | the path to the certificate file | `string` | `None` |
| `ssl_keyfile` | the path to the key file | `string` | `None` |
| `expose_graphql_endpoint` | If set, /graphql endpoint is added to HTTP interface. | `boolean` | `False` |
| `protocol` | Possible communication protocols between server and client. Depending on your chosen gateway, choose the convenient protocols from: ['GRPC', 'HTTP', 'WEBSOCKET']. | `array` | `[<GatewayProtocolType.GRPC: 0>]` |
| `protocol` | Communication protocol of the server exposed by the Gateway. Depending on your chosen Gateway, choose the convenient protocols from: ['GRPC', 'HTTP', 'WEBSOCKET']. | `array` | `[<GatewayProtocolType.GRPC: 0>]` |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should say it can be a list

@JoanFM JoanFM closed this Nov 28, 2022
@JoanFM JoanFM reopened this Nov 28, 2022
@github-actions github-actions bot added the area/cli This issue/PR affects the command line interface label Nov 28, 2022
@github-actions
Copy link

📝 Docs are deployed on https://docs-fix-port-protocol-desc--jina-docs.netlify.app 🎉

@alaeddine-13 alaeddine-13 merged commit 47da80b into master Nov 28, 2022
@alaeddine-13 alaeddine-13 deleted the docs-fix-port-protocol-desc branch November 28, 2022 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli This issue/PR affects the command line interface area/core This issue/PR affects the core codebase area/docs This issue/PR affects the docs size/S size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants