Skip to content

Commit 825f204

Browse files
Merge pull request #11366 from mendix/nc-mp-releases-api
MP release: new API, UI changes, role changes
2 parents 746b0f8 + 20a9b99 commit 825f204

13 files changed

Lines changed: 612 additions & 74 deletions

File tree

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: "APIs for Marketplace"
3+
url: /apidocs-mxsdk/apidocs/apis-for-marketplace/
4+
type: swagger
5+
no_list: false
6+
description_list: true
7+
description: "Provides the documentation of APIs for Marketplace."
8+
linktitle: "Marketplace"
9+
---
10+
11+
Mendix offers the following APIs for Marketplace:

content/en/docs/apidocs-mxsdk/apidocs/content-api.md renamed to content/en/docs/apidocs-mxsdk/apidocs/marketplace/content-api.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
---
2-
title: "Content API"
3-
linktitle: "Marketplace Content"
2+
title: "Marketplace Content API"
43
url: /apidocs-mxsdk/apidocs/content-api/
54
type: swagger
65
description: "The Content API accesses both public and company-specific Marketplace content information."
76
restapi: true
8-
weight: 45
7+
weight: 10
98
---
109

1110
## Introduction
@@ -22,7 +21,7 @@ If you have Marketplace content, this API can help you get the following informa
2221

2322
### Generating a PAT
2423

25-
For details on how to generate a PAT, see the [Personal Access Tokens](/portal/user-settings/#pat) section of *User Settings*.
24+
For details on how to generate a PAT, refer to the [Personal Access Tokens](/portal/user-settings/#pat) section of *User Settings*.
2625

2726
Select at least the following as the **Marketplace** scope:
2827

@@ -39,7 +38,7 @@ GET /content HTTP/1.1
3938
Authorization: MxToken 7LJE…vk
4039
```
4140

42-
To authenticate calls when using the OpenAPI specification below, click **Authorize** and use the value `MxToken {GENERATED_PAT}`.
41+
To authenticate calls when using the OpenAPI specification included in the next section, click **Authorize** and use the value `MxToken {GENERATED_PAT}`.
4342

4443
## API Reference
4544

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: "Marketplace Publish API"
3+
url: /apidocs-mxsdk/apidocs/publish-api/
4+
type: swagger
5+
description: "The Publish API accesses both public and company-specific Marketplace content information."
6+
restapi: true
7+
weight: 20
8+
---
9+
10+
## Introduction
11+
12+
The Marketplace Publish API allows you to manage the releases of your Marketplace components. It provides endpoints to create new releases with version metadata, upload source files, check release status as it moves through review and publication workflows, and unpublish releases when needed.
13+
The API handles both public and private components.
14+
15+
{{% alert color="warning" %}}
16+
You can currently only publish new releases of existing components.
17+
{{% /alert %}}
18+
19+
## Authentication {#authentication}
20+
21+
### Generating a PAT
22+
23+
For details on how to generate a PAT, refer to the [Personal Access Tokens](/portal/user-settings/#pat) section of *User Settings*.
24+
25+
Select at least the following as the **Marketplace** scope:
26+
27+
* `mx:marketplace:write`
28+
29+
Store the generated value `{GENERATED_PAT}` somewhere safe so you can use it to authorize your Content API calls.
30+
31+
### Using the PAT
32+
33+
Each request must contain an `Authorization` header with the value `MxToken {GENERATED_PAT}`. Here is an example:
34+
35+
```http
36+
GET /content HTTP/1.1
37+
Authorization: MxToken 7LJE…vk
38+
```
39+
40+
To authenticate calls when using the OpenAPI specification included in the next section, click **Authorize** and use the value `MxToken {GENERATED_PAT}`.
41+
42+
## API Reference
43+
44+
{{< swaggerui-disable-try-it-out src="/openapi-spec/marketplace-publish.yaml" >}}

content/en/docs/control-center/marketplace/submitted-requests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The **Submitted Requests** page gives you the governance capabilities to approve
1616
* Company guidelines assurance: It enables you to meet regulatory requirements and internal policies by thoroughly reviewing components.
1717
* Efficient management: It offers a centralized approval process to save time and resources, preventing additional communication outside of the platform.
1818

19-
{{% alert color="info" %}}As a Mendix Admin or component owner, you can always unpublish content from the Marketplace of your organization. This can help your organization keep its private Marketplace neat, with only relevant company content. To do so, go to [Company Content](/appstore/home-page/#company-content) in the Marketplace home page, click the {{% icon name="three-dots-menu-horizontal" %}} icon on the component card, then select **Unpublish all versions**. {{% /alert %}}
19+
{{% alert color="info" %}}As a Mendix Admin or component owner, you can always unpublish content from the Marketplace of your organization. This can help your organization keep its private Marketplace neat, with only relevant company content. To do so, go to [Published](/appstore/home-page/#published) in the **Manage Components** section of the Marketplace home page, click **Manage Versions** in the contextual menu of the component, then select **Unpublish**. {{% /alert %}}
2020

2121
The **Submitted Requests** page contains the following tabs:
2222

content/en/docs/control-center/security/software-composition/components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The component list contains the following information:
5050
* **Version** — The version of the component that is being used.
5151
* **Findings** — The number of findings of each type, color-coded according to severity level.
5252
* **License** — For components derived from the Mendix Marketplace, this is the end-user license for the component.
53-
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is available only via your [Company Content](/appstore/home-page/#company-content) page.
53+
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is only available for your organisation. On the Marketplace homepage, you can use the **Visibility** filter to display specific components.
5454
* **Apps using component** – The number of apps where the component is used.
5555
* **Latest version** — For components derived from the Mendix Marketplace, this is the latest version of the component.
5656
* **Publisher** — For components derived from the Mendix Marketplace, this is the name of the organization that published the component.

content/en/docs/control-center/security/software-composition/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ The component usage list contains the following information:
156156
For more information, refer to [Content Support Categories](/appstore/marketplace-content-support/#category).
157157
* **License** – For components derived from the Mendix Marketplace, this is the end-user license for the component.
158158
* **Latest version** – For components derived from the Mendix Marketplace, this is the latest version of the component.
159-
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is available only via your [Company Content](/appstore/home-page/#company-content) page.
159+
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is only available for your organisation. On the Marketplace homepage, you can use the **Visibility** filter to display specific components.
160160
* **Latest Runtime Compatible Version** — The most recent runtime version to which the component is compatible.
161161
* **Publisher** – For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
162162
* Column customization ({{% icon name="view" %}}) – You can customize the columns of the list by clicking the {{% icon name="view" %}} icon and selecting or deselecting options.

content/en/docs/deployment/general/software-composition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ The component list contains the following information:
189189
* **Version** — The version of the component that is being used.
190190
* **Findings** — The number of findings of each type, color-coded according to severity level.
191191
* **License** — For components derived from the Mendix Marketplace, this is the end-user license for the component.
192-
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is available only via your [Company Content](/appstore/home-page/#company-content) page.
192+
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is only available for your organisation. On the Marketplace homepage, you can use the **Visibility** filter to display specific components.
193193
* **Latest version** — For components derived from the Mendix Marketplace, this is the latest version of the component.
194194
* **Publisher** — For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
195195
* **View details** — Clicking this opens the [Component App Details](#component-usage) page.

content/en/docs/marketplace/overview/component-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The header for a component includes the following details:
2222
* **Recommended**: If the header contains this label, it means that the component meets your company's policies and guidelines, and therefore is recommended by your Mendix Admins.
2323

2424
* The name of the component
25-
* **Save** – Click this to add the component to your [Saved Content](/appstore/home-page/#personal) list.
25+
* **Save** – Click this to add the component to your **Saved** list.
2626
* Depending on the content type:
2727

2828
* **Use in Studio Pro** for modules and widgets – Click this to copy the content ID so that you can [search for and use the component in Studio Pro](/appstore/use-content/#current-sp).

0 commit comments

Comments
 (0)