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
Conversation
Codecov Report
@@ Coverage Diff @@
## master #5456 +/- ##
=======================================
Coverage 87.28% 87.28%
=======================================
Files 101 101
Lines 6615 6616 +1
=======================================
+ Hits 5774 5775 +1
Misses 841 841
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. |
@@ -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>]` | |
There was a problem hiding this comment.
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
📝 Docs are deployed on https://docs-fix-port-protocol-desc--jina-docs.netlify.app 🎉 |
Provide more accurate description for port and protocol parameters of the gateway