Skip to content

Commit 8b5d19f

Browse files
NicoletaComanNicoletaComan
committed
MP release: new API, UI changes, role changes
1 parent a469722 commit 8b5d19f

6 files changed

Lines changed: 74 additions & 20 deletions

File tree

‎content/en/docs/apidocs-mxsdk/apidocs/marketplace/_index.md‎

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

‎content/en/docs/apidocs-mxsdk/apidocs/marketplace/publish-api.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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 Mendix Publish API allows you to publish components to Marketplace.
13+
14+
{{% alert color="warning" %}}
15+
You can currently only publish new releases of existing components.
16+
{{% /alert %}}
17+
18+
## Authentication {#authentication}
19+
20+
### Generating a PAT
21+
22+
For details on how to generate a PAT, refer to the [Personal Access Tokens](/portal/user-settings/#pat) section of *User Settings*.
23+
24+
Select at least the following as the **Marketplace** scope:
25+
26+
* `mx:marketplace:write`
27+
28+
Store the generated value `{GENERATED_PAT}` somewhere safe so you can use it to authorize your Content API calls.
29+
30+
### Using the PAT
31+
32+
Each request must contain an `Authorization` header with the value `MxToken {GENERATED_PAT}`. Here is an example:
33+
34+
```http
35+
GET /content HTTP/1.1
36+
Authorization: MxToken 7LJE…vk
37+
```
38+
39+
To authenticate calls when using the OpenAPI specification included in the next section, click **Authorize** and use the value `MxToken {GENERATED_PAT}`.
40+
41+
## API Reference
42+

‎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).

‎content/en/docs/marketplace/overview/marketplace-home-page.md‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The search box at the top of the page allows you to explore the Mendix Marketpla
2929
You can refine search results using the following filters:
3030

3131
* **Support** – Select between the available support categories. For details, see the [Marketplace Content Support](/appstore/marketplace-content-support/).
32-
* **Visibility** – Choose whether you want to display [public or private](/appstore/submit-content/#support-licensing) content.
32+
* **Visibility** – Choose whether you want to display public, private, or company components.
3333
* **Content Types** – Choose the type of content to display. For details, see the [Types of Marketplace Components](/appstore/#components-type) section in *Marketplace*.
3434
* **Category** – Select specific domains in which components or services share characteristics, functions, or purposes.
3535
* **Industry** – Select specific sectors or business domains in which components or services are used.
@@ -40,9 +40,13 @@ You can refine search results using the following filters:
4040
For details on finding and installing Marketplace content in Studio Pro, see the [Finding and Downloading Content in Studio Pro](/appstore/use-content/#downloading) section of *Using Marketplace Content*.
4141
{{% /alert %}}
4242

43-
## Personal {#personal}
43+
## Manage Components
4444

45-
The **Personal** category contains the items described in the following sections.
45+
The **Manage Components** category contains the items described in the following sections.
46+
47+
## Published
48+
49+
This page includes all your published components
4650

4751
### Drafts {#my-drafts}
4852

@@ -142,13 +146,14 @@ You can configure content groups for various levels of access to your company co
142146

143147
This table breaks down the roles and permissions for content groups:
144148

145-
| Roles | Manage Groups (Create & Delete) | Manage Group Members | Assign Content to Group | Manage Content (Add New Release, Manage Versions) | View & Download Group Content | View Group List |
146-
| ------------------------------------------- | ------------------------------- | -------------------- | ----------------------- | -------------------------------------------------- | ----------------------------- | --------------- |
147-
| Mendix Admin | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
148-
| Group Admin | ✘ | ✔ | ✔ | ✔ | ✔ | ✔ |
149-
| Group Member | ✘ | ✘ | ✘ | ✔ | ✔ | ✔ |
150-
| Organization member (not part of any group) | ✘ | ✘ | ✘ | ✘ | ✔ | ✔ |
151-
| Guest | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ |
149+
| Roles | Manage groups (create & delete) | Manage group members | Assign content to group | Manage content (Add new release, manage releases) | View & download group content | View group list | Manage drafts |
150+
| ------------------------------------------- | ------------------------------- | -------------------- | ----------------------- | -------------------------------------------------- | ----------------------------- | --------------- | ------------------ |
151+
| Mendix Admin | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ |
152+
| Group Admin | ✘ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
153+
| Group Member | ✘ | ✘ | ✘ | ✔ | ✔ | ✔ | ✔ |
154+
| Organization member (not part of any group) | ✘ | ✘ | ✘ | ✘ | ✔ | ✔ | ✘ |
155+
| Guest | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ |
156+
| Developer (not part of any group) | ✘ | ✘ | ✘ | ✔ | ✔ | ✔ | ✔ |
152157

153158
#### Content Tab {#group-content}
154159

‎content/en/docs/marketplace/upload-content/_index.md‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,8 +218,7 @@ To update content that has already been published, follow these steps:
218218

219219
1. Find the component in one of the following sections:
220220

221-
* **My Content**
222-
* **Company Content**
221+
* **Published**
223222
* **Content Group**
224223
{{% alert color="info" %}}If an existing Marketplace component is assigned to a [content group](/appstore/home-page/#content-groups) as specific content group [content](/appstore/home-page/#group-content), you can only update the component if you are a member of that group.{{% /alert %}}
225224

@@ -229,8 +228,6 @@ To update content that has already been published, follow these steps:
229228
* **Manage Versions** – This option gives you access to the **Edit** and **Unpublish** actions for each version of the component.
230229
* **Unpublish Component**
231230

232-
{{% alert color="info" %}}Only one draft version of a component can exist at a time, so when one draft version is in progress, another draft cannot be started. If there is a draft version in progress, click **Edit Draft** on the page where you manage the component in order to see the draft.{{% /alert %}}
233-
234231
3. You can edit all component details, as described in the [Adding New Marketplace Content](#adding) section above.
235232
4. In the **Version** section of the **Package** page, update the **Major**, **Minor**, and **Patch** numbers so that the component is saved as a new version:
236233

0 commit comments

Comments
 (0)