Skip to content
Permalink
Browse files
Use double back-ticks in src/api/server/authn.rst (#669)
* Use double backticks in src/api/server/authn.rst

* Review update: Add double backticks for config/code only
  • Loading branch information
deepakchethan committed Jul 9, 2021
1 parent c5bbad0 commit 0603a30ba4c327e962682c8a8384beb64824b791
Showing 21 changed files with 100 additions and 100 deletions.
@@ -36,7 +36,7 @@
- :mimetype:`text/event-stream`
- :mimetype:`text/plain`
:<header Last-Event-ID: ID of the last events received by the server on a
previous connection. Overrides `since` query parameter.
previous connection. Overrides ``since`` query parameter.
:query array doc_ids: List of document IDs to filter the changes feed as
valid JSON array. Used with :ref:`_doc_ids <changes/filter/doc_ids>`
filter. Since `length of URL is limited`_, it is better to use
@@ -75,11 +75,11 @@
Default is ``false``.
:query boolean attachments: Include the Base64-encoded content of
:ref:`attachments <api/doc/attachments>` in the documents that
are included if `include_docs` is ``true``. Ignored if `include_docs`
are included if ``include_docs`` is ``true``. Ignored if ``include_docs``
isn't ``true``. Default is ``false``.
:query boolean att_encoding_info: Include encoding information in attachment
stubs if `include_docs` is ``true`` and the particular attachment is
compressed. Ignored if `include_docs` isn't ``true``.
stubs if ``include_docs`` is ``true`` and the particular attachment is
compressed. Ignored if ``include_docs`` isn't ``true``.
Default is ``false``.
:query number last-event-id: Alias of `Last-Event-ID` header.
:query number limit: Limit number of result rows to the specified value
@@ -206,7 +206,7 @@
unavailable, alternative replicas are selected, and the last known
checkpoint between them is used. If this happens, you might see changes
again that you have previously seen. Therefore, an application making use
of the `_changes` feed should be ‘idempotent’, that is, able to receive the
of the ``_changes`` feed should be ‘idempotent’, that is, able to receive the
same data multiple times, safely.

.. note::
@@ -488,7 +488,7 @@ The list of combination operators:
}
The ``$and`` operator matches if all the selectors in the array match. Below is
an example using the primary index (```_all_docs```):
an example using the primary index (``_all_docs``):

.. code-block:: javascript
@@ -648,7 +648,7 @@ Condition Operators
-------------------

Condition operators are specific to a field, and are used to evaluate the value
stored in that field. For instance, the basic `$eq` operator matches when the
stored in that field. For instance, the basic ``$eq`` operator matches when the
specified field contains a value that is equal to the supplied argument.

.. note::
@@ -890,7 +890,7 @@ Example of selective retrieval of fields from matching documents:
Pagination
==========

Mango queries support pagination via the bookmark field. Every `_find`
Mango queries support pagination via the bookmark field. Every ``_find``
response contains a bookmark - a token that CouchDB uses to determine
where to resume from when subsequent queries are made. To get the next
set of query results, add the bookmark that was received in the previous
@@ -988,7 +988,7 @@ built using MapReduce Views.
:>header Transfer-Encoding: ``chunked``

:>json string result: Flag to show whether the index was created or one
already exists. Can be `"created"` or `"exists"`.
already exists. Can be ``"created"`` or ``"exists"``.
:>json string id: Id of the design document the index was created in.
:>json string name: Name of the index created.

@@ -100,9 +100,9 @@ leaf revision `3-c50a32451890a3f1c3e423334cc92745` that will be purged.
As a result of this purge operation, a document with
`_id:c6114c65e295552ab1019e2b046b10e` will be completely removed from the
database's document b+tree, and sequence b+tree. It will not be available
through `_all_docs` or `_changes` endpoints, as though this document never
existed. Also as a result of purge operation, the database's `purge_seq` and
`update_seq` will be increased.
through ``_all_docs`` or ``_changes`` endpoints, as though this document never
existed. Also as a result of purge operation, the database's ``purge_seq`` and
``update_seq`` will be increased.

Notice, how revision `3-b06fcd1c1c9e0ec7c480ee8aa467bf3b` was ignored. Revisions
that have already been purged and non-leaf revisions are ignored in a purge
@@ -126,8 +126,8 @@ revision tree with only a single branch:
Document Revision Tree 3

As a result of this purge operation, a new updated version of the document will
be available in `_all_docs` and `_changes`, creating a new record in `_changes`.
The database's `purge_seq` and `update_seq` will be increased.
be available in ``_all_docs`` and ``_changes``, creating a new record in ``_changes``.
The database's ``purge_seq`` and ``update_seq`` will be increased.

Internal Replication
======================
@@ -58,7 +58,7 @@
<vdufun>` function source
* **views** (*object*): :ref:`View functions <viewfun>` definition.
* **autoupdate** (*boolean*): Indicates whether to automatically build
indexes defined in this design document. Default is `true`.
indexes defined in this design document. Default is ``true``.

Note, that for ``filters``, ``lists``, ``shows`` and ``updates`` fields
objects are mapping of function name to string function source code. For
@@ -26,7 +26,7 @@
.. http:post:: /{db}/_design/{ddoc}/_show/{func}
:synopsis: Same as GET method for the related endpoint

Applies :ref:`show function <showfun>` for `null` document.
Applies :ref:`show function <showfun>` for ``null`` document.

The request and response parameters are depended upon function
implementation.
@@ -29,29 +29,29 @@
- :mimetype:`text/plain`

:query boolean conflicts: Include `conflicts` information in response.
Ignored if `include_docs` isn't ``true``. Default is ``false``.
Ignored if ``include_docs`` isn't ``true``. Default is ``false``.
:query boolean descending: Return the documents in descending order by key.
Default is ``false``.
:query json endkey: Stop returning records when the specified key is
reached.
:query json end_key: Alias for `endkey` param
:query json end_key: Alias for ``endkey`` param
:query string endkey_docid: Stop returning records when the specified
document ID is reached. Ignored if `endkey` is not set.
:query string end_key_doc_id: Alias for `endkey_docid`.
document ID is reached. Ignored if ``endkey`` is not set.
:query string end_key_doc_id: Alias for ``endkey_docid``.
:query boolean group: Group the results using the reduce function to a
group or single row. Implies `reduce` is ``true`` and the maximum
`group_level`. Default is ``false``.
group or single row. Implies ``reduce`` is ``true`` and the maximum
``group_level``. Default is ``false``.
:query number group_level: Specify the group level to be used. Implies
`group` is ``true``.
``group`` is ``true``.
:query boolean include_docs: Include the associated document with each row.
Default is ``false``.
:query boolean attachments: Include the Base64-encoded content of
:ref:`attachments <api/doc/attachments>` in the documents that are
included if `include_docs` is ``true``. Ignored if `include_docs` isn't
included if ``include_docs`` is ``true``. Ignored if ``include_docs`` isn't
``true``. Default is ``false``.
:query boolean att_encoding_info: Include encoding information in
attachment stubs if `include_docs` is ``true`` and the particular
attachment is compressed. Ignored if `include_docs` isn't ``true``.
attachment stubs if ``include_docs`` is ``true`` and the particular
attachment is compressed. Ignored if ``include_docs`` isn't ``true``.
Default is ``false``.
:query boolean inclusive_end: Specifies whether the specified end key
should be included in the result. Default is ``true``.
@@ -66,7 +66,7 @@
the results. Default is ``0``.
:query boolean sorted: Sort returned rows (see :ref:`Sorting Returned Rows
<api/ddoc/view/sorting>`). Setting this to ``false`` offers a performance
boost. The `total_rows` and `offset` fields are not available when this
boost. The ``total_rows`` and ``offset`` fields are not available when this
is set to ``false``. Default is ``true``.
:query boolean stable: Whether or not the view results should be returned
from a stable set of shards. Default is ``false``.
@@ -78,15 +78,15 @@
Note that this parameter is deprecated. Use ``stable`` and ``update`` instead.
See :ref:`views/generation` for more details.
:query json startkey: Return records starting with the specified key.
:query json start_key: Alias for `startkey`.
:query json start_key: Alias for ``startkey``.
:query string startkey_docid: Return records starting with the specified
document ID. Ignored if ``startkey`` is not set.
:query string start_key_doc_id: Alias for `startkey_docid` param
:query string start_key_doc_id: Alias for ``startkey_docid`` param
:query string update: Whether or not the view in question should be updated
prior to responding to the user. Supported values: ``true``, ``false``,
``lazy``. Default is ``true``.
:query boolean update_seq: Whether to include in the response an
`update_seq` value indicating the sequence id of the database the view
``update_seq`` value indicating the sequence id of the database the view
reflects. Default is ``false``.

:>header Content-Type: - :mimetype:`application/json`
@@ -29,7 +29,7 @@
:param docid: Document ID
:param attname: Attachment name

:<header If-Match: Document's revision. Alternative to `rev` query
:<header If-Match: Document's revision. Alternative to ``rev`` query
parameter
:<header If-None-Match: Attachment's base64 encoded MD5 binary digest.
*Optional*
@@ -84,7 +84,7 @@
:param docid: Document ID
:param attname: Attachment name

:<header If-Match: Document's revision. Alternative to `rev` query
:<header If-Match: Document's revision. Alternative to ``rev`` query
parameter
:<header If-None-Match: Attachment's base64 encoded MD5 binary digest.
*Optional*
@@ -132,7 +132,7 @@
:param attname: Attachment name

:<header Content-Type: Attachment MIME type. Default: :mimetype:`application/octet-stream` *Optional*
:<header If-Match: Document revision. Alternative to `rev` query parameter
:<header If-Match: Document revision. Alternative to ``rev`` query parameter

:query string rev: Document revision. *Optional*

@@ -199,7 +199,7 @@
:param docid: Document ID
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
:<header If-Match: Document revision. Alternative to `rev` query parameter
:<header If-Match: Document revision. Alternative to ``rev`` query parameter

:query string rev: Document revision. *Required*
:query string batch: Store changes in :ref:`batch mode
@@ -93,8 +93,8 @@
what `rev` was requested. Default is ``false``
:query boolean local_seq: Includes last update sequence for the
document. Default is ``false``
:query boolean meta: Acts same as specifying all `conflicts`,
`deleted_conflicts` and `revs_info` query parameters. Default is
:query boolean meta: Acts same as specifying all ``conflicts``,
``deleted_conflicts`` and ``revs_info`` query parameters. Default is
``false``
:query array open_revs: Retrieves documents of specified leaf revisions.
Additionally, it accepts value as ``all`` to return all leaf revisions.
@@ -177,8 +177,8 @@
specify the document ID in the request URL.

When updating an existing document, the current document revision must be
included in the document (i.e. the request body), as the `rev` query
parameter, or in the `If-Match` request header.
included in the document (i.e. the request body), as the ``rev`` query
parameter, or in the ``If-Match`` request header.

:param db: Database name
:param docid: Document ID
@@ -191,7 +191,7 @@
parameter or document key. *Optional*

:query string rev: Document's revision if updating an existing document.
Alternative to `If-Match` header or document key. *Optional*
Alternative to ``If-Match`` header or document key. *Optional*
:query string batch: Stores document in :ref:`batch mode
<api/doc/batch-writes>`. Possible values: ``ok``. *Optional*
:query boolean new_edits: Prevents insertion of a :ref:`conflicting
@@ -356,7 +356,7 @@
document ID, and optionally the target document revision, if copying to
an existing document. See :ref:`Copying to an Existing Document
<copy_to_existing_document>`.
:<header If-Match: Source document's revision. Alternative to `rev` query
:<header If-Match: Source document's revision. Alternative to ``rev`` query
parameter
:query string rev: Revision to copy from. *Optional*
:query string batch: Stores document in :ref:`batch mode
@@ -71,15 +71,15 @@ A list of the available methods and URL paths are provided below:
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
:query boolean conflicts: Includes `conflicts` information in response.
Ignored if `include_docs` isn't ``true``. Default is ``false``.
Ignored if ``include_docs`` isn't ``true``. Default is ``false``.
:query boolean descending: Return the local documents in descending by
key order. Default is ``false``.
:query string endkey: Stop returning records when the specified key is
reached. *Optional*.
:query string end_key: Alias for `endkey` param.
:query string end_key: Alias for ``endkey`` param.
:query string endkey_docid: Stop returning records when the specified
local document ID is reached. *Optional*.
:query string end_key_doc_id: Alias for `endkey_docid` param.
:query string end_key_doc_id: Alias for ``endkey_docid`` param.
:query boolean include_docs: Include the full content of the local
documents in the return. Default is ``false``.
:query boolean inclusive_end: Specifies whether the specified end key
@@ -94,10 +94,10 @@ A list of the available methods and URL paths are provided below:
the results. Default is ``0``.
:query string startkey: Return records starting with the specified key.
*Optional*.
:query string start_key: Alias for `startkey` param.
:query string start_key: Alias for ``startkey`` param.
:query string startkey_docid: Return records starting with the specified
local document ID. *Optional*.
:query string start_key_doc_id: Alias for `startkey_docid` param.
:query string start_key_doc_id: Alias for ``startkey_docid`` param.
:query boolean update_seq: Response includes an ``update_seq`` value
indicating which sequence id of the underlying database the view
reflects. Default is ``false``.
@@ -78,7 +78,7 @@ default, cookies are valid for 10 minutes, but it's :config:option:`adjustable
:config:option:`persistent <chttpd_auth/allow_persistent_cookies>`.

To obtain the first token and thus authenticate a user for the first time, the
`username` and `password` must be sent to the :ref:`_session API
``username`` and ``password`` must be sent to the :ref:`_session API
<api/auth/session>`.

.. _api/auth/session:
@@ -181,13 +181,13 @@
Default is ``false``.
:query json endkey: Stop returning databases when the specified key is
reached.
:query json end_key: Alias for `endkey` param
:query json end_key: Alias for ``endkey`` param
:query number limit: Limit the number of the returned databases to the
specified number.
:query number skip: Skip this number of databases before starting to return
the results. Default is ``0``.
:query json startkey: Return databases starting with the specified key.
:query json start_key: Alias for `startkey`.
:query json start_key: Alias for ``startkey``.
:>header Content-Type: - :mimetype:`application/json`
- :mimetype:`text/plain; charset=utf-8`
:code 200: Request completed successfully
@@ -662,7 +662,7 @@

.. note::
As of CouchDB 2.0.0, fully qualified URLs are required for both the
replication `source` and `target` parameters.
replication ``source`` and ``target`` parameters.

**Request**

@@ -1095,7 +1095,7 @@ error.
:>json string last_updated: Timestamp of last state update
:>json object info: Will contain additional information about the
state. For errors, this will be an object with
an `"error"` field and string value. For
an ``"error"`` field and string value. For
success states, see below.
:>json number error_count: Consecutive errors count. Indicates how many
times in a row this replication has crashed.
@@ -1232,7 +1232,7 @@ error.
:>json string last_update: Timestamp of last state update
:>json object info: Will contain additional information about the
state. For errors, this will be an object with
an `"error"` field and string value. For
an ``"error"`` field and string value. For
success states, see below.
:>json number error_count: Consecutive errors count. Indicates how many
times in a row this replication has crashed.
@@ -1334,7 +1334,7 @@ error.
:>json string last_update: Timestamp of last state update
:>json object info: Will contain additional information about the
state. For errors, this will be an object with
an `"error"` field and string value. For
an ``"error"`` field and string value. For
success states, see below.
:>json number error_count: Consecutive errors count. Indicates how many
times in a row this replication has crashed.
@@ -127,9 +127,9 @@ channel.

.. config: option:: strict_window
If set to `true`, any compaction that is still running after the end of
If set to ``true``, any compaction that is still running after the end of
the allowed perio will be suspended, and then resumed during the next
window. It defaults to `false`, in which case any running compactions
window. It defaults to ``false``, in which case any running compactions
will be allowed to finish, but no new ones will be started.

There are also several settings that collectively control whether a channel will
@@ -163,5 +163,5 @@ enqueue a file for compaction and how it prioritizes files within its queue:
.. config:option:: priority
The method used to calculate priority. Can be ratio (calculated as
`sizes.file/sizes.active`) or slack (calculated as `sizes.file -
sizes.active`). Defaults to ratio.
``sizes.file/sizes.active``) or slack (calculated as ``sizes.file -
sizes.active``). Defaults to ratio.

0 comments on commit 0603a30

Please sign in to comment.