Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/en/docs/apidocs-mxsdk/apidocs/marketplace/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "APIs for Marketplace"
url: /apidocs-mxsdk/apidocs/apis-for-marketplace/
type: swagger
no_list: false
description_list: true
description: "Provides the documentation of APIs for Marketplace."
linktitle: "Marketplace"
---

Mendix offers the following APIs for Marketplace:
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: "Content API"
linktitle: "Marketplace Content"
title: "Marketplace Content API"
url: /apidocs-mxsdk/apidocs/content-api/
type: swagger
description: "The Content API accesses both public and company-specific Marketplace content information."
restapi: true
weight: 45
weight: 10
---

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

### Generating a PAT

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

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

Expand All @@ -39,7 +38,7 @@ GET /content HTTP/1.1
Authorization: MxToken 7LJE…vk
```

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

## API Reference

Expand Down
44 changes: 44 additions & 0 deletions content/en/docs/apidocs-mxsdk/apidocs/marketplace/publish-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "Marketplace Publish API"
url: /apidocs-mxsdk/apidocs/publish-api/
type: swagger
description: "The Publish API accesses both public and company-specific Marketplace content information."
restapi: true
weight: 20
---

## Introduction

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.
The API handles both public and private components.

{{% alert color="warning" %}}
You can currently only publish new releases of existing components.
{{% /alert %}}

## Authentication {#authentication}

### Generating a PAT

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

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

* `mx:marketplace:write`

Store the generated value `{GENERATED_PAT}` somewhere safe so you can use it to authorize your Content API calls.

### Using the PAT

Each request must contain an `Authorization` header with the value `MxToken {GENERATED_PAT}`. Here is an example:

```http
GET /content HTTP/1.1
Authorization: MxToken 7LJE…vk
```

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

## API Reference

{{< swaggerui-disable-try-it-out src="/openapi-spec/marketplace-publish.yaml" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The **Submitted Requests** page gives you the governance capabilities to approve
* Company guidelines assurance: It enables you to meet regulatory requirements and internal policies by thoroughly reviewing components.
* Efficient management: It offers a centralized approval process to save time and resources, preventing additional communication outside of the platform.

{{% 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 %}}
{{% 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 %}}

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The component list contains the following information:
* **Version** — The version of the component that is being used.
* **Findings** — The number of findings of each type, color-coded according to severity level.
* **License** — For components derived from the Mendix Marketplace, this is the end-user license for the component.
* **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.
* **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.
* **Apps using component** – The number of apps where the component is used.
* **Latest version** — For components derived from the Mendix Marketplace, this is the latest version of the component.
* **Publisher** — For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ The component usage list contains the following information:
For more information, refer to [Content Support Categories](/appstore/marketplace-content-support/#category).
* **License** – For components derived from the Mendix Marketplace, this is the end-user license for the component.
* **Latest version** – For components derived from the Mendix Marketplace, this is the latest version of the component.
* **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.
* **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.
* **Latest Runtime Compatible Version** — The most recent runtime version to which the component is compatible.
* **Publisher** – For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
* 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.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/deployment/general/software-composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ The component list contains the following information:
* **Version** — The version of the component that is being used.
* **Findings** — The number of findings of each type, color-coded according to severity level.
* **License** — For components derived from the Mendix Marketplace, this is the end-user license for the component.
* **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.
* **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.
* **Latest version** — For components derived from the Mendix Marketplace, this is the latest version of the component.
* **Publisher** — For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
* **View details** — Clicking this opens the [Component App Details](#component-usage) page.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/marketplace/overview/component-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The header for a component includes the following details:
* **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.

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

* **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).
Expand Down
Loading
Loading