Skip to content

Commit 256dce9

Browse files
Merge branch 'development' into Maria-test-claude
2 parents 7734d23 + babb381 commit 256dce9

262 files changed

Lines changed: 3196 additions & 1698 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.

branch-cleanup-timestamp.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Last scan for stale merged branches: 2026-04-02 00:41:32 CEST (UTC+02:00)
1+
Last scan for stale merged branches: 2026-05-02 00:53:35 CEST (UTC+02:00)
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "API for Audit Logging"
3+
url: /apidocs-mxsdk/apidocs/apis-for-audit-logs/
4+
type: swagger
5+
restapi: true
6+
no_list: false
7+
description_list: true
8+
description: "Provides the documentation for the Audit Logging API."
9+
linktitle: "Audit Logs"
10+
beta: true
11+
---
12+
13+
{{% alert color="warning" %}}
14+
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
15+
{{% /alert %}}
16+
17+
## Introduction
18+
19+
You can use the Audit Logging API to integrate with security information and event management tools.
20+
21+
## Authentication
22+
23+
Two types of Authorization headers are supported: `Bearer` (Client credentials or Mendix SSO) and `MXToken` (Personal Access Tokens).
24+
25+
* **Client Credentials**: bearer JWT token obtained for a clientId and secret pair.
26+
Scope required: `mx:audit-logging:write`
27+
Authorization header example: `Authorization: Bearer <token>`
28+
* **Mendix SSO Tokens**: bearer token obtained via Mendix SSO login flow.
29+
Scope required: `mx:audit-logging:read`
30+
Authorization header example: `Authorization: Bearer <token>`
31+
* **Personal Access Tokens (PATs)**: PAT created by you. For details on how to generate a PAT, refer to the [Personal Access Tokens](/portal/user-settings/#pat) section in *User Settings*.
32+
Scope required: `mx:audit-logging:read`
33+
Authorization header example: `Authorization: MxToken <token>`
34+
35+
The following API reference includes information on which scope and token type is required for each endpoint.
36+
37+
{{< swaggerui src="/openapi-spec/audit-logging-v1.yaml" >}}

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/app-explorer-api.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
title: "Using the App Explorer API"
33
linktitle: "App Explorer API"
44
url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/app-explorer-api/
5-
description: "Describes how to interact with the App Explorer in Studio Pro by creating a context menu for microflows."
5+
description: "Describes how to use the App Explorer API in Studio Pro to create a context menu for microflows."
66
---
77

88
## Introduction
99

10-
This how-to describes how to interact with the App Explorer in Studio Pro. In this example, you create a menu that displays for each microflow in the App Explorer.
10+
This how-to describes how to interact with the App Explorer in Studio Pro. In this example, you create a context menu that displays for each microflow in the App Explorer.
1111

1212
## Prerequisites
1313

14-
{{% alert="info" %}}
14+
{{% alert color="info" %}}
1515
If you are using Studio Pro 11.0–11.5 and your extension includes menus, your existing menu code will not work when you upgrade to Studio Pro 11.6. To restore full functionality and support, upgrade to Extensibility API 11.6 and follow the steps in the [Migration Guide](/apidocs-mxsdk/apidocs/web-extensibility-api-11/migration-guide/).
16-
{{% /alert%}}
16+
{{% /alert %}}
1717

1818
Before starting this how-to, complete the following prerequisites:
1919

@@ -26,7 +26,7 @@ Before starting this how-to, complete the following prerequisites:
2626
Use the full name of the document type to specify which type of document a menu should belong to (for example, `Microflows$Microflow` for microflows or `Pages$Page` for pages). For more information about these document type names, see [Access a Mendix Model Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/model-api/).
2727
{{% /alert %}}
2828

29-
The code below uses the `appExplorer` API `addContextMenu` method to add the menu to all `Microflow` document nodes. When you click this menu, the document ID is sent as an argument through the `DocumentContext` argument parameter of the menu.
29+
The code below uses the `appExplorer` API `addContextMenu` method to add the context menu to all `Microflow` document nodes. When you click this menu, the document ID is sent as an argument through the `DocumentContext` argument parameter.
3030

3131
```typescript
3232
import { ComponentContext, DocumentContext, IComponent, Menu, getStudioProApi } from "@mendix/extensions-api";
@@ -54,12 +54,12 @@ export const component: IComponent = {
5454
};
5555
```
5656

57-
The `DocumentContext` payload for the menu action is an object containing a document ID (`{ documentId: string }`). When you create a menu for the `appExplorer` `addContextMenu` method, use the `DocumentContext` as the context of your menu. The `documentId` is the ID of the document the menu is attached to (in this example, the exact `Microflow` node in the App Explorer).
57+
The `DocumentContext` payload for the menu action is an object containing a document ID (`{ documentId: string }`). When you create a menu for the `appExplorer` `addContextMenu` method, use `DocumentContext` as the context of your menu. The `documentId` is the ID of the document the menu is attached to (in this example, the specific `Microflow` node in the App Explorer).
5858

59-
As explained in the [menu documentation](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/), the `DocumentContext` is not necessary to add your menu to Studio Pro. However, if you do not use it, the menu will not receive the clicked document ID.
59+
As explained in the [menu documentation](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/), `DocumentContext` is not required to add your menu to Studio Pro. However, if you do not use it, the menu will not receive the clicked document ID.
6060

6161
## Extensibility Feedback
6262

63-
If you would like to provide additional feedback, you can complete a small [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).
63+
If you would like to provide additional feedback, you can complete a short [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).
6464

6565
Any feedback is appreciated.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/custom-blob-document-api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ description: "Describes how to introduce a new document type and set up a custom
77

88
## Introduction
99

10-
This how-to describes how to introduce a new document type and set up a custom editor for users to edit documents of that type.
10+
This how-to describes how to introduce a new document type and set up a custom editor that allows users to edit documents of that type.
1111

1212
## Prerequisites
1313

1414
Before starting this how-to, make sure you have completed the following prerequisites:
1515

16-
* [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/).
16+
* [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/)
1717

1818
## Custom Document Model
1919

2020
Studio Pro allows you to extend its metamodel by adding custom document types. These documents can store arbitrary data that can be serialized as strings. When you register an editor (a user-defined UI component) for a specific document type, documents of that type appear in the UI alongside built-in document types such as constants, Java actions, and pages. They appear in the **New Document** and **Find Advanced** dialogs, context menus for adding documents, the App Explorer, and other UI elements that display Studio Pro documents. You can register custom editors to appear as tabs or as modal dialogs.
2121

2222
## Registering a New Document Type
2323

24-
To register a new document type, follow these steps:
24+
To register a new document type, do the following:
2525

2626
1. Generate a new extension named `myextension` as described in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/).
2727
2. Replace the contents of `src/main/index.ts` with the code below:
@@ -64,7 +64,7 @@ To register a new document type, follow these steps:
6464
export const personDarkThemeIcon = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAWdJREFUSIm1ljFuwkAQRd/giFTkABS5gMsolBRcIFBwCOTGNUfgDtDRJ9yDioaCKlJ8B0dYmyLjZGLtrh0Jj7SyNPP3f894dtbinHP0aIM+yQHuYkERuQdegDnwBIw1VABH4BV4c86VQRIXMGABXADXsi7AIsjjIR4AG0NwAnIgBUa6UvWdDG4DDLoI1OQlkAFJJMtEMWUtEhXQstTksxCxR2hmRP6UCwMamppnXcnN/sx8k6FPYGlqHixLRCAx32RZ++05mOtz65y7Btsu3I1XYNvgwmZwJty1XbNINYOzL4MxgIg8/Pftjb1bLmgZFSJSiAgiMvHEJhorYhxWoAY+Gt9RnyvP3lUDY/f+ipr67fmuX258U6ACPoEd8Kxrp74KmBp8rhz7H58JetsUWCtRcwZVwLqtTTsdNM3kAHzoOtg3V0z8oCmov1FhwP0NO93U77g2Qje5cETJvHaLKzMqcAvr/a/iC+JcVEP5CMhEAAAAAElFTkSuQmCC';
6565
```
6666

67-
4. Add another file `src/model/PersonInfo.ts` in the same directory:
67+
4. Add another file, `src/model/PersonInfo.ts`, in the same directory:
6868

6969
```typescript
7070
export type PersonInfo = {
@@ -245,13 +245,13 @@ To register a new document type, follow these steps:
245245

246246
### Register the Document Type
247247

248-
In `src/main/index.ts`, you register a new document type. After you register the document type, you can perform all CRUD operations on it. However, the document type does not appear in the UI until you also register an editor.
248+
In `src/main/index.ts`, you register a new document type. After you register the document type, you can perform all create, read, update, and delete (CRUD) operations on it. However, the document type does not appear in the UI until you also register an editor.
249249

250250
Optionally, you can provide a `readableTypeName` to display a user-friendly name in logs and the Studio Pro UI instead of the full type name. You can also customize how the document contents serialize to a string. By default, the API uses `JSON.stringify` for serialization and `JSON.parse` for deserialization.
251251

252252
### Register the Editor
253253

254-
The next call to the Studio Pro API in `src/main/index.ts` registers an editor for the document type. This call does the following:
254+
The next call to the Studio Pro API in `src/main/index.ts` registers an editor for the document type. This does the following:
255255

256256
* Registers the `editor` entry point of the extension to the document type, so the editor appears when users interact with the document in Studio Pro (for example, through the **App Explorer** or **Find Results**)
257257
* Displays the editor as a tab, though you can also configure it to display as a modal dialog
@@ -273,6 +273,6 @@ The highlighted text in `build-extension.mjs` and `manifest.json` shows the chan
273273

274274
## Extensibility Feedback
275275

276-
If you would like to provide us with additional feedback, you can complete a small [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).
276+
If you would like to provide us with additional feedback, you can complete a short [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).
277277

278278
Any feedback is appreciated.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/dialog-api.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ It also describes how to show a progress dialog that follows a sequence of steps
1212

1313
## Prerequisites
1414

15-
{{% alert="info" %}}
15+
{{% alert color="info" %}}
1616
If you are using Studio Pro 11.0–11.5 and your extension includes menus, your existing menu code will not work when you upgrade to Studio Pro 11.6. To restore full functionality and support, upgrade to the Extensibility API 11.6 and follow the steps in the [Migration Guide](/apidocs-mxsdk/apidocs/web-extensibility-api-11/migration-guide/).
17-
{{% /alert%}}
17+
{{% /alert %}}
1818

1919
Before starting this how-to, complete the following prerequisites:
2020

@@ -23,11 +23,11 @@ Before starting this how-to, complete the following prerequisites:
2323

2424
## Opening a Modal Dialog
2525

26-
Create a menu item to open the dialog inside the `loaded` event in the main entry point (`src/main/index.ts`). For more information, see [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
26+
To open a modal dialog, create a menu item inside the `loaded` event in the main entry point (`src/main/index.ts`). For more information, see [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
2727

28-
In a listener event called `menuItemActivated`, the `studioPro.ui.dialogs.showModal(<dialogInfo>, <uiSpec>)` call opens a new dialog. The parameters are:
28+
In the `menuItemActivated` listener event, call `studioPro.ui.dialogs.showModal(<dialogInfo>, <uiSpec>)` to open a new dialog. The parameters are:
2929

30-
* `<dialogInfo>` – An object containing the `title` of the dialog, which is shown in the title bar of your dialog in Studio Pro. It also contains the `contentSize` object, where you can provide `height` and `width` dimensions for the dialog.
30+
* `<dialogInfo>` – An object containing the `title` of the dialog (shown in the title bar of your dialog in Studio Pro) and the `contentSize` object, where you can provide `height` and `width` dimensions for the dialog.
3131
* `<uiSpec>` – An object containing two required properties and one optional property:
3232

3333
* `componentName` – The name of the extension prefixed with `extension/`. For example, `extension/myextension`.
@@ -40,7 +40,7 @@ When the `showModal` method is called, it returns a `Promise` of `unknown` or `n
4040
In the example below, the dialog contains a form where an object is modified and then returned when the dialog closes.
4141
{{% /alert %}}
4242

43-
An example of the main entry point (`src/main/index.ts`) to open a modal dialog called *My Extension Dialog* looks similar to the following:
43+
The following example shows the main entry point (`src/main/index.ts`) that opens a modal dialog:
4444

4545
```typescript
4646
import { IComponent, getStudioProApi } from "@mendix/extensions-api";
@@ -74,7 +74,7 @@ export const component: IComponent = {
7474
};
7575
```
7676

77-
## Filling the Dialog With Content
77+
## Filling the Dialog with Content
7878

7979
In the previous example, the `uiEntryPoint` property of the `<uispec>` object has the value `dialog`. This value must match the one in the manifest. The following example shows the dialog under the `ui` property:
8080

@@ -197,8 +197,7 @@ In the previous example, the `uiEntryPoint` property of the `<uispec>` object ha
197197

198198
The `dialogId` property is retrieved from the query parameters of the web page. This value is generated when the dialog API is first called. It is then passed back to the web content so the `close` or `closeWithResult` methods can be called successfully. The dialog API needs this ID to close the correct dialog.
199199

200-
This simple form contains two text boxes for `firstName` and `lastName`. When you submit the form, it closes the dialog and passes the content of the object modified by the form.
201-
The form also contains a **Close** button, which calls the `close` method without any extra data, except the required `dialogId`.
200+
This form contains two text boxes for `firstName` and `lastName`. When you submit the form, it closes the dialog and passes the content of the object modified by the form. The form also contains a **Close** button, which calls the `close` method without any extra data, except the required `dialogId`.
202201

203202
After you build and install the extension in Studio Pro, the dialog opens when you click the menu and displays the web content from the `dialog.tsx` file.
204203

@@ -220,11 +219,11 @@ You can modify the dimensions of a dialog using the `update` method. To do this,
220219
</button>
221220
```
222221

223-
You can also modify the dialog's dimensions while it is open.
222+
You can modify the dialog's dimensions while it is open.
224223

225224
## Showing a Progress Dialog {#process-dialog}
226225

227-
To show a progress dialog, call the method `studioPro.ui.dialogs.showProgressDialog(<title>, <steps>)`. The parameters are:
226+
To show a progress dialog, call the method `studioPro.ui.dialogs.showProgressDialog(<title>, <steps>)`. The parameters are:
228227

229228
* `<title>`A string that is displayed in the title bar of the dialog.
230229
* `<steps>`An array of `ProgressDialogStep` objects, which run in the same order provided in the array. A `ProgressDialogStep` object contains the following properties:
@@ -247,7 +246,7 @@ The `FailedProgressStepResult` object contains the following properties:
247246
* `stepTitle`The title of the step that failed, causing the whole process to fail.
248247
* `error`A string that describes the error or exception that occurred during step execution.
249248

250-
The following example creates a menu to show the modal progress dialog and runs three steps inside the `loaded` event in the main entry point (`src/main/index.ts`).
249+
The following example creates a menu to show the modal progress dialog and runs three steps inside the `loaded` event in the main entry point (`src/main/index.ts`):
251250

252251
```typescript
253252
import { ComponentContext, IComponent, ProgressDialogStep, getStudioProApi } from "@mendix/extensions-api";
@@ -332,10 +331,11 @@ const step: ProgressDialogStep = {
332331
```
333332

334333
When running, the progress dialog looks like this:
334+
335335
{{< figure src="/attachments/apidocs-mxsdk/apidocs/extensibility-api/web/dialogs/sample-progress-dialog.png" alt="Sample progress dialog showing three steps" width="300" >}}
336336

337337
## Extensibility Feedback
338338

339-
If you would like to provide additional feedback, you can complete a small [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).
339+
If you would like to provide additional feedback, you can complete a short [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).
340340

341341
Any feedback is appreciated.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/dockable-pane-api.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22
title: "Create a Dockable Pane Using Web API"
33
linktitle: "Dockable Pane"
44
url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/dockable-pane-api/
5+
description: "Describes how to create and manage a dockable pane using the web extensions API in Studio Pro."
56
---
67

78
## Introduction
89

9-
This how-to describes creating and managing a dockable pane using the web extensions API. A dockable pane is a web view that can be docked and moved within the Studio Pro user interface. Examples of dockable panes in Studio Pro include the following:
10+
This how-to describes how to create and manage a dockable pane using the web extensions API. A dockable pane is a web view that can be docked and moved within Studio Pro. Examples of dockable panes in Studio Pro include the following:
1011

1112
* Marketplace
1213
* Errors
@@ -15,12 +16,12 @@ This how-to describes creating and managing a dockable pane using the web extens
1516

1617
## Prerequisites
1718

18-
{{% alert="info" %}}
19+
{{% alert color="info" %}}
1920
If you are using Studio Pro 11.0–11.5 and your extension includes menus, your existing menu code will not work when you upgrade to Studio Pro 11.6. To restore full functionality and support, upgrade to the Extensibility API 11.6 and follow the steps in the [Migration Guide](/apidocs-mxsdk/apidocs/web-extensibility-api-11/migration-guide/).
20-
{{% /alert%}}
21+
{{% /alert %}}
2122

2223
* This how-to uses the app created in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Complete that how-to before starting this one.
23-
* Be familiar with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
24+
* Familiarize yourself with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
2425

2526
## Creating a Dockable Pane
2627

@@ -100,7 +101,7 @@ Alter the `build-extension.mjs` and `manifest.json` files to bind to the correct
100101

101102
### Altering `build-extension.mjs`
102103

103-
Instruct esbuild to produce JavaScript modules that correspond to `src/ui/tab.tsx` and `src/ui/dockablepane.tsx`. To do this, change the call to `entryPoints.push` in line 16:
104+
Instruct esbuild to produce JavaScript modules that correspond to `src/ui/tab.tsx` and `src/ui/dockablepane.tsx`. To do this, change the call to `entryPoints.push` on line 16:
104105

105106
```typescript
106107
entryPoints.push({
@@ -157,7 +158,7 @@ else {
157158
}
158159
```
159160

160-
This ensures esbuild considers these two `.tsx` files as entrypoints and produces JavaScript modules in the `dist` folder corresponding to the name in `out`.
161+
This ensures that esbuild considers these two `.tsx` files as entry points and produces JavaScript modules in the `dist` folder corresponding to the name in `out`.
161162

162163
### Altering `src/manifest.json`
163164

@@ -285,6 +286,6 @@ The `loaded` method should now look like this:
285286

286287
## Extensibility Feedback
287288

288-
If you would like to provide additional feedback, you can complete a small [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback)
289+
If you would like to provide additional feedback, you can complete a short [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback)
289290

290291
Any feedback is appreciated.

0 commit comments

Comments
 (0)