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/apps/app-repository-api.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
@@ -8,7 +8,7 @@ weight: 10
8
8
9
9
## Introduction
10
10
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/).
12
12
13
13
## Base URL
14
14
@@ -107,7 +107,7 @@ Returns information about the version control repository for a Mendix app.
107
107
108
108
|Name|Type|Required|Description|
109
109
|---|---|---|---|
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/). |
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -295,7 +295,10 @@ An object with the following key-value pairs:
295
295
*`Description` (String) : Description of the package.
296
296
297
297
{{% alert color="warning" %}}
298
-
For apps using SVN for version control, this call will build the specified revision even if that revision is not on the specified branch.
298
+
299
+
* For apps using SVN for version control, this call will build the specified revision even if that revision is not on the specified branch.
300
+
301
+
* For apps using Git for version control, using a short commit hash can cause timeouts with large repositories. Mendix recommends using the full commit hash
description: "This API allows you to manage pipelines in Private Mendix Platform."
6
+
restapi: true
7
+
weight: 60
8
+
linktitle: "Pipeline API"
9
+
---
10
+
11
+
{{% alert color="info" %}}
12
+
This document is about [Private Mendix Platform](/private-mendix-platform/) API. This API is only available on instances of Private Mendix Platform. For [Mendix on Kubernetes](/developerportal/deploy/private-cloud/) API, see [Mendix on Kubernetes Build API](/apidocs-mxsdk/apidocs/private-cloud-build-api/) and [Mendix on Kubernetes Deploy API](/apidocs-mxsdk/apidocs/private-cloud-deploy-api/).
13
+
{{% /alert %}}
14
+
15
+
## Introduction
16
+
17
+
The Private Mendix Platform Project API allows you to manage pipelines in Private Mendix Platform. You can use the API to do the following:
18
+
19
+
* Get pipeline running information.
20
+
* Set the current step status of the pipeline.
21
+
* Create a pipeline for build or deployment.
22
+
* Approve or reject a manual step of a waiting pipeline.
Copy file name to clipboardExpand all lines: content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/_index.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
@@ -20,6 +20,6 @@ For information on new releases of the Extensibility API see:
20
20
21
21
## Introduction
22
22
23
-
Extensions are self-contained modules which users can add to Studio Pro. This means that with extensibility you can add new features and functionality to Studio Pro. The Extensibility API is an API that allows developers to interact with a curated list of internal systems of Studio Pro. This documentation provides guides and reference documentation for the Extensibility API.
23
+
Extensions are self-contained modules that enhance Studio Pro by adding new features and functionality. The Extensibility API allows you to interact with a curated set of internal systems, extending Studio Pro’s capabilities with functionality you can define yourself.
24
24
25
-
The API is provided in two flavors, depending which language you are developing in. C# and web based (via Typescript):
25
+
The API is provided in two versions, depending on the language you are developing in:
Once you have finished development on your extension, you might want to package it into an add-on module so that others can start using it. Once you have created the add-on module, it can then be published to the Mendix Marketplace for your extension users to download into their Studio Pro app.
9
+
After completing development on your extension, you can package it into an add-on module so others can use it. Once packaged, the modulecan be published to the Mendix Marketplace, allowing other users to download it into their Studio Pro apps.
10
10
11
-
To package your extension, you will still need the `--enable-extension-development` command line option turned on. Create a new module in your Studio Pro app containing your dev extension, give it an appropriate name. Open the module's settings form and set it to be an Add-on module. In the `Extension name` dropdown, select the extension you want to package into it.
11
+
To package your extension, follow the steps below:
12
+
13
+
1. Make sure the `--enable-extension-development` command-line option is enabled.
14
+
2. In your Studio Pro app, create a new module and include your development extension.
15
+
3. Give the module a name.
16
+
4. Open the module's settings and in the **Export** tab, choose **Add-on module**.
17
+
5. In the **Extension name** drop-down, select the extension you want to package into it.
After you've created your add-on module with its extension, you can now export it, by right-clicking the module in the App Explorer and choosing `Export add-on module package`, as shown below.
21
+
After you have created your add-on module with its extension, you can export it by right-clicking the module in the App Explorer and selecting **Export add-on module package**.
You can now save the add-on module to a location of your choice.
20
26
21
-
# Importing the extension add-on module
27
+
# Importing the Extension Add-on Module
22
28
23
-
Once the add-on module is available to a Studio Pro user, they are now able to add it in their application. They can so so by right-clicking the app in the App Explorer and choosing `Import module package`, as shown below.
29
+
When the add-on module is available to a Studio Pro user, they are now able to add it in their application. This is done by right-clicking the app in the **App Explorer** and selecting **Import module package**.
Once an add-on module containing an extension is imported in the app, Studio Pro will show a warning to the user, asking to trust the extension contained in it. If the user does not choose to trust, the module will still be imported but the extension inside it won't be loaded.
33
+
When an add-on module containing an extension is imported in the app, Studio Pro will show a warning to the user, asking to trust the extension contained in it. If the user does not choose to trust, the module will still be imported but the extension inside it will not be loaded.
0 commit comments