Skip to content

Commit 8b9a8fe

Browse files
authored
DOCSP-37779 Incorrect response object mentioned for API Endpoints (#158)
1 parent 9f64b42 commit 8b9a8fe

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@
3838
status code. To remediate this, set ``envelope : true`` in the
3939
query.
4040

41-
For endpoints that return a list of results, the ``results``
41+
For endpoints that return a list of results, the ``content``
4242
object is an envelope. |mms| adds the ``status`` field to the
4343
response body.
4444

45-
- ``false``
45+
- ``false``

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,12 @@
4040
:header-rows: 1
4141
:stub-columns: 1
4242

43-
* - status
43+
* - Name
44+
- Description
45+
46+
* - ``status``
4447
- |http| response code
45-
* - envelope
48+
* - ``content``
4649
- Expected response body
4750

4851
For endpoints that return a list of results, the ``results``

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@
3737
* - Name
3838
- Description
3939

40-
* - status
40+
* - ``status``
4141
- |http| response code
42-
* - envelope
42+
* - ``content``
4343
- Expected response body
4444

4545
- ``false``

source/includes/api/get-one-org-om-query-params.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
* - ``status``
3838
- |http| response code
39-
* - ``envelope``
39+
* - ``content``
4040
- Expected response body
4141

4242
- ``false``

0 commit comments

Comments
 (0)