You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/deploy-api-3.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Authentication for the Deploy API v3 uses a personal access token (PAT).
26
26
27
27
### 2.1 Generating a PAT
28
28
29
-
To generate a PAT, see the [Personal Access Tokens](/developerportal/community-tools/mendix-profile/#pat) section of*Mendix Profile*.
29
+
To generate a PAT, see the [Personal Access Tokens](/developerportal/community-tools/mendix-profile/#pat) section in*Mendix Profile*.
30
30
31
31
Select the following as **Deployment Mendix Cloud** scopes:
32
32
@@ -58,6 +58,10 @@ The {appId} in version 3 is retrieved as the {ProjectId} from the version 1 API.
58
58
59
59
The following steps will change the Technical Contact of the app identified by the UUID {appId}.
60
60
61
+
{{% alert color="info" %}}
62
+
Only Mendix Admins of the company and the current Technical Contact can give the Technical Contact role to another team member. It is currently not possible to have more than one Technical Contact for an app.
63
+
{{% /alert %}}
64
+
61
65
1. Set up your authentication PAT. You must have permission to change the Technical Contact of the app.
62
66
1. Create a request body containing the userId of the new Technical Contact. For example, to make jane.doe@domain.tld the new Technical Contact, provide a body as shown below:
63
67
@@ -77,9 +81,12 @@ The following steps will change the Technical Contact of the app identified by t
77
81
78
82
### 3.2 Using the API to Change App Team Members' Access Permissions to an Environment
79
83
80
-
The following steps will change the permissions of a team member to an environment of the app identified by the UUID {appId}.
84
+
The following steps will change the permissions of a team member to an environment of the app identified by the UUID {appId}:
85
+
86
+
{{% alert color="info" %}}Only the following people can change the access permissions of team members: Mendix Admins of the company, the Technical Contact of the app, and the app team members who can manage permissions.{{% /alert %}}
87
+
88
+
1. Set up your authentication PAT. You must have permission to **Manage Permissions** for the app.
81
89
82
-
1. Set up your authentication PAT. You must have permission to **Manage Permissions** for the app.
83
90
1. Call `GET /apps/{appId}/environments/{environmentId}/permissions` to get the existing Team Members' permissions for this {environmentId} of this {appId}. For example:
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/private-cloud-deploy-api.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -110,14 +110,14 @@ The following steps will create a cluster, register and install a namespace, add
110
110
The following steps will restart an app by setting the number of instances to zero and then setting it back to the number of instances required.
111
111
112
112
1. Set up your authentication PAT.
113
-
2. Call `GET /apps/{appId}/environments/{environmentId}` to get the environment manifest for your app environment.
113
+
2. Call `GET /apps/{appId}/namespaces/{namespaceId}/environments/{environmentId}` to get the environment manifest for your app environment.
114
114
3. Change the `container.instances` to `0` in the manifest.
115
-
4. Call `PUT /apps/{appId}/environments/{environmentId}` using the updated manifest.
115
+
4. Call `PUT /apps/{appId}/namespaces/{namespaceId}/environments/{environmentId}` using the updated manifest.
116
116
5. Verify that the job is successful using the process described in [Managing Asynchronous Jobs](#async-jobs).
117
117
118
118
At this point, your app is stopped and you will not be able to access it using the `appURL`.
119
119
6. Change the `container.instances` in the manifest to the number of instances you want to run.
120
-
7. Call `PUT /apps/{appId}/environments/{environmentId}` using the updated manifest.
120
+
7. Call `PUT /apps/{appId}/environments/namespaces/{namespaceId}/{environmentId}` using the updated manifest.
121
121
8. Verify that the job is successful, as before.
122
122
123
123
Your app is available once more.
@@ -140,10 +140,10 @@ The following steps will create a cluster, create a namespace, and create an env
140
140
11. Create a `DeploymentPackage` in the Private Cloud Portal.
141
141
You can create a deployment package by using the [Mendix for Private Cloud Build API](/apidocs-mxsdk/apidocs/private-cloud-build-api/). Once you create a deployment package, you can retrieve the `packageId` using the `GET /apps/{appId}/packages` response.
142
142
12. Prepare a manifest for your new environment.
143
-
Either use the model in the OpenAPI spec file or get the manifest of an existing environment (by calling `GET /apps/{appId}/environments/{environmentId}`, for example) and change where required. Remember to use the `{clusterID}` and `{namespace}` values for the `provider` using the cluster and namespace you have just created, and use the ID of the deployment package you have just created as the `packageId`.
143
+
Either use the model in the OpenAPI spec file or get the manifest of an existing environment (by calling `GET /apps/{appId}/namespaces/{namespaceId}/environments/{environmentId}`, for example) and change where required. Remember to use the `{clusterID}` and `{namespace}` values for the `provider` using the cluster and namespace you have just created, and use the ID of the deployment package you have just created as the `packageId`.
144
144
13. Make the API call `POST /apps/{appId}/environments` using the environment manifest to create a new environment.
145
145
14. Verify that the job is successful using the process described in [Managing Asynchronous Jobs](#async-jobs).
146
-
15. Now you can access the application at the `appURL` which is returned from `GET /apps/{appId}/environments/{environmentId}` of the environment.
146
+
15. Now you can access the application at the `appURL` which is returned from `GET /apps/{appId}/namespaces/{namespaceId}/environments/{environmentId}` of the environment.
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/_index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ To learn how to navigate to the main documentation sources, refer to the [How to
40
40
41
41
### 3.1 Development Workflow
42
42
43
-
The script you used in the Creating your first script step was doing a full round-trip. It created an app, made it available as a working copy and committed it back to the TeamServer after making changes. Depending on what exactly you're using the SDK for (see [Use Case Examples](/apidocs-mxsdk/mxsdk/sdk-use-cases/)), this may or may not be a good idea. If you're interested in, for instance, analyzing your model, you want to start from an existing project instead of a newly created app and you won't have any changes to your model to commit.
43
+
The script you used in the Creating your first script step was doing a full round-trip. It created an app, made it available as a working copy and committed it back to the TeamServer after making changes. Depending on what exactly you're using the SDK for (see [Use Case Examples](/apidocs-mxsdk/mxsdk/sdk-use-cases/)), this may or may not be a good idea. If you are interested in, for instance, analyzing your model, you want to start from an existing app instead of a newly created app and you will not have any changes to your model to commit.
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/generating-code-from-the-model.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -170,7 +170,7 @@ function generate(domainModel1: domainmodels.DomainModel, model: IModel) {
170
170
}
171
171
```
172
172
173
-
For the next step, you will create a script that make use of the function. The script is written in TypeScript, so it will be able to run a JavaScript code just fine. This script will create a blank project and modify the domain model in the 'MyFirstModule' module.
173
+
For the next step, you will create a script that make use of the function. The script is written in TypeScript, so it will be able to run a JavaScript code just fine. This script will create a blank app and modify the domain model in the `MyFirstModule` module.
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/manipulating-existing-models/finding-things-in-the-model.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The `model` object you get back from `workingCopy.model()` can be used to find a
10
10
11
11
## 2 The model.root Property
12
12
13
-
The `root` object refers to the `root`project node in the **App Explorer** in Studio Pro. From there, you can walk through the app tree and into specific documents.
13
+
The `root` object refers to the `root`app node in the **App Explorer** in Studio Pro. From there, you can walk through the app tree and into specific documents.
14
14
15
15
For example, this snippet finds the name of the first attribute of the `Customer` entity in the first module of your app:
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/setting-up-your-development-environment.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ This document will lead you through the process of setting up everything you nee
10
10
11
11
## 2 Quick Installation
12
12
13
-
If you know what you are doing, the quick installation instructions below are for you. Otherwise, please skip this paragraph and continue with the [Setting Up Your Development Tools](#setting) section.
13
+
If you know what you are doing, the quick installation instructions below are for you. Otherwise, skip this paragraph and continue with the [Setting Up Your Development Tools](#setting) section.
14
14
15
15
For the quick installation, we assume that you have `node` already installed.
16
16
Set up a new `node` project and install the dependencies using the following steps:
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/using-platform-sdk.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ You can pass the following options to `createNewApp`:
43
43
|`templateDownloadURL`| The URL of the download location of the app template package file (*.mpk*). If the template package is private, this URL must be authenticated with a signature. |
44
44
|`templateId`| The UUID of the app template on which the app should be based. |
45
45
46
-
If both `templateDownloadURL` and `templateId` are left blank, the app project will be created using the standard blank app template in the latest Mendix version.
46
+
If both `templateDownloadURL` and `templateId` are left blank, the app will be created using the standard blank app template in the latest Mendix version.
47
47
48
48
Here is an example for creating a Mendix app based on the [Asset Management](https://marketplace.mendix.com/link/component/107652) template:
*[Definitive Guide to TypeScript](https://www.sitepen.com/blog/2013/12/31/definitive-guide-to-typescript/) - covers TypeScript 1.5,slightly older than the current release, but still useful
28
28
*[Editing TypeScript](https://code.visualstudio.com/docs/languages/typescript) with Visual Studio Code
29
-
* Debugging your project with [Node Inspector](https://www.npmjs.com/package/node-inspector)
29
+
* Debugging your app with [Node Inspector](https://www.npmjs.com/package/node-inspector)
0 commit comments