From 1efd928206012bf9dd278c0532e4238d44193d69 Mon Sep 17 00:00:00 2001 From: Tin Lam Date: Sun, 21 Jan 2018 02:44:37 -0600 Subject: [PATCH] Fix typos This patch set fixes a handful of typographical errors in the documents. Change-Id: Ic2b590dcf4d16ae35ed88bdc606d4bcfb2d9dd58 Signed-off-by: Tin Lam --- doc/source/api_ref.rst | 2 +- doc/source/document_types.rst | 4 ++-- doc/source/overview.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/api_ref.rst b/doc/source/api_ref.rst index 3e07a2d4..3c2109ce 100644 --- a/doc/source/api_ref.rst +++ b/doc/source/api_ref.rst @@ -95,7 +95,7 @@ abstract documents will be returned. This is the primary endpoint that consumers will interact with for their configuration. Valid query parameters are the same as for -``/revisions/{revision_id}/documents``, minus the paremters in +``/revisions/{revision_id}/documents``, minus the parameters in ``metadata.layeringDetinition``, which are not supported. Raises a ``409 Conflict`` if a ``layeringPolicy`` document could not be found. diff --git a/doc/source/document_types.rst b/doc/source/document_types.rst index b72feed6..0bc36428 100644 --- a/doc/source/document_types.rst +++ b/doc/source/document_types.rst @@ -31,7 +31,7 @@ DataSchema ``DataSchema`` documents are used by various services to register new schemas that Deckhand can use for validation. No ``DataSchema`` documents with names -beginning with ``deckhand/`` or ``metadata/`` are allowed. Tme ``metadata.name`` +beginning with ``deckhand/`` or ``metadata/`` are allowed. The ``metadata.name`` field of each ``DataSchema`` document specifies the top level ``schema`` that it is used to validate. @@ -89,7 +89,7 @@ allows services to check whether a particular revision (described below) of documents meets a configurable set of validations without having to know up front the complete list of validations. -Each validation ``name`` specified here is a reference to data that is postable +Each validation ``name`` specified here is a reference to data that is POSTable by other services. Names beginning with ``deckhand`` are reserved for internal use. See the Validation section below for more details. diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 74e52d79..d4932775 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -70,7 +70,7 @@ to user-provided JSON schemas. .. note:: While Deckhand ingests YAML documents, internally it translates them to - Python objects and can use JSON schemas to valdiate those objects. + Python objects and can use JSON schemas to validate those objects. For more information, see the :ref:`validation` section.