From 609de9bf6bc99c7e046d976456099fc378236a95 Mon Sep 17 00:00:00 2001 From: Allison Reinheimer Moore Date: Wed, 31 Jan 2018 13:26:31 -0500 Subject: [PATCH] DOCS-8977: include filter param for db.getCollectionInfos() --- .../apiargs-dbcommand-listCollections-field.yaml | 2 +- .../apiargs-method-db.getCollectionInfos-param.yaml | 11 +++++++++++ source/reference/method/db.getCollectionInfos.txt | 9 +++++++-- 3 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 source/includes/apiargs-method-db.getCollectionInfos-param.yaml diff --git a/source/includes/apiargs-dbcommand-listCollections-field.yaml b/source/includes/apiargs-dbcommand-listCollections-field.yaml index 91f5b6329e3..1cc9d3aee44 100644 --- a/source/includes/apiargs-dbcommand-listCollections-field.yaml +++ b/source/includes/apiargs-dbcommand-listCollections-field.yaml @@ -3,7 +3,7 @@ description: | A query expression to filter the list of collections. You can specify a query expression on any of the :ref:`fields - returned ` by :dbcommand:`listCollections`. + returned ` by {{role}}. interface: dbcommand name: filter diff --git a/source/includes/apiargs-method-db.getCollectionInfos-param.yaml b/source/includes/apiargs-method-db.getCollectionInfos-param.yaml new file mode 100644 index 00000000000..c6aad8da84b --- /dev/null +++ b/source/includes/apiargs-method-db.getCollectionInfos-param.yaml @@ -0,0 +1,11 @@ +arg_name: param +inherit: + file: apiargs-dbcommand-listCollections-field.yaml + ref: filter +name: filter +operation: db.getCollectionInfos +interface: method +optional: true +position: 1 +type: document +... diff --git a/source/reference/method/db.getCollectionInfos.txt b/source/reference/method/db.getCollectionInfos.txt index 8a6349e3c0b..572b1761c42 100644 --- a/source/reference/method/db.getCollectionInfos.txt +++ b/source/reference/method/db.getCollectionInfos.txt @@ -13,9 +13,9 @@ db.getCollectionInfos() Definition ---------- -.. method:: db.getCollectionInfos() +.. method:: db.getCollectionInfos(filter) - .. versionadded:: 3.0.0 + .. versionadded:: 3.0 Returns an array of documents with collection or :doc:`view ` information, such as name and options, for @@ -24,6 +24,11 @@ Definition The :method:`db.getCollectionInfos()` helper wraps the :dbcommand:`listCollections` command. + The :method:`db.getCollectionInfos()` method has the following + optional parameter: + + .. include:: /includes/apiargs/method-db.getCollectionInfos-param.rst + .. versionchanged:: 3.2 MongoDB 3.2 added support for :doc:`document validation