Marketplace Plugin API

note

Read this page in wide view mode from here

• MarketplaceProxy
  • postPublish a resource into the Marketplace
  • postRemove a resource from the Marketplace
  • patchSync the Access Control List

API docs by Redocly

Marketplace Plugin API (0.1.0)

A Marketplace Plugin is the component responsible to publish resources into the Witboost Marketplace or third-party marketplaces.

It is also responsible to mantain alignment between the Access Control List on the infrastructural component and on the UI.

MarketplaceProxy

A proxy towards a market place service

Find out more

Publish a resource into the Marketplace

Insert the latest provisioning result and descriptor into the target marketplace registry.

Request Body schema: application/json

required

An asset descriptor and the provisioning results wrapped as simple object

descriptor required

string Asset descriptor in yaml format

Responses

https://docs.witboost.com/datamesh.marketplaceproxy/v1/insert-provisioning-results

Request samples

• Payload

Content type

application/json

{

• "descriptor": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "status": "string",
• "info": {

  • "privateInfo": {

    • "marketplaceInfo": {

      • "type": "string",
      • "label": "string",
      • "value": "string",
      • "href": "string"

      }

    }

  }

}

Remove a resource from the Marketplace

Perform a delete operation of asset descriptor references that are in the Marketplace DB

Request Body schema: application/json

required

An asset descriptor and the provisioning results wrapped as simple object

descriptor required

string Asset descriptor in yaml format

Responses

https://docs.witboost.com/datamesh.marketplaceproxy/v1/delete

Request samples

• Payload

Content type

application/json

{

• "descriptor": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

"string"

Sync the Access Control List

Update the Access Control List table copy that is kept in the Marketplace.

Request Body schema: application/json

required

The request used to update the ACL table.

requestId required	string
outputPortId required	integer
refs required	Array of strings

Responses

https://docs.witboost.com/datamesh.marketplaceproxy/v1/update-acl

Request samples

• Payload

Content type

application/json

{

• "requestId": "string",
• "outputPortId": 0,
• "refs": [

  • "string"

  ]

}

Response samples

• 204
• 400
• 500

Content type

application/json

"string"