From 06a50907ce69d58314435bd59d7a177e43eb7104 Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Tue, 11 Dec 2018 10:53:57 +0100 Subject: [PATCH] Move list limit docs to admin guide Change-Id: I434982dbf71679cca2bc0dd8bb142d23e009e06a --- doc/source/admin/index.rst | 1 + doc/source/admin/limit-list-size.rst | 34 ++++++++++++++++++++++++++++ doc/source/configuration.rst | 18 --------------- 3 files changed, 35 insertions(+), 18 deletions(-) create mode 100644 doc/source/admin/limit-list-size.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index f656f20408..fe52debad8 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -47,6 +47,7 @@ command-line client. auth-totp.rst external-authentication.rst configure_tokenless_x509.rst + limit-list-size.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/admin/limit-list-size.rst b/doc/source/admin/limit-list-size.rst new file mode 100644 index 0000000000..2de2dfd6b8 --- /dev/null +++ b/doc/source/admin/limit-list-size.rst @@ -0,0 +1,34 @@ +.. + Copyright 2018 SUSE Linux GmbH + All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +Limiting list return size +========================= + +Keystone provides a method of setting a limit to the number of entities +returned in a collection, which is useful to prevent overly long response times +for list queries that have not specified a sufficiently narrow filter. This +limit can be set globally by setting ``list_limit`` in the default section of +``keystone.conf``, with no limit set by default. Individual driver sections may +override this global value with a specific limit, for example: + +.. code-block:: ini + + [resource] + list_limit = 100 + +If a response to ``list_{entity}`` call has been truncated, then the response +status code will still be 200 (OK), but the ``truncated`` attribute in the +collection will be set to ``true``. diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 55f176efe8..ada6043dc1 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -34,21 +34,3 @@ via SAML federation. .. _Domain-specific Configuration: admin/domain-specific-config.html .. support_matrix:: identity-support-matrix.ini -Limiting list return size -========================= - -Keystone provides a method of setting a limit to the number of entities -returned in a collection, which is useful to prevent overly long response times -for list queries that have not specified a sufficiently narrow filter. This -limit can be set globally by setting ``list_limit`` in the default section of -``keystone.conf``, with no limit set by default. Individual driver sections may -override this global value with a specific limit, for example: - -.. code-block:: ini - - [resource] - list_limit = 100 - -If a response to ``list_{entity}`` call has been truncated, then the response -status code will still be 200 (OK), but the ``truncated`` attribute in the -collection will be set to ``true``.