Skip to content

Commit c3c099d

Browse files
Merge branch 'development' into PLCM_Beta_Release
2 parents 1e1e7fb + e48fdb1 commit c3c099d

582 files changed

Lines changed: 23472 additions & 7485 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/remunusedattachments.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ jobs:
3030
body: |
3131
"We're trying to delete some unnecessary attachments."
3232
branch: rem-unused-attachments
33-
assignees: JohannaHemminger
34-
reviewers: JohannaHemminger
33+
assignees: MarkvanMents
34+
reviewers: MarkvanMents
3535
labels: Internal WIP
3636
add-paths: |
3737
static/attachments/**

content/en/docs/apidocs-mxsdk/apidocs/deploy-api-3.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Authentication for the Deploy API v3 uses a personal access token (PAT).
2626

2727
### 2.1 Generating a PAT
2828

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*.
3030

3131
Select the following as **Deployment Mendix Cloud** scopes:
3232

@@ -58,6 +58,10 @@ The {appId} in version 3 is retrieved as the {ProjectId} from the version 1 API.
5858

5959
The following steps will change the Technical Contact of the app identified by the UUID {appId}.
6060

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+
6165
1. Set up your authentication PAT. You must have permission to change the Technical Contact of the app.
6266
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:
6367

@@ -77,9 +81,12 @@ The following steps will change the Technical Contact of the app identified by t
7781

7882
### 3.2 Using the API to Change App Team Members' Access Permissions to an Environment
7983

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.
8189

82-
1. Set up your authentication PAT. You must have permission to **Manage Permissions** for the app.
8390
1. Call `GET /apps/{appId}/environments/{environmentId}/permissions` to get the existing Team Members' permissions for this {environmentId} of this {appId}. For example:
8491

8592
```http {linenos=false}

content/en/docs/apidocs-mxsdk/apidocs/private-cloud-deploy-api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ The following steps will create a cluster, register and install a namespace, add
110110
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.
111111

112112
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.
114114
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.
116116
5. Verify that the job is successful using the process described in [Managing Asynchronous Jobs](#async-jobs).
117117

118118
At this point, your app is stopped and you will not be able to access it using the `appURL`.
119119
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.
121121
8. Verify that the job is successful, as before.
122122

123123
Your app is available once more.
@@ -140,10 +140,10 @@ The following steps will create a cluster, create a namespace, and create an env
140140
11. Create a `DeploymentPackage` in the Private Cloud Portal.
141141
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.
142142
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`.
144144
13. Make the API call `POST /apps/{appId}/environments` using the environment manifest to create a new environment.
145145
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.
147147

148148
## 4 API Reference
149149

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ To learn how to navigate to the main documentation sources, refer to the [How to
4040

4141
### 3.1 Development Workflow
4242

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.
4444

4545
### 3.2 How to Manipulate Existing Models
4646

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/generating-code-from-the-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ function generate(domainModel1: domainmodels.DomainModel, model: IModel) {
170170
}
171171
```
172172
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.
174174
175175
```ts
176176
import { domainmodels, IModel } from "mendixmodelsdk";
@@ -210,6 +210,6 @@ Execute the script. You should have a new app with the generated entities.
210210
211211
{{% alert color="info" %}}
212212
213-
Instead of creating a new app, you can also reuse an existing project or even an existing online working copy.
213+
Instead of creating a new app, you can also reuse an existing app or even an existing online working copy.
214214
215215
{{% /alert %}}

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/manipulating-existing-models/finding-things-in-the-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The `model` object you get back from `workingCopy.model()` can be used to find a
1010

1111
## 2 The model.root Property
1212

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.
1414

1515
For example, this snippet finds the name of the first attribute of the `Customer` entity in the first module of your app:
1616

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/sdk-old-versions-howtos/old-creating-your-first-script.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ For more information, see [Async Await](https://basarat.gitbook.io/typescript/fu
137137
```
138138

139139
{{% alert color="info" %}}
140-
The steps for app (project) creation (line 3) and committing to the Team Server (line 10) can take some time, so please be patient. Be aware that 'revision -1' refers to the latest revision, and that 'branch null' is equal to the main line.
140+
The steps for app creation (line 3) and committing to the Team Server (line 10) can take some time, so please be patient. Be aware that 'revision -1' refers to the latest revision, and that 'branch null' is equal to the main line.
141141
{{% /alert %}}
142142

143143
## 5 Opening the App in Studio Pro

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/setting-up-your-development-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document will lead you through the process of setting up everything you nee
1010

1111
## 2 Quick Installation
1212

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.
1414

1515
For the quick installation, we assume that you have `node` already installed.
1616
Set up a new `node` project and install the dependencies using the following steps:

content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/using-platform-sdk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ You can pass the following options to `createNewApp`:
4343
| `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. |
4444
| `templateId` | The UUID of the app template on which the app should be based. |
4545

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.
4747

4848
Here is an example for creating a Mendix app based on the [Asset Management](https://marketplace.mendix.com/link/component/107652) template:
4949

content/en/docs/apidocs-mxsdk/mxsdk/sdk-refguide/javascript-typescript-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ If you have any additional useful resources, feel free to mention them in the co
2626
* [Official TypeScript website](http://www.typescriptlang.org/Handbook) - Tutorial, handbook, samples
2727
* [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
2828
* [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)
3030

3131
## 4 Videos
3232

0 commit comments

Comments
 (0)