Skip to content

Commit 2487d8b

Browse files
Merge branch 'development' into moo/native-template-15.4.0-docs-update
2 parents c428b6e + 511e20c commit 2487d8b

File tree

679 files changed

+11246
-4221
lines changed

Some content is hidden

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

679 files changed

+11246
-4221
lines changed

config/_default/hugo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,9 @@ replacements = "github.com/FortAwesome/Font-Awesome -> ., github.com/twbs/bootst
157157
footer_about_disable = true
158158
# NK - set sidebar to be foldable
159159
sidebar_menu_foldable = true
160-
160+
# MvM - don't truncate sidebar tree items: see https://github.com/google/docsy/issues/1026
161+
sidebar_menu_truncate = 100
162+
161163
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
162164
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
163165
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,

content/en/docs/apidocs-mxsdk/apidocs/apps/app-repository-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 10
88

99
## Introduction
1010

11-
The App Repository API enables retrieving information (branches, commits) of application models stored in our [Team Server](/developerportal/general/team-server/).
11+
The App Repository API enables retrieving information (branches, commits) of application models stored in our [Team Server](/developerportal/repository/team-server/).
1212

1313
## Base URL
1414

@@ -107,7 +107,7 @@ Returns information about the version control repository for a Mendix app.
107107

108108
|Name|Type|Required|Description|
109109
|---|---|---|---|
110-
|`AppId`|String|Yes|The App ID of the Mendix app for which the repository information should be returned. You can find this under **Project ID** in the [General](/developerportal/collaborate/general-settings/) tab of the **Settings** page after you open your app in [Apps](https://sprintr.home.mendix.com/). |
110+
|`AppId`|String|Yes|The App ID of the Mendix app for which the repository information should be returned. You can find this under **Project ID** in the [General](/developerportal/general-settings/) tab of the **Settings** page after you open your app in [Apps](https://sprintr.home.mendix.com/). |
111111

112112
##### Example
113113

content/en/docs/apidocs-mxsdk/apidocs/deployment/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ url: /apidocs-mxsdk/apidocs/apis-for-deployment/
44
type: swagger
55
no_list: false
66
description_list: true
7-
description: "Provides the documentation of APIs for Deployment, including Backups API, Build API, Deploy API, Mendix on Kubernetes Build API, Mendix on Kubernetes Deploy API, Pipelines API, and Webhooks API."
7+
description: "Provides the documentation of APIs for Deployment, including Backups API, Build API, Deploy API, Mendix on Kubernetes Build API, Mendix on Kubernetes Deploy API, Mendix Pipelines API, and Webhooks API."
88
weight: 20
99
linktitle: "Deployment"
1010
---

content/en/docs/apidocs-mxsdk/apidocs/deployment/pipelines-api.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: "Pipelines API"
2+
title: "Mendix Pipelines API"
33
url: /apidocs-mxsdk/apidocs/pipelines-api/
44
type: swagger
5-
description: "The Pipelines API sends requests to pipelines."
5+
description: "The Mendix Pipelines API sends requests to the Mendix Pipelines."
66
restapi: true
77
weight: 85
88
---
99

1010
## Introduction
1111

12-
The Pipelines API lets you start a new pipeline run for a saved and activated pipeline design and retrieve the status of a pipeline run.
12+
The Mendix Pipelines API lets you start a new Mendix Pipeline run for a saved and activated Mendix Pipeline design and retrieve the status of a Mendix Pipeline run.
1313

14-
For details on pipelines, see [Pipelines](/developerportal/deploy/pipelines/).
14+
For details on pipelines, see [Mendix Pipelines](/developerportal/deploy/mendix-pipelines/).
1515

1616
## Authentication {#authentication}
1717

18-
Authentication for the Pipelines API uses a personal access token (PAT).
18+
Authentication for the Mendix Pipelines API uses a personal access token (PAT).
1919

2020
### Generating a PAT {#generate}
2121

@@ -36,4 +36,8 @@ Authorization: MxToken 7LJE…vk
3636

3737
## API Reference{#api-reference}
3838

39-
{{< swaggerui src="/openapi-spec/pipelines.yaml" >}}
39+
{{% alert color="warning" %}}
40+
You cannot call endpoints from the Mendix Pipelines API Swagger UI.
41+
{{% /alert %}}
42+
43+
{{< swaggerui-disable-try-it-out src="/openapi-spec/pipelines.yaml" >}}

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/web/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ weight: 20
1515

1616
Extensions can be written in Typescript or other web languages, described here, or using a C# API which is documented separately in [Extensibility API for C# Developers](/apidocs-mxsdk/apidocs/csharp-extensibility-api-10/).
1717

18+
For more detailed information on the web API, see the [Mendix Studio Pro Web Extensibility API reference documentation](http://apidocs.rnd.mendix.com/10/extensions-api/index.html).
19+
1820
## Prerequisites
1921

2022
* You need at least a basic understanding of the Mendix platform.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-client-apis/_index.md

Lines changed: 21 additions & 17 deletions
Large diffs are not rendered by default.

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-client-apis/pluggable-widgets-client-apis-list-values.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ description: A guide to understanding the list of objects for the datasource pro
66

77
## Introduction
88

9-
`ListValue` is used to represent a list of objects for the [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#datasource) property. Corresponding list item values represent properties of different types linked to a [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#datasource) property.
9+
`ListValue` is used to represent a list of objects for the [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#datasource) property. Corresponding list item values represent properties of different types linked to a [datasource](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#datasource) property.
1010

1111
## ListValue {#listvalue}
1212

13-
When a [`datasource`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#datasource) property with `isList="true"` is configured for a widget, the client component gets a list of objects represented as a `ListValue`. This type allows detailed access and control over the data source.
13+
When a [`datasource`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#datasource) property with `isList="true"` is configured for a widget, the client component gets a list of objects represented as a `ListValue`. This type allows detailed access and control over the data source.
1414

1515
```ts
1616
export interface ObjectItem {
@@ -315,7 +315,7 @@ It is possible to reload items of a datasource. The `reload()` method triggers a
315315

316316
### Working With Actual Data
317317

318-
The `items` property contains all the requested data items of the datasource. However, it is not possible to access domain data directly from `ListValue`, as every object is represented only by GUID in the `items` array. Instead, a list of items may be used in combination with other properties, for example with a property of type [`attribute`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#attribute), [`action`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#action), or [`widgets`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#widgets). See the next section for detailed information about working with different property types in combination with `ListValue`.
318+
The `items` property contains all the requested data items of the datasource. However, it is not possible to access domain data directly from `ListValue`, as every object is represented only by GUID in the `items` array. Instead, a list of items may be used in combination with other properties, for example with a property of type [`attribute`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#attribute), [`action`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#action), or [`widgets`](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#widgets). See the next section for detailed information about working with different property types in combination with `ListValue`.
319319

320320
### View State {#view-state}
321321

@@ -390,11 +390,11 @@ const actionOnFirstItem = this.props.myListAction.get(this.props.myDataSource.it
390390
actionOnFirstItem.execute();
391391
```
392392

393-
In this code sample, checks of status `myDataSource` and availability of items are omitted for simplicity. See the [ActionValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#actionvalue) for more information about the usage of `ActionValue`.
393+
In this code sample, checks of status `myDataSource` and availability of items are omitted for simplicity. See the [ActionValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#actionvalue) for more information about the usage of `ActionValue`.
394394

395395
### ListAttributeValue {#listattributevalue}
396396

397-
`ListAttributeValue` represents an [attribute property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#attribute) that is linked to a data source.
397+
`ListAttributeValue` represents an [attribute property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#attribute) that is linked to a data source.
398398
This allows the client component to access attribute values on individual items from a `ListValue`. `ListAttributeValue` is an object and its definition is as follows:
399399

400400
```ts
@@ -435,7 +435,7 @@ The following code sample shows how to get an `EditableValue<string>` that repre
435435
const attributeValue = this.props.myAttributeOnDatasource.get(this.props.myDataSource.items[0]);
436436
```
437437

438-
Note: in this code sample checks of status of `myDataSource` and availability of items are omitted for simplicity. See [EditableValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value) for more information about usage of `EditableValue`.
438+
Note: in this code sample checks of status of `myDataSource` and availability of items are omitted for simplicity. See [EditableValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#editable-value) for more information about usage of `EditableValue`.
439439

440440
#### Attribute ID, Sortable and Filterable Flags {#listattributevalue-id-sortable-filterable}
441441

@@ -445,7 +445,7 @@ Fields `sortable` and `filterable` specify if the attribute could be used for so
445445

446446
#### Attribute Type
447447

448-
The [attribute](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#attribute) property defines which attribute types can be configured for that property. For example, an attribute property may be configured to allow attributes of type `String` and `Integer` in order to present progress. While this is convenient for users, it may require additional work for developers by processing different data types.
448+
The [attribute](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#attribute) property defines which attribute types can be configured for that property. For example, an attribute property may be configured to allow attributes of type `String` and `Integer` in order to present progress. While this is convenient for users, it may require additional work for developers by processing different data types.
449449

450450
It is possible to determine the type of attribute by checking the `type` field on an attribute property. The following code sample shows how to check the attribute type on the property named `myAttributeOnDatasource`:
451451

@@ -463,11 +463,11 @@ if (this.props.myAttributeOnDatasource.type === "String") {
463463

464464
The `formatter` field represents the default formatter used on values obtained by the `get` function.
465465

466-
The optional `universe` field represents an array of possible values for an attribute. For more information, see the `universe` field of [EditableValue](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value).
466+
The optional `universe` field represents an array of possible values for an attribute. For more information, see the `universe` field of [EditableValue](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#editable-value).
467467

468468
### ListReferenceValue and ListReferenceSetValue {#listassociationvalue}
469469

470-
`ListReferenceValue` and `ListReferenceSetValue` are both used to represent an [association property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#association) that is linked to a data source. This allows the client component to access associated values of individual items from a `ListValue`. `ListReferenceValue` and `ListReferenceSetValue` are both objects and their definitions are as follows:
470+
`ListReferenceValue` and `ListReferenceSetValue` are both used to represent an [association property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#association) that is linked to a data source. This allows the client component to access associated values of individual items from a `ListValue`. `ListReferenceValue` and `ListReferenceSetValue` are both objects and their definitions are as follows:
471471

472472
```ts
473473
export type ListReferenceValue = ListAssociationValue<ObjectItem> & { type: "Reference" };
@@ -505,9 +505,9 @@ The following code example shows how to get a `DynamicValue<ObjectItem>` that re
505505
const associationValue = this.props.myAssociationOnDatasource.get(this.props.myDataSource.items[0]);
506506
```
507507

508-
This will return an `ObjectItem` representing the associated object, because in this example the widget is configured to allow only singular associations. If you want to access the individual attribute values of this associated object, you may use an attribute property linked to the selectable objects data source and pass the associated object to it. For more information, see [Obtaining Attribute Value section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#obtaining-attribute-value).
508+
This will return an `ObjectItem` representing the associated object, because in this example the widget is configured to allow only singular associations. If you want to access the individual attribute values of this associated object, you may use an attribute property linked to the selectable objects data source and pass the associated object to it. For more information, see [Obtaining Attribute Value section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values-10/#obtaining-attribute-value).
509509

510-
Please note these code samples omit checks of `myDataSource` status and availability of items for simplicity. See [DynamicValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value) for more information on the usages of `DynamicValue`.
510+
Please note these code samples omit checks of `myDataSource` status and availability of items for simplicity. See [DynamicValue section](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-10/#dynamic-value) for more information on the usages of `DynamicValue`.
511511

512512
#### Association ID and Filterable Flags {#listassociationvalue-id-filterable}
513513

@@ -517,7 +517,7 @@ The `filterable` field specifies if the association can be used for filtering. T
517517

518518
#### Association Type {#association-type}
519519

520-
The [association](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#association) property determines which association types could be configured for that property. For example, an association property may be configured to allow associations of type `Reference` and not `ReferenceSet`.
520+
The [association](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#association) property determines which association types could be configured for that property. For example, an association property may be configured to allow associations of type `Reference` and not `ReferenceSet`.
521521

522522
It is possible to determine the type of association by checking the `type` field on an association property. This is useful if the property has been configured to allow both references and reference sets. The following code sample shows how to check the association type on the property named `myAssociationOnDatasource`:
523523

@@ -532,7 +532,7 @@ if (this.props.myAssociationOnDatasource.type === "Reference") {
532532

533533
### ListWidgetValue {#listwidgetvalue}
534534

535-
`ListWidgetValue` represents a [widget property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#widgets) that is linked to a data source. This allows the client component to render child widgets with items from a `ListValue`.
535+
`ListWidgetValue` represents a [widget property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#widgets) that is linked to a data source. This allows the client component to render child widgets with items from a `ListValue`.
536536
`ListWidgetValue` is an object and its definition is as follows:
537537

538538
```ts
@@ -560,7 +560,7 @@ When the `widgets` property is not required, there may not be any child widgets
560560

561561
### ListExpressionValue {#listexpressionvalue}
562562

563-
`ListExpressionValue` represents an [expression property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#expression) or [text template property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types/#texttemplate) that is linked to a data source. This allows the client component to access expression or text template values for individual items from a `ListValue`. `ListExpressionValue` is an object and its definition is as follows:
563+
`ListExpressionValue` represents an [expression property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#expression) or [text template property](/apidocs-mxsdk/apidocs/pluggable-widgets-property-types-10/#texttemplate) that is linked to a data source. This allows the client component to access expression or text template values for individual items from a `ListValue`. `ListExpressionValue` is an object and its definition is as follows:
564564

565565
```ts
566566
export interface ListExpressionValue<T extends AttributeValue> {

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/pluggable-widgets-config-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Errors that are related to the configuration module are shown in the Widget Deve
2121

2222
To customize the properties available in Studio Pro for the pluggable widget, the module should export a `getProperties` function. Two parameters are passed to this function:
2323

24-
* The current configured values, following the [Values API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis/#values)
24+
* The current configured values, following the [Values API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis-10/#values)
2525
* The default property configuration
2626

2727
```typescript
@@ -565,7 +565,7 @@ type DropZoneProps = BaseProps & {
565565

566566
The drop zone preview type can be used to add drop zones to the widget preview. It requires a widget property of type `widgets` to be able to store the information about the containing widgets. If the property has a data source, a header will be shown inside the dropzone containing information about the data source. This header is optional and can be hidden by setting `showDataSourceHeader` to `false`.
567567

568-
To configure a drop zone, the widgets property object (which can be obtained directly from the [Values API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis/#values)) needs to be passed as `property`, as the following example shows:
568+
To configure a drop zone, the widgets property object (which can be obtained directly from the [Values API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis-10/#values)) needs to be passed as `property`, as the following example shows:
569569

570570
```typescript
571571
exports.getPreview = (values: WidgetPreviewProps, _isDarkMode: boolean, _version: number[]) => ({
@@ -599,7 +599,7 @@ type SelectableProps = BaseProps & {
599599

600600
The selectable preview type can be used to make an instance of an object list selectable. If an object instance is made selectable, it will behave similar to a widget. Its properties will be shown in the `Properties` section and can also be edited in a pop-up by double-clicking the section that is visualized by the `child` properties. Note that this only works in combination with a property of type `object`.
601601

602-
To configure a selectable, the object from the [Value API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis/#values) needs to be passed as `object`, and the preview properties to visualize the object as `child`.
602+
To configure a selectable, the object from the [Value API](/apidocs-mxsdk/apidocs/pluggable-widgets-studio-apis-10/#values) needs to be passed as `object`, and the preview properties to visualize the object as `child`.
603603

604604
The following example shows how to render a container with a list of selectable objects. In this case, each object is shown as a text with its caption:
605605

0 commit comments

Comments
 (0)