Skip to content

Commit 514ba1b

Browse files
authored
DOCSP-30532: stable api tech review (#40)
1 parent e9ea564 commit 514ba1b

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

source/fundamentals/stable-api.txt

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,14 @@ To learn more about the commands that the server covers, see
3939
Specify an API Version
4040
----------------------
4141

42-
To specify an API version, define a ``ServerApi`` struct and set the ``server_api`` field
43-
of your ``ClientOptions`` instance to this struct.
44-
The ``ServerApi`` struct contains your server API version and options.
45-
To learn more about the options, see the :ref:`Modify Behavior <rust-stable-api-options>` section of this guide.
42+
To specify an API version, define a ``ServerApi`` struct and set the
43+
``server_api`` field of your ``ClientOptions`` instance to this struct.
44+
The ``ServerApi`` struct contains the API version and options.
45+
To learn more about setting options, see the :ref:`Modify Behavior
46+
<rust-stable-api-options>` section of this guide.
4647

47-
After you specify an API version, the client runs operations that are compatible with the API version.
48+
After you specify an API version, the client runs only operations that
49+
are compatible with that version.
4850

4951
.. note::
5052

@@ -81,10 +83,10 @@ While you can set the fields in a ``ServerApi`` struct manually, you can use the
8183

8284
* - ``version``
8385
- | The {+stable-api+} version to use.
84-
| Specified with the ``ServerAPIVersion`` enum.
86+
| Specified with the ``ServerApiVersion`` enum. The only
87+
accepted value is ``V1``.
8588

86-
| Type: ``ServerAPIVersion``
87-
| Default: ``ServerAPIVersion1``
89+
| Type: ``ServerApiVersion``
8890

8991
* - ``strict``
9092
- | Indicates whether the server should return errors for features that aren't part of the API version.
@@ -129,7 +131,6 @@ guide, see the following API Documentation:
129131

130132
- `Client <{+api+}/struct.Client.html>`__
131133
- `ClientOptions <{+api+}/options/struct.ClientOptions.html>`__
132-
- `ServerAPI <{+api+}/options/struct.ServerApi.html>`__
134+
- `ServerApi <{+api+}/options/struct.ServerApi.html>`__
133135
- `ServerApiVersion <{+api+}/options/enum.ServerApiVersion.html>`__
134-
- `with_options() <{+api+}/options/struct.Client.html#method.with_options>`__
135-
136+
- `with_options() <{+api+}/options/struct.Client.html#method.with_options>`__

0 commit comments

Comments
 (0)