Skip to content

Commit c719f1e

Browse files
DOCSP-37200 GET all snapshots parameters (#119)
## DESCRIPTION - Fixed base list of query request parameters - Fixed query request parameters for GET all snapshots - Fixed query request parameters for GET all backup daemon configs ## STAGING [Get all snapshots for one cluster](https://preview-mongodbnvillahermosamdb.gatsbyjs.io/ops-manager/DOCSP-37200-get-all-snapshots-parameters/reference/api/snapshots/get-all-snapshots-for-one-cluster/#request-query-parameters) [Get all backup daemon configurations](https://preview-mongodbnvillahermosamdb.gatsbyjs.io/ops-manager/DOCSP-37200-get-all-snapshots-parameters/reference/api/admin/backup/daemonConfigs/get-all-backup-daemon-configurations/#request-query-parameters) ## JIRA https://jira.mongodb.org/browse/DOCSP-37200 ## BUILD LOG https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=65df867311db7b0427e2b930 ## SELF-REVIEW CHECKLIST - [x] Does each file have 3-5 taxonomy facet tags? See the [taxonomy tagging instructions](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) and this [example PR](https://github.com/10gen/cloud-docs/pull/5042/files) - [x] Is this free of any warnings or errors in the RST? - [x] Is this free of spelling errors? - [x] Is this free of grammatical errors? - [x] Is this free of staging / rendering issues? - [x] Are all the links working? ## EXTERNAL REVIEW REQUIREMENTS [What's expected of an external reviewer?](https://wiki.corp.mongodb.com/display/DE/Reviewing+Guidelines+for+the+MongoDB+Server+Documentation) --------- Co-authored-by: Sarah Simpers <[email protected]>
1 parent 555c690 commit c719f1e

File tree

3 files changed

+115
-14
lines changed

3 files changed

+115
-14
lines changed

source/includes/api/base-query-list-parameters.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,4 @@
4242
object is an envelope. |mms| adds the ``status`` field to the
4343
response body.
4444

45-
- ``false``
46-
47-
* - backupJobsEnabledOnly
48-
- boolean
49-
- Optional
50-
- Flag indicating whether to exclude daemons not enabled for
51-
backing up databases from the response. Set this to ``false`` to
52-
include daemon configurations with the ``backupJobsEnabled``
53-
flag set to ``false``.
54-
- ``true``
45+
- ``false``

source/reference/api/admin/backup/daemonConfigs/get-all-backup-daemon-configurations.txt

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,62 @@ Request Path Parameters
2929
Request Query Parameters
3030
~~~~~~~~~~~~~~~~~~~~~~~~
3131

32-
.. include:: /includes/api/no-query-list-parameters.rst
32+
The following query parameters are optional:
33+
34+
.. list-table::
35+
:widths: 20 14 11 45 10
36+
:header-rows: 1
37+
:stub-columns: 1
38+
39+
* - Name
40+
- Type
41+
- Necessity
42+
- Description
43+
- Default
44+
45+
* - pageNum
46+
- number
47+
- Optional
48+
- One-based integer that returns a subsection of results.
49+
- ``1``
50+
51+
* - itemsPerPage
52+
- number
53+
- Optional
54+
- Number of items to return per page, up to a maximum of 500.
55+
- ``100``
56+
57+
* - pretty
58+
- boolean
59+
- Optional
60+
- Flag that indicates whether the response body should be in a
61+
:wikipedia:`prettyprint </Prettyprint?oldid=791126873>` format.
62+
- ``false``
63+
64+
* - envelope
65+
- boolean
66+
- Optional
67+
- Flag that indicates whether or not to wrap the response in an
68+
envelope.
69+
70+
Some |api| clients cannot access the |http| response headers or
71+
status code. To remediate this, set ``envelope : true`` in the
72+
query.
73+
74+
For endpoints that return a list of results, the ``results``
75+
object is an envelope. |mms| adds the ``status`` field to the
76+
response body.
77+
78+
- ``false``
79+
80+
* - backupJobsEnabledOnly
81+
- boolean
82+
- Optional
83+
- Flag indicating whether to exclude daemons not enabled for
84+
backing up databases from the response. Set this to ``false`` to
85+
include daemon configurations with the ``backupJobsEnabled``
86+
flag set to ``false``.
87+
- ``true``
3388

3489
Request Body Parameters
3590
~~~~~~~~~~~~~~~~~~~~~~~

source/reference/api/snapshots/get-all-snapshots-for-one-cluster.txt

Lines changed: 58 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
Get All Snapshots for One Cluster
33
=================================
44

5-
.. default-domain:: mongodb
6-
75
.. contents:: On this page
86
:local:
97
:backlinks: none
@@ -45,7 +43,64 @@ Request Path Parameters
4543
Request Query Parameters
4644
~~~~~~~~~~~~~~~~~~~~~~~~
4745

48-
.. include:: /includes/api/no-query-list-parameters.rst
46+
The following query parameters are optional:
47+
48+
.. list-table::
49+
:widths: 20 14 11 45 10
50+
:header-rows: 1
51+
:stub-columns: 1
52+
53+
* - Name
54+
- Type
55+
- Necessity
56+
- Description
57+
- Default
58+
59+
* - pageNum
60+
- number
61+
- Optional
62+
- One-based integer that returns a subsection of results.
63+
- ``1``
64+
65+
* - itemsPerPage
66+
- number
67+
- Optional
68+
- Number of items to return per page, up to a maximum of 500.
69+
- ``100``
70+
71+
* - pretty
72+
- boolean
73+
- Optional
74+
- Flag that indicates whether the response body should be in a
75+
:wikipedia:`prettyprint </Prettyprint?oldid=791126873>` format.
76+
- ``false``
77+
78+
* - envelope
79+
- boolean
80+
- Optional
81+
- Flag that indicates whether or not to wrap the response in an
82+
envelope.
83+
84+
Some |api| clients cannot access the |http| response headers or
85+
status code. To remediate this, set ``envelope : true`` in the
86+
query.
87+
88+
For endpoints that return a list of results, the ``results``
89+
object is an envelope. |mms| adds the ``status`` field to the
90+
response body.
91+
92+
- ``false``
93+
94+
* - completed
95+
- string
96+
- Optional
97+
- String that indicates whether to return
98+
completed or incomplete snapshots:
99+
100+
* ``true``: Return only completed snapshots
101+
* ``false``: Return only incomplete snapshots
102+
* ``all``: Return both completed and incomplete snapshots
103+
- ``true``
49104

50105
Request Body Parameters
51106
~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)