-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Emit docs for API services #3091
Comments
We should also make use of the resource type annotations in #9566 here. |
@htuch url as mentioned in description is notopening. this one: https://github.com/envoyproxy/data-plane-api/issues/351 |
@ankatare not sure why that no longer works, but I think the title captures what we want here. We have a bunch of
Today, we manually put these descriptions together in https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/xds_api.html?highlight=clusterdiscoveryservice#post--envoy.service.cluster.v3.ClusterDiscoveryService-StreamClusters. We describe the request/response messages in https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/service, but not what the gRPC and HTTP service methods look like. Ultimately, I think this bug involves automatically generating what we have today in https://www.envoyproxy.io/docs/envoy/latest/configuration/overview/xds_api.html?highlight=clusterdiscoveryservice#post--envoy.service.cluster.v3.ClusterDiscoveryService-StreamClusters from the service descriptors, and linking them to the relevant request/response messages in https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/service, again, done programatically via CC @phlax for docs visibility. |
@htuch ok. Thanks for detailed explanations. let me check this |
/assign |
Start with the access log API services.
Migrated from https://github.com/envoyproxy/data-plane-api/issues/351
The text was updated successfully, but these errors were encountered: