From 56cf7c12d8306bbbfa1530f02250e7f4da63d4b6 Mon Sep 17 00:00:00 2001 From: Ken Gilmer Date: Tue, 9 Jun 2020 16:29:59 -0700 Subject: [PATCH] Update broken link to Sphinx project. Add link to endpoint trait spec upon first mention of endpoint in http protocol spec. Update description of endpoint based on PR feedback. Update wording of endpoint URI clarification based on PR feedback. --- docs/README.md | 2 +- docs/source/1.0/spec/core/http-traits.rst | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 51fa6488ffe..fd4b9688d53 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,7 +5,7 @@ This package is the Smithy website, specification, and project documentation. ## Building -The Smithy docs are built using [Sphinx](https://www.sphinx-doc.org/en/stable), +The Smithy docs are built using [Sphinx](https://www.sphinx-doc.org/en/master), which requires python. Once you have python installed, you need to install the dependencies and local diff --git a/docs/source/1.0/spec/core/http-traits.rst b/docs/source/1.0/spec/core/http-traits.rst index 9aea2b62bb8..19bffbaa333 100644 --- a/docs/source/1.0/spec/core/http-traits.rst +++ b/docs/source/1.0/spec/core/http-traits.rst @@ -120,7 +120,8 @@ request URI and labels which are used to insert named components into the request URI. The resolved absolute URI of an operation is formed by combining the URI of -the operation with the endpoint of the service. For example, given a service +the operation with the endpoint of the service. (that is, the host and any +base URL of where the service is deployed). For example, given a service endpoint of ``https://example.com/v1`` and an operation pattern of ``/myresource``, the resolved absolute URI of the operation is ``https://example.com/v1/myresource``.