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.

Sign up for GitHub

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

Jump to bottom

Update docs #927

Merged
merged 2 commits into from
Oct 4, 2021
Merged

Update docs #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4e56b7
Fix typo in `build-config.rst`
david-perez Oct 4, 2021
544e16f
Add missing `put` lifecycle operation in quickstart
david-perez Oct 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/1.0/guides/building-models/build-config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ A projection accepts the following configuration:
- Defines the plugins to apply to the model when building this
projection. Plugins are a mapping of plugin names to an arbitrary
plugin configuration object. smithy-build will attempt to resolve
plugin names using `Java SPI`_ to locate and instance of ``software.amazon.smithy.build.SmithyBuildPlugin``
plugin names using `Java SPI`_ to locate an instance of ``software.amazon.smithy.build.SmithyBuildPlugin``
that returns a matching name when calling ``getName``. smithy-build will
emit a warning when a plugin cannot be resolved.

Expand Down
11 changes: 6 additions & 5 deletions docs/source/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,11 +295,12 @@ resource.
Defining operations
===================

The ``create``, ``read``, ``update``, ``delete``, and ``list`` properties of a
resource are used to define the :ref:`lifecycle operations <lifecycle-operations>`
of a resource. Lifecycle operations are the canonical methods used to read and
transition the state of a resource using well-defined semantics. Defining
lifecycle operations helps automated tooling reason about your API.
The ``put``, ``create``, ``read``, ``update``, ``delete``, and ``list``
properties of a resource are used to define the :ref:`lifecycle operations
<lifecycle-operations>` of a resource. Lifecycle operations are the canonical
methods used to read and transition the state of a resource using well-defined
semantics. Defining lifecycle operations helps automated tooling reason about
your API.

Let's define the operation used to "read" a ``City``.

Expand Down