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

Emit docs for API services #3091

Open
htuch opened this issue Apr 16, 2018 · 5 comments
Open

Emit docs for API services #3091

htuch opened this issue Apr 16, 2018 · 5 comments
Labels
api/v3 Major version release @ end of Q3 2019 area/docs help wanted Needs help! priority/high

Comments

@htuch
Copy link
Member

htuch commented Apr 16, 2018

Start with the access log API services.

Migrated from https://github.com/envoyproxy/data-plane-api/issues/351

@mattklein123 mattklein123 added the help wanted Needs help! label May 12, 2018
@htuch htuch added api/v4 Major version release @ end of Q3 2020 and removed api/v2 labels Aug 29, 2019
@htuch
Copy link
Member Author

htuch commented Jan 6, 2020

We should also make use of the resource type annotations in #9566 here.

@htuch htuch added api/v3 Major version release @ end of Q3 2019 and removed api/v4 Major version release @ end of Q3 2020 labels Mar 12, 2020
@ankatare
Copy link
Contributor

@htuch url as mentioned in description is notopening.

this one: https://github.com/envoyproxy/data-plane-api/issues/351

@htuch
Copy link
Member Author

htuch commented Jan 15, 2021

@ankatare not sure why that no longer works, but I think the title captures what we want here. We have a bunch of service definitions in api/envoy. These are not rendered via protodoc today but it would be good to have some output here to describe the gRPC and HTTP services, e.g.

// Return list of all clusters this proxy will load balance to.
.

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 protodoc.

CC @phlax for docs visibility.

@ankatare
Copy link
Contributor

ankatare commented Feb 2, 2021

@htuch ok. Thanks for detailed explanations. let me check this

@ankatare
Copy link
Contributor

/assign

@ankatare ankatare removed their assignment Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api/v3 Major version release @ end of Q3 2019 area/docs help wanted Needs help! priority/high
Projects
None yet
Development

No branches or pull requests

3 participants