From 5a7b8a3870d1b34b73c87ea02cdf01d43090a765 Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Tue, 22 Oct 2024 16:32:56 +0200 Subject: [PATCH 01/11] Update design-properties.md --- .../en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md b/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md index 563c0bf5362..fe4402e3c25 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md @@ -17,7 +17,7 @@ Design properties are a special set of settings shipped together with a Mendix t In Studio Pro, you can see which design properties are available for a widget in the **Properties** pane. -{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/overview.png" alt="The Properties pane in Studio Pro" class="no-border" >}} +{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/overview.png" alt="The Properties pane in Studio Pro" >}} ## Using Design Properties From 03cd187d0b56cb49b87d41da5a8176449d3b4f64 Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Thu, 24 Oct 2024 09:40:58 +0200 Subject: [PATCH 02/11] update image format --- .../apidocs/frontend/design-properties.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md b/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md index fe4402e3c25..47febb33dae 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties.md @@ -17,7 +17,7 @@ Design properties are a special set of settings shipped together with a Mendix t In Studio Pro, you can see which design properties are available for a widget in the **Properties** pane. -{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/overview.png" alt="The Properties pane in Studio Pro" >}} +{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/overview.png" alt="The Properties pane in Studio Pro" max-width=60% >}} ## Using Design Properties @@ -211,7 +211,7 @@ Here is an example of a **Dropdown** design property using CSS variables: This is how the **Dropdown** design property appears: -{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/dropdown.png" alt="Dropdown property in Studio Pro" class="no-border" >}} +{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/dropdown.png" alt="Dropdown property in Studio Pro" max-width=80% >}} #### Colorpicker-Specific Fields @@ -285,7 +285,7 @@ Note: if you can not provide a value for the preview, it is recommended to inste This is how the **Colorpicker** design property appears: -{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/colorpicker.png" alt="Dropdown property in Studio Pro" class="no-border" >}} +{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/colorpicker.png" alt="Dropdown property in Studio Pro" max-width=80% >}} #### ToggleButtonGroup-Specific Fields @@ -361,7 +361,7 @@ Here is an example of a **ToggleButtonGroup** design property using CSS variable This is how the **ToggleButtonGroup** design property appears when using icons for the options: -{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/toggle_button_group.png" alt="ToggleButtonGroup property in Studio Pro" class="no-border" >}} +{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/toggle_button_group.png" alt="ToggleButtonGroup property in Studio Pro" max-width=80% >}} #### Spacing-Specific Fields @@ -499,7 +499,7 @@ Here is an example of a **Spacing** design property using CSS variables: This is how the **Spacing** design property appears: -{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/spacing.png" alt="Spacing property in Studio Pro" class="no-border" >}} +{{< figure src="/attachments/apidocs-mxsdk/apidocs/design-properties/spacing.png" alt="Spacing property in Studio Pro" max-width=80% >}} ### Extending or Overriding Design Properties of Other Modules {#extend-existing-design-properties} From 24301605eb40ffe64711c0f1690d49ea2828a0cd Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Thu, 24 Oct 2024 09:52:22 +0200 Subject: [PATCH 03/11] Code formatting --- .../apidocs-mxsdk/apidocs/apps/app-repository-api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/apps/app-repository-api.md b/content/en/docs/apidocs-mxsdk/apidocs/apps/app-repository-api.md index 7dda1484631..bdf6882e508 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/apps/app-repository-api.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/apps/app-repository-api.md @@ -60,7 +60,7 @@ This is the generic error response format. The payload example format applies to | Name | Value | | --- | --- | -| Content-Type | `application/json; charset=utf-8` | +| `Content-Type` | `application/json; charset=utf-8` | #### Payload @@ -122,7 +122,7 @@ Authorization: MxToken hZUPhAV4ELPrRm7U7JAKf5BnxJk6q7dcsvFdw6ZR4wRYdv7egHjwHEYBw |Name|Value| |---|---| -|Content-Type|`application/json; charset=utf-8`| +|`Content-Type`|`application/json; charset=utf-8`| #### Response Payload @@ -183,7 +183,7 @@ Authorization: MxToken hZUPhAV4ELPrRm7U7JAKf5BnxJk6q7dcsvFdw6ZR4wRYdv7egHjwHEYBw |Name|Value| |---|---| -|Content-Type|`application/json; charset=utf-8`| +|`Content-Type`|`application/json; charset=utf-8`| #### Response Payload @@ -266,7 +266,7 @@ Authorization: MxToken hZUPhAV4ELPrRm7U7JAKf5BnxJk6q7dcsvFdw6ZR4wRYdv7egHjwHEYBw |Name|Value| |---|---| -|Content-Type|`application/json; charset=utf-8`| +|`Content-Type`|`application/json; charset=utf-8`| #### Response Payload {#response-payload} @@ -352,7 +352,7 @@ Authorization: MxToken hZUPhAV4ELPrRm7U7JAKf5BnxJk6q7dcsvFdw6ZR4wRYdv7egHjwHEYBw |Name|Value| |---|---| -|Content-Type|`application/json; charset=utf-8`| +|`Content-Type`|`application/json; charset=utf-8`| #### Response Payload From 68d6f7a045f071a18547ee57ec19c9989ede9ae7 Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Thu, 24 Oct 2024 09:54:23 +0200 Subject: [PATCH 04/11] code format --- .../apidocs/apps/feedback-api.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/apps/feedback-api.md b/content/en/docs/apidocs-mxsdk/apidocs/apps/feedback-api.md index 6b740a8635f..7e1f17a75fe 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/apps/feedback-api.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/apps/feedback-api.md @@ -57,9 +57,9 @@ This call **accepts** the specified feedback item. This means that the app team | Parameter Name | Parameter Type | Description | | --- | --- | --- | -| ApiKey | String | The ApiKey the application uses to access the Feedback API for this app. -| FeedbackItemID | Integer/Long | The ID of the Feedback item to be accepted -| appID | String | The ID of the app +| `ApiKey` | String | The ApiKey the application uses to access the Feedback API for this app.| +| `FeedbackItemID` | Integer/Long | The ID of the Feedback item to be accepted | +| `appID` | String | The ID of the app| * Return value – Boolean @@ -69,13 +69,13 @@ This call **adds a new feedback item** to the app and returns the ID of the new | Parameter Name | Parameter Type | Description | | --- | --- | --- | -| ApiKey | String | The ApiKey the application uses to access the Feedback API for this app. -| Description | String | Description of the feedback item. (Optional) -| IssueType | Enumeration IssueType | Type of the feedback item (Question/Idea/Problem) -| ProjectID | String | The ID of the app. -| Shortname | String | The name of the feedback item. -| UserEmail | String | Email address of the user who created the feedback item. -| Username | String | Name of the user who created the feedback item. +| `ApiKey` | String | The ApiKey the application uses to access the Feedback API for this app. | +| `Description` | String | Description of the feedback item. (Optional) | +| `IssueType` | Enumeration IssueType | Type of the feedback item (Question/Idea/Problem) | +| `ProjectID` | String | The ID of the app. | +| `Shortname` | String | The name of the feedback item. | +| `UserEmail` | String | Email address of the user who created the feedback item. | +| `Username` | String | Name of the user who created the feedback item.| * Return value – Integer/Long @@ -85,10 +85,10 @@ This call **closes** the specified feedback item. | Parameter Name | Parameter Type | Description | | --- | --- | --- | -| ApiKey | String | The ApiKey the application uses to access the Feedback API for this app. -| FeedbackItemID | Integer/Long | The id of the feedback item being closed. -| ProjectID | String | The ID of the app. -| Reason | String | Reason why the feedback item is being closed (Optional) +| `ApiKey` | String | The ApiKey the application uses to access the Feedback API for this app.| +| `FeedbackItemID` | Integer/Long | The id of the feedback item being closed. | +| `ProjectID` | String | The ID of the app. | +| `Reason` | String | Reason why the feedback item is being closed (Optional)| * Return value – Enumeration IssueState (see below for possible values) @@ -98,9 +98,9 @@ This call **deletes** the specified feedback item. | Parameter Name | Parameter Type | Description | | --- | --- | --- | -| ApiKey | String | The ApiKey the application uses to access the Feedback API for this app. -| FeedbackItemID | Integer/Long | The ID of the Feedback item to be deleted -| ProjectID | String | The ID of the app. +| `ApiKey` | String | The ApiKey the application uses to access the Feedback API for this app.| +| `FeedbackItemID` | Integer/Long | The ID of the Feedback item to be deleted | +| `ProjectID` | String | The ID of the app.| * Return value – Boolean @@ -110,9 +110,9 @@ This call **retrieves a list of all feedback items** for the app which satisfy t | Parameter Name | Parameter Type | Description | | --- | --- | --- | -| ApiKey | String | The ApiKey the application uses to access the Feedback API for this app. | -| IssueStateFilter | Enumeration IssueState | State of the Feedback items to be retrieved (Open, Under_review, Accepted, Scheduled, Solved, Rejected; empty returns all feedback for the app). | -| ProjectID | String | The ID of the app. | +| `ApiKey` | String | The ApiKey the application uses to access the Feedback API for this app. | +| `IssueStateFilter` | Enumeration IssueState | State of the Feedback items to be retrieved (Open, Under_review, Accepted, Scheduled, Solved, Rejected; empty returns all feedback for the app). | +| `ProjectID` | String | The ID of the app. | * Return value – List of Issue @@ -122,8 +122,8 @@ This call **retrieves a single feedback item** by ID. | Parameter Name | Parameter Type | Description | | --- | --- | --- | -| ApiKey | String | The ApiKey the application uses to access the Feedback API for this app. -| FeedbackItemID | Integer/Long | The ID of the Feedback item to be retrieved -| ProjectID | String | The ID of the app. +| `ApiKey` | String | The ApiKey the application uses to access the Feedback API for this app.| +| `FeedbackItemID` | Integer/Long | The ID of the Feedback item to be retrieved | +| `ProjectID` | String | The ID of the app.| * Return value – Issue From 3a5a35fa461a8418180db111a2a324b2c05d5b21 Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Thu, 24 Oct 2024 09:58:54 +0200 Subject: [PATCH 05/11] code format --- .../apidocs/apps/team-server-api.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/apps/team-server-api.md b/content/en/docs/apidocs-mxsdk/apidocs/apps/team-server-api.md index 0b7bc3da0e6..45eb18aa93c 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/apps/team-server-api.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/apps/team-server-api.md @@ -57,7 +57,7 @@ HTTP Method: GET ##### Parameter -* *AppId* (String) : Subdomain name of an app. +* `AppId` (String) : Subdomain name of an app. ##### Example @@ -74,10 +74,10 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 List of objects with the following key-value pairs: -* *Name* (String) : Name of the branch. This is 'trunk' for the main line or a specific branch name. -* *DisplayName* (String) : Visible name in the Mendix Portal. For the trunk, this is 'Main line'. -* *LatestRevisionNumber* (Long) : Number of the latest revision. -* *LatestRevisionMendixVersion* (String) : Version string of the Mendix version of the app in this revision. +* `Name` (String) : Name of the branch. This is 'trunk' for the main line or a specific branch name. +* `DisplayName` (String) : Visible name in the Mendix Portal. For the trunk, this is 'Main line'. +* `LatestRevisionNumber` (Long) : Number of the latest revision. +* `LatestRevisionMendixVersion` (String) : Version string of the Mendix version of the app in this revision. ##### Error Codes @@ -115,8 +115,8 @@ Retrieves a specific branch that belongs to the team server project of a specifi ##### Parameters -* *AppId* (String) : Subdomain name of an app. -* *Name* (String) : Name of the branch to get or 'trunk' to get the main line. The name of the branch should be [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp). +* `AppId` (String) : Subdomain name of an app. +* `Name` (String) : Name of the branch to get or 'trunk' to get the main line. The name of the branch should be [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp). ##### Example @@ -133,10 +133,10 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 An object with the following key-value pairs: -* *Name* (String) : Name of the branch. This is 'trunk' for the main line or a specific branch name. -* *DisplayName* (String) : Visible name in the Mendix Portal. For the trunk, this is 'Main line'. -* *LatestRevisionNumber* (Long) : Number of the latest revision. -* *LatestRevisionMendixVersion* (String) : Version string of the Mendix version of the app in the latest revision. +* `Name` (String) : Name of the branch. This is 'trunk' for the main line or a specific branch name. +* `DisplayName` (String) : Visible name in the Mendix Portal. For the trunk, this is 'Main line'. +* `LatestRevisionNumber` (Long) : Number of the latest revision. +* `LatestRevisionMendixVersion` (String) : Version string of the Mendix version of the app in the latest revision. ##### Error Codes @@ -170,8 +170,8 @@ HTTP Method: GET ##### Parameters -* *AppId* (String) : Subdomain name of an app. -* *Name* (String) : Name of the branch to get. Use `trunk` to get the main line or `branches%2FyourBranchName` for any other development branch. +* `AppId` (String) : Subdomain name of an app. +* `Name` (String) : Name of the branch to get. Use `trunk` to get the main line or `branches%2FyourBranchName` for any other development branch. ##### Examples @@ -197,11 +197,11 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 List of objects with the following key-value pairs: -* *Number* (Long) : Number of the revision. -* *CommitMessage* (String) : Commit message of the revision. -* *Date* (Date) : Date when the revision is created (or the commit is done). -* *Author* (String) : Creator of the revision (committer). -* *MendixVersion* (String) : Version string of the Mendix version of the app in this revision. +* `Number` (Long) : Number of the revision. +* `CommitMessage` (String) : Commit message of the revision. +* `Date` (Date) : Date when the revision is created (or the commit is done). +* `Author` (String) : Creator of the revision (committer). +* `MendixVersion` (String) : Version string of the Mendix version of the app in this revision. ##### Error Codes From 7b9dd8f9a3207cd500c6a669d7e4a23949898ec0 Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Fri, 25 Oct 2024 15:19:47 +0200 Subject: [PATCH 06/11] Update backups-api-v2.md --- .../apidocs/deployment/backups-api-v2.md | 204 +++++++++--------- 1 file changed, 103 insertions(+), 101 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md b/content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md index e60783eaabc..efb0ebe0a28 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/deployment/backups-api-v2.md @@ -75,13 +75,13 @@ URL: https://deploy.mendix.com/api/v2/apps//environments//environments//environments//environments//environments//environments//environments//environments//environments/ Date: Fri, 25 Oct 2024 15:25:03 +0200 Subject: [PATCH 07/11] Update build-api.md --- .../apidocs/deployment/build-api.md | 67 +++++++++---------- 1 file changed, 33 insertions(+), 34 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md b/content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md index 332cb7cbb1e..47040f3edb4 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md @@ -57,7 +57,7 @@ URL: https://deploy.mendix.com/api/1/apps//packages ##### Parameter -* *AppId* (String) : Subdomain name of an app. +* `AppId` (String) : Subdomain name of an app. ##### Example @@ -73,16 +73,16 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 List of objects with the following key-value pairs: -* *PackageId* (String) : Unique identification of the package. -* *Name* (String) : Name of the package. -* *Description* (String) : Description of the package. -* *Version* (String) : Package version. This is also the name of the tag on the project team server. -* *Creator* (String) : Uploader or creator of this package. -* *CreationDate* (Date) : Date that the package became available in the portal. This can be the +* `PackageId` (String) : Unique identification of the package. +* `Name` (String) : Name of the package. +* `Description` (String) : Description of the package. +* `Version` (String) : Package version. This is also the name of the tag on the project team server. +* `Creator` (String) : Uploader or creator of this package. +* `CreationDate` (Date) : Date that the package became available in the portal. This can be the upload date or the date that a build was created in the portal. -* *Status* (String) : Status of the package. A package is ready to use if the status is 'Succeeded'. +* `Status` (String) : Status of the package. A package is ready to use if the status is 'Succeeded'. Possible values: Succeeded, Queued, Building, Uploading and Failed. -* *Size* (Long) : Size of the package in bytes. +* `Size` (Long) : Size of the package in bytes. ##### Error Codes @@ -129,9 +129,9 @@ URL: https://deploy.mendix.com/api/1/apps//packages/?url=/packages/ ##### Parameters -* *AppId* (String) : Subdomain name of an app -* *PackageId* (String) : Id of the deployment package +* `AppId` (String) : Subdomain name of an app +* `PackageId` (String) : Id of the deployment package ```http DELETE /api/1/apps/calc/packages/b3d14e53-2654-4534-b374-9179a69ef3cf HTTP/1.1 @@ -244,8 +243,8 @@ URL: https://deploy.mendix.com/api/1/apps//packages//download Parameters -* *AppId* (String) : Subdomain name of an app. -* *PackageId* (String) : Id of the deployment package. +* `AppId` (String) : Subdomain name of an app. +* `PackageId` (String) : Id of the deployment package. ```http GET /api/1/apps/calc/packages/b3d14e53-2654-4534-b374-9179a69ef3cf/download HTTP/1.1 @@ -278,7 +277,7 @@ URL: https://deploy.mendix.com/api/1/apps//packages ##### Parameter -* *AppId* (String) : Subdomain name of an app. +* `AppId` (String) : Subdomain name of an app. ##### Payload @@ -286,14 +285,14 @@ The payload depends on whether the app is held in a [Git repository or an SVN re An object with the following key-value pairs: -* *Branch* (String) : Name of the branch. +* `Branch` (String) : Name of the branch. * For SVN, this is 'trunk' for the main line or 'branches/*branch name*' for a specific branch. * For Git, this is 'main' for the main line or 'branches/*branch name*' for a specific branch. -* *Revision* (String) : Number of the revision to build a package from. +* `Revision` (String) : Number of the revision to build a package from. * For SVN, this is an integer reflecting the revision number. * For Git, this is the commit hash. The API will accept either the short commit hash or the full commit hash. -* *Version* (String) : Package version. This will also be the name of the tag on the project team server. -* *Description* (String) : Description of the package. +* `Version` (String) : Package version. This will also be the name of the tag on the project team server. +* `Description` (String) : Description of the package. ##### Example @@ -322,7 +321,7 @@ You can find out the status of your build by looking at the `status` from a [Ret An object with the following key-value pair: -* *PackageId* (String) : Unique identification of the package. This string can be used to get the build status of the package later. +* `PackageId` (String) : Unique identification of the package. This string can be used to get the build status of the package later. Error codes From e7abdec0f0f6d6d9f61226191a31cd5a25869457 Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Mon, 28 Oct 2024 08:37:49 +0100 Subject: [PATCH 08/11] Update deploy-api-1.md --- .../apidocs-mxsdk/apidocs/deployment/deploy-api-1.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md b/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md index c6d539e6a8a..111c6c0f080 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md @@ -132,7 +132,7 @@ URL: https://deploy.mendix.com/api/1/apps An object with the following key-value pair: -* *ProjectId* (String) : The Mendix Portal project identifier that should be linked to the new Free App. This value can be found on the **General** tab of the **Settings** page of your app, and it is represented as **App ID**. +* `ProjectId` (String) : The Mendix Portal project identifier that should be linked to the new Free App. This value can be found on the **General** tab of the **Settings** page of your app, and it is represented as **App ID**. **Example Request** @@ -152,10 +152,10 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 Response object with the following fields: -* *AppId* (String): Sub-domain name of the app. -* *Name* (String): Name of the app. -* *ProjectId* (String): Mendix Portal Project identifier. -* *Url* (String): Production or Free App URL to access your app. +* `AppId` (String): Sub-domain name of the app. +* `Name` (String): Name of the app. +* `ProjectId` (String): Mendix Portal Project identifier. +* `Url` (String): Production or Free App URL to access your app. **Error Codes** From 859e8c4b61493589e12d252b85f2db0d18a38b8b Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Mon, 28 Oct 2024 12:54:51 +0100 Subject: [PATCH 09/11] update code format --- .../apidocs/deployment/deploy-api-1.md | 137 +++++++++--------- 1 file changed, 68 insertions(+), 69 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md b/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md index 111c6c0f080..c705d065616 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-1.md @@ -94,10 +94,10 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 List of objects with the following key-value pairs: -* *AppId* (String): Sub-domain name of the app. -* *Name* (String): Name of the app. -* *ProjectId* (String): Mendix Portal Project identifier. -* *Url* (String): Production or Free App URL to access your app. +* `AppId` (String): Sub-domain name of the app. +* `Name` (String): Name of the app. +* `ProjectId` (String): Mendix Portal Project identifier. +* `Url` (String): Production or Free App URL to access your app. **Example Output** @@ -190,7 +190,7 @@ URL: https://deploy.mendix.com/api/1/apps/ ##### Request Parameter -* *AppId* (String): Sub-domain name of an app. +* `AppId` (String): Sub-domain name of an app. ##### Example Request @@ -206,10 +206,10 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 Object with the following key-value pairs: -* *AppId* (String): Sub-domain name of the app. -* *ProjectId* (String): Mendix Portal Project identifier. -* *Name* (String): Name of the app. -* *Url* (String): Production or Free App URL to access your app. +* `AppId` (String): Sub-domain name of the app. +* `ProjectId` (String): Mendix Portal Project identifier. +* `Name` (String): Name of the app. +* `Url` (String): Production or Free App URL to access your app. ##### Error Codes @@ -244,7 +244,7 @@ URL: https://deploy.mendix.com/api/1/apps//environments ##### Request Parameter -* *AppId* (String): Subdomain name of an app. +* `AppId` (String): Subdomain name of an app. ##### Example Request @@ -261,13 +261,13 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 List of objects with the following key-value pairs: -* *Status* (String): Status of the environment. Possible values: Empty, Stopped, Running. -* *EnvironmentId* (String): Unique identifier of the environment. -* *Url* (String): URL to access your application. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). -* *ModelVersion* (String): The version number of the package deployed in your environment. -* *MendixVersion* (String): The Mendix version number of the package deployed in your environment. -* *Production* (Boolean): A flag indicating if this environment is a production environment. +* `Status` (String): Status of the environment. Possible values: Empty, Stopped, Running. +* `EnvironmentId` (String): Unique identifier of the environment. +* `Url` (String): URL to access your application. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `ModelVersion` (String): The version number of the package deployed in your environment. +* `MendixVersion` (String): The Mendix version number of the package deployed in your environment. +* `Production` (Boolean): A flag indicating if this environment is a production environment. ##### Example Output @@ -310,8 +310,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments/ ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): The mode of the environment of the app. An environment with this mode should exist. +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): The mode of the environment of the app. An environment with this mode should exist. ##### Example Request @@ -327,13 +327,13 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 An object with the following key-value pairs: -* *Status* (String): Status of the environment. Possible values: Empty, Stopped, Running. -* *EnvironmentId* (String): Unique identifier of the environment. -* *Url* (String): URL to access your application. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). -* *ModelVersion* (String): The version number of the package deployed in your environment. -* *MendixVersion* (String): The Mendix version number of the package deployed in your environment. -* *Production* (Boolean): A flag indicating if this environment is a production environment. +* `Status` (String): Status of the environment. Possible values: Empty, Stopped, Running. +* `EnvironmentId` (String): Unique identifier of the environment. +* `Url` (String): URL to access your application. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `ModelVersion` (String): The version number of the package deployed in your environment. +* `MendixVersion` (String): The Mendix version number of the package deployed in your environment. +* `Production` (Boolean): A flag indicating if this environment is a production environment. ##### Error Codes @@ -372,7 +372,7 @@ URL: https://deploy.mendix.com/api/1/apps//environments//start **Request Parameters** -* *AutoSyncDb* (Boolean): Define whether the database should be synchronized automatically with the model during the start phase of the app. +* `AutoSyncDb` (Boolean): Define whether the database should be synchronized automatically with the model during the start phase of the app. **Example Request** @@ -393,7 +393,7 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 An object with the following key-value pairs: -* *JobId* (String): The identifier that can be used to track the progress of the start action +* `JobId` (String): The identifier that can be used to track the progress of the start action ##### Error Codes @@ -441,7 +441,7 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 An object with the following key-value pair: -* *Status* (String): Possible values are Starting and Started +* `Status` (String): Possible values are Starting and Started ##### Error Codes @@ -519,9 +519,9 @@ URL: https://deploy.mendix.com/api/1/apps//environments//package?ur ##### Request Parameters -* *AppId* (String): Sub-domain name of an app. -* *Mode* (String): The mode of the environment of the app. An environment with this mode should exist. -* *url* (Boolean) *(default: false)*: Indicates whether the API should return a URL pointing to the location of the package. +* `AppId` (String): Sub-domain name of an app. +* `Mode` (String): The mode of the environment of the app. An environment with this mode should exist. +* `url` (Boolean) *(default: false)*: Indicates whether the API should return a URL pointing to the location of the package. ##### Example Request @@ -538,18 +538,17 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6 An object with the following key-value pairs: -* *PackageId* (String): Unique identification of the package. -* *Name* (String): Name of the package. -* *Description* (String): Description of the package. -* *Version* (String): Package version. This is also the name of the tag on the project teamserver. -* *Creator* (String): Uploader or creator of this package. -* *CreationDate* (Date): Date that the package became available in the portal. This can be the +* `PackageId` (String): Unique identification of the package. +* `Name` (String): Name of the package. +* `Description` (String): Description of the package. +* `Version` (String): Package version. This is also the name of the tag on the project teamserver. +* `Creator` (String): Uploader or creator of this package. +* `CreationDate` (Date): Date that the package became available in the portal. This can be the upload date or the date that a build was created in the portal. -* *Status* (String): Status of the package. A package is ready to use if the status is 'Succeeded'. +* `Status` (String): Status of the package. A package is ready to use if the status is 'Succeeded'. Possible values: Succeeded, Queued, Building, Uploading and Failed. -* *Size* (Long): Size of the package in bytes. -* *Url* (object): A JSON object containing the following: - +* `Size` (Long): Size of the package in bytes. +* `Url` (object): A JSON object containing the following: * *Location*: The URL pointing to the package file. * *TTL*: How long the URL is valid (in seconds). @@ -600,9 +599,9 @@ URL: https://deploy.mendix.com/api/1/apps//packages/upload?name=/environments//transport ##### Request Parameters -* *AppId* (String): Sub-domain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). -* *PackageId* (String): ID of the deployment package +* `AppId` (String): Sub-domain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `PackageId` (String): ID of the deployment package ##### Example Request @@ -709,8 +708,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments//clean ##### Request Parameters -* *AppId* (String): Sub-domain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `AppId` (String): Sub-domain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). ##### Example Request @@ -763,8 +762,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments//settings ##### Request Parameters -* *AppId* (String): Sub-domain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `AppId` (String): Sub-domain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). ##### Example Request @@ -830,9 +829,9 @@ URL: https://deploy.mendix.com/api/1/apps//environments//settings ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). -* *Body*: JSON collection retrieved with GET method at the same URI +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `Body`: JSON collection retrieved with GET method at the same URI ##### Example Request @@ -918,8 +917,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments//scale ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). ##### Example Request @@ -983,8 +982,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments//tags ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). ##### Example Request @@ -1032,8 +1031,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments//tags ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). ##### Example Request @@ -1078,8 +1077,8 @@ URL: https://deploy.mendix.com/api/1/apps//environments//tags ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). ##### Example Request @@ -1130,9 +1129,9 @@ URL: https://deploy.mendix.com/api/1/apps//environments//logs//environments//access-log ##### Request Parameters -* *AppId* (String): Subdomain name of an app. -* *Mode* (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). -* *Date* (String): Date of the desired log in the format `YYYY-MM-DD`. +* `AppId` (String): Subdomain name of an app. +* `Mode` (String): Mode of the environment. Possible values: Test, Acceptance, Production, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments). +* `Date` (String): Date of the desired log in the format `YYYY-MM-DD`. ##### Example Request From a864bbddb1431ef9af76b2486ab0b350c8c2e81e Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Mon, 28 Oct 2024 13:07:35 +0100 Subject: [PATCH 10/11] update code format --- .../apidocs-mxsdk/apidocs/deployment/deploy-api-2.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-2.md b/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-2.md index a8c71de0bc2..ccf94929262 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-2.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/deployment/deploy-api-2.md @@ -63,9 +63,9 @@ For apps on Mendix Cloud, it is not possible to upload files bigger than 1 GB to ##### Request Parameters -* *AppId* (String): Subdomain name of an app -* *PackageName* (String): the name given to the package (MDA) when it is uploaded — if this is omitted, it will be given the name *default.mda* -* *file* (File): Deployment package as multipart/form-data (see [IETF RFC 7578: Returning Values from Forms: multipart/form-data](https://tools.ietf.org/html/rfc7578)) +* `AppId` (String): Subdomain name of an app +* `PackageName` (String): the name given to the package (MDA) when it is uploaded — if this is omitted, it will be given the name *default.mda* +* `file` (File): Deployment package as multipart/form-data (see [IETF RFC 7578: Returning Values from Forms: multipart/form-data](https://tools.ietf.org/html/rfc7578)) ##### Example Request @@ -123,8 +123,8 @@ URL: https://deploy.mendix.com/api/v2/apps//jobs/ ##### Request Parameters -* *AppId* (String): Subdomain name of an app -* *JobID* (String): the ID of a job that was triggered by a previous API call +* `AppId` (String): Subdomain name of an app +* `JobID` (String): the ID of a job that was triggered by a previous API call ##### Example Request From cf3d0a718d864aabfae32cb58a6e05a26bccd3cb Mon Sep 17 00:00:00 2001 From: Luyao Zhang Date: Mon, 28 Oct 2024 13:20:27 +0100 Subject: [PATCH 11/11] update API code format --- .../apidocs/governance/user-management-api.md | 94 +++++++++---------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/content/en/docs/apidocs-mxsdk/apidocs/governance/user-management-api.md b/content/en/docs/apidocs-mxsdk/apidocs/governance/user-management-api.md index 1a088efdb28..bed38e7a6de 100644 --- a/content/en/docs/apidocs-mxsdk/apidocs/governance/user-management-api.md +++ b/content/en/docs/apidocs-mxsdk/apidocs/governance/user-management-api.md @@ -133,7 +133,7 @@ Company Manager, Member Manager ##### Parameter -* *emailAddress* : The email address of the user account you are trying to retrieve. Please note that this address should be URL-encoded. +* `emailAddress` : The email address of the user account you are trying to retrieve. Please note that this address should be URL-encoded. ##### Example @@ -148,7 +148,7 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 #### Output -JSON object with a single key-value pair containing key *openId* containing the OpenID for the requested user account. HTTP status 200. +JSON object with a single key-value pair containing key `openId` containing the OpenID for the requested user account. HTTP status 200. ##### Example @@ -176,9 +176,9 @@ Company Manager, Member Manager ##### Optional Parameters -* *search* : Search string to find groups by name. Defaults to empty. -* *offset* : Offset within the dataset. Defaults to zero. -* *limit* : Maximum amount of objects to be retrieved. Defaults to '-1' for unlimited. +* `search` : Search string to find groups by name. Defaults to empty. +* `offset` : Offset within the dataset. Defaults to zero. +* `limit` : Maximum amount of objects to be retrieved. Defaults to '-1' for unlimited. ##### Example @@ -193,7 +193,7 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 #### Output -A JSON object with two key-value pairs; *count* indicating the total number of users in the company satisfying the search parameters (Note that depending on the chosen values for *limit* and *offset*, the number of results in the response may be lower than the *count*.) and *users* containing an array of objects with a single key-value pair *openId* containing the OpenID of a user from the company. HTTP Status 200. +A JSON object with two key-value pairs; `count` indicating the total number of users in the company satisfying the search parameters (Note that depending on the chosen values for `limit` and `offset`, the number of results in the response may be lower than the `count`.) and `users` containing an array of objects with a single key-value pair `openId` containing the OpenID of a user from the company. HTTP Status 200. ```json { @@ -238,13 +238,13 @@ Company Manager, Member Manager ##### Parameter -* *openId* : The OpenID of the user account you are trying to retrieve. Please note that since the OpenID is a URL itself, it should be URL-encoded. +* `openId` : The OpenID of the user account you are trying to retrieve. Please note that since the OpenID is a URL itself, it should be URL-encoded. ##### Payload A JSON object with keys: -* *activeStatus* (Boolean, optional) : The value to which the active status of the user should be changed. Default value: true +* `activeStatus` (Boolean, optional) : The value to which the active status of the user should be changed. Default value: true ##### Example @@ -282,7 +282,7 @@ Company Manager, Member Manager ##### Parameter -* *securityGroupUuid* : The UUID of the security group you want to retrieve. +* `securityGroupUuid` : The UUID of the security group you want to retrieve. ##### Example @@ -299,11 +299,11 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 A JSON object with the following key value pairs: -* *name* : The name of the security group -* *description* : Description of the security group. -* *uuid* : UUID of the security group. -* *memberCount* : Number of users in the security group. -* *userGroupLocked* : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. +* `name` : The name of the security group +* `description` : Description of the security group. +* `uuid` : UUID of the security group. +* `memberCount` : Number of users in the security group. +* `userGroupLocked` : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. If the call is successful, it should return HTTP status 200. @@ -336,7 +336,7 @@ Company Manager, Member Manager ##### Parameter -* *securityGroupName* : The name of the security group you want to retrieve. +* `securityGroupName` : The name of the security group you want to retrieve. ##### Example @@ -354,11 +354,11 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 A JSON object with the following key value pairs: -* *name* : The name of the security group -* *description* : Description of the security group. -* *uuid* : UUID of the security group. -* *memberCount* : Number of users in the security group. -* *userGroupLocked* : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. +* `name` : The name of the security group +* `description` : Description of the security group. +* `uuid` : UUID of the security group. +* `memberCount` : Number of users in the security group. +* `userGroupLocked` : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. If the call is successful, it should return HTTP status 200. @@ -391,9 +391,9 @@ Company Manager, Member Manager ##### Optional Parameters -* *search* : Search string to find groups by name. Defaults to empty. -* *offset* : Offset within the dataset. Defaults to zero. -* *limit* : Maximum amount of objects to be retrieved. Defaults to '-1' for unlimited. +* `search` : Search string to find groups by name. Defaults to empty. +* `offset` : Offset within the dataset. Defaults to zero. +* `limit` : Maximum amount of objects to be retrieved. Defaults to '-1' for unlimited. ##### Example @@ -408,13 +408,13 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 #### Output -JSON object with two key-value pairs; *count* indicating the total number of security groups in the company satisfying the request (Note that depending on the chosen values for *limit* and *offset*, the number of results in the response may be lower than the *count*.) and *group* containing an array of objects with the following key-value pairs: +JSON object with two key-value pairs; `count` indicating the total number of security groups in the company satisfying the request (Note that depending on the chosen values for `limit` and `offset`, the number of results in the response may be lower than the `count`.) and `group` containing an array of objects with the following key-value pairs: -* *name* : The name of the security group -* *description* : Description of the security group. -* *uuid* : UUID of the security group. -* *memberCount* : Number of users in the security group. -* *userGroupLocked* : If this is set to true, this security group cannot be changed from the user interface in the Mendix Platform. +* `name` : The name of the security group +* `description` : Description of the security group. +* `uuid` : UUID of the security group. +* `memberCount`: Number of users in the security group. +* `userGroupLocked` : If this is set to true, this security group cannot be changed from the user interface in the Mendix Platform. If the call is successful, it should return HTTP status 200. @@ -460,13 +460,13 @@ Company Manager, Member Manager ##### Parameter -* *securityGroupUuid* : The UUID of the security group of which you want to retrieve the members. +* `securityGroupUuid` : The UUID of the security group of which you want to retrieve the members. ##### Optional Parameters -* *search* : Search string to filter members by name. Defaults to empty. Not supported yet. -* *offset* : Offset within the dataset. Defaults to zero. -* *limit* : Maximum amount of objects to be retrieved. Defaults to '-1' for unlimited. +* `search` : Search string to filter members by name. Defaults to empty. Not supported yet. +* `offset` : Offset within the dataset. Defaults to zero. +* `limit` : Maximum amount of objects to be retrieved. Defaults to '-1' for unlimited. ##### Example @@ -482,7 +482,7 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 #### Output -A JSON object with two key-value pairs; *count* indicating the total number of users in the security group satisfying the search parameters (Note that depending on the chosen values for *limit* and *offset*, the number of results in the response may be lower than the *count*.) and *users* containing an array of objects with a single key-value pair *openId* containing the OpenID of a user from the security group. HTTP Status 200. +A JSON object with two key-value pairs; `count` indicating the total number of users in the security group satisfying the search parameters (Note that depending on the chosen values for `limit` and `offset`, the number of results in the response may be lower than the `count`.) and `users` containing an array of objects with a single key-value pair `openId` containing the OpenID of a user from the security group. HTTP Status 200. ##### Example @@ -520,9 +520,9 @@ Company Manager A JSON object with the following keys: -* *name* (String, required) : The name of the security group. -* *description* (String, optional) : A description for the security group. -* *userGroupLocked* (Boolean, optional) : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. Default value: false. +* `name` (String, required) : The name of the security group. +* `description` (String, optional) : A description for the security group. +* `userGroupLocked` (Boolean, optional) : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. Default value: false. ##### Example @@ -542,7 +542,7 @@ Mendix-ApiKey:87a8a34d-5ee7-43ba-81f0-7b1b17d5ecd7 #### Output -JSON object with two key-value pairs; *uuid* containing the UUID of the security group and *getUrl* containing the URL at which the group can be retrieved. HTTP status 201. +JSON object with two key-value pairs; `uuid` containing the UUID of the security group and `getUrl` containing the URL at which the group can be retrieved. HTTP status 201. ##### Example @@ -570,15 +570,15 @@ Company Manager ##### Parameter -* *securityGroupUuid* : The UUID of the security group you want to update. +* `securityGroupUuid` : The UUID of the security group you want to update. ##### Payload A JSON object with the following keys: -* *name* (String, optional) : The name of the security group. -* *description* (String, optional) : A description for the security group. -* *userGroupLocked* (Boolean, optional) : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. Default value: false. +* `name` (String, optional) : The name of the security group. +* `description` (String, optional) : A description for the security group. +* `userGroupLocked` (Boolean, optional) : This value determines whether the user group can be removed and whether users can be added/removed through the Mendix Platform Portal. True means that the user group cannot be removed and users cannot be added/removed through the Mendix Platform Portal. Default value: false. ##### Example @@ -617,7 +617,7 @@ Company Manager ##### Parameter -* *securityGroupUuid* : The UUID of the security group you want to delete. +* `securityGroupUuid`: The UUID of the security group you want to delete. ##### Example @@ -652,12 +652,12 @@ Company Manager, Member Manager ##### Parameter -* *securityGroupUuid* : The UUID of the security group to which you want to add a user account. +* `securityGroupUuid` : The UUID of the security group to which you want to add a user account. ##### Payload A JSON object with one key: -"openId" (String, required) : The OpenID of the user account that should be added to the group. +`openId` (String, required) : The OpenID of the user account that should be added to the group. ##### Example @@ -695,8 +695,8 @@ Company Manager, Members Manager ##### Parameters -* *securityGroupUuid* : The UUID of the security group from which you want to remove a user account. -* *openId* : The OpenID of the user account you want to remove from the security group. Please note that since the OpenID is a URL itself, it should be URL-encoded. +* `securityGroupUuid` : The UUID of the security group from which you want to remove a user account. +* `openId` : The OpenID of the user account you want to remove from the security group. Please note that since the OpenID is a URL itself, it should be URL-encoded. ##### Example