Skip to content

Commit 7323c8a

Browse files
TW review of the comment attribute for Backups API
1 parent 61e668f commit 7323c8a

1 file changed

Lines changed: 8 additions & 10 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -171,9 +171,11 @@ A JSON object with the following attributes:
171171

172172
* `comment` (String): Optional comment for this snapshot.
173173

174-
Please note that the comment attribute is optional, but the API expects an empty JSON Object for a successful response.
174+
{{% alert color="info" %}}
175+
The `comment` attribute is optional, but the API requires an empty JSON object (`{}`) to return a successful response.
176+
{{% /alert %}}
175177

176-
**Example Requests**
178+
**Example Request 1**
177179

178180
```bash
179181
POST /api/v2/apps/543857rfds-dfsfsd12c5e24-3224d32eg/environments/cd5fc610-edb0-43c5-a374-0439a6411ace/snapshots
@@ -182,22 +184,18 @@ Host: deploy.mendix.com
182184
Content-Type: application/json
183185
Mendix-Username: richard.ford51@example.com
184186
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
185-
186-
Request-Body:
187-
{
188-
"comment" : "My snapshot"
189-
}
187+
{"comment": "My snapshot"}
190188
```
191-
Or,
189+
190+
**Example Request 2**
191+
192192
```bash
193193
POST /api/v2/apps/543857rfds-dfsfsd12c5e24-3224d32eg/environments/cd5fc610-edb0-43c5-a374-0439a6411ace/snapshots
194194
Host: deploy.mendix.com
195195

196196
Content-Type: application/json
197197
Mendix-Username: richard.ford51@example.com
198198
Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
199-
200-
Request-Body:
201199
{}
202200
```
203201

0 commit comments

Comments
 (0)