Skip to content

Commit

Permalink
Update http example docs index (#1187)
Browse files Browse the repository at this point in the history
Motivation:
The mutual-tls and uds examples were added recently but the example docs index doesn't include them.
  • Loading branch information
Scottmitch authored Oct 15, 2020
1 parent a25e994 commit c3b3504
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
** xref:{page-version}@servicetalk-examples::http/index.adoc#JAXRS[JAX-RS]
** xref:{page-version}@servicetalk-examples::http/index.adoc#MetaData[MetaData]
** xref:{page-version}@servicetalk-examples::http/index.adoc#HTTP2[HTTP/2]
** xref:{page-version}@servicetalk-examples::http/index.adoc#Mutual-TLS[Mutual TLS]
** xref:{page-version}@servicetalk-examples::http/index.adoc#uds[Unix Domain Sockets]
** xref:{page-version}@servicetalk-examples::http/service-composition.adoc[Service Composition]
* xref:{page-version}@servicetalk-examples::grpc/index.adoc[gRPC]
** xref:{page-version}@servicetalk-examples::grpc/index.adoc#HelloWorld[Hello World]
Expand Down
3 changes: 1 addition & 2 deletions servicetalk-examples/docs/modules/ROOT/pages/grpc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,4 @@ xref:{page-version}@servicetalk::programming-paradigms.adoc#asynchronous-and-str
== Protoc Options

This example demonstrates how options for the servicetalk-grpc-protoc plugin can be used. See
* link:{source-root}/servicetalk-examples/grpc/routeguide/src/main/java/io/servicetalk/examples/grpc/protoc-options[protoc-options]
for more details.
link:{source-root}/servicetalk-examples/grpc/protoc-options[protoc-options] for more details.
9 changes: 9 additions & 0 deletions servicetalk-examples/docs/modules/ROOT/pages/http/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,12 @@ builder API is the same across all the HTTP APIs.

An advanced example which demonstrates a composition of various ServiceTalks services in one application.
For more information see xref:http/service-composition.adoc[Service Composition].

[#uds]
== Unix Domain Sockets (UDS)

This example demonstrates how client and server can use unix domain sockets. See
the link:{source-root}/servicetalk-examples/http/uds[uds example code] for more details.

NOTE: This example uses the link:#blocking-aggregated[blocking + aggregated] API, as the UDS configuration API is the
same across all the HTTP APIs.

0 comments on commit c3b3504

Please sign in to comment.