v11

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2022-08-179916.1 KB

components

Create a component

post/components/

Request body

namestring required

descriptionstring

idstring

Unique component ID

access'private' | 'public'

applicationUidstring

Unique application ID

logostring

Component Logo URL

descriptorobject

Component descriptor (component.json) which contains a component meta information.

isGlobalboolean

activeboolean

Example request

{
  "name": "My Component",
  "description": "My Component",
  "access": "public",
  "applicationUid": "3f57d4cc-9a6b-40c9-8db6-0657c116e97c",
  "logo": "https://my-component.com/logo.png",
  "distribution": {
    "type": "docker",
    "image": "openintegrationhub/email",
    "registrySecretId": "5b62c919fd98ea00112d52e7"
  },
  "owners": [
    {
      "id": "123",
      "type": "user"
    }
  ]
}

Response

successful operation

Example response

{
  "data": {
    "name": "My Component",
    "description": "My Component",
    "access": "public",
    "applicationUid": "3f57d4cc-9a6b-40c9-8db6-0657c116e97c",
    "logo": "https://my-component.com/logo.png",
    "distribution": {
      "type": "docker",
      "image": "openintegrationhub/email",
      "registrySecretId": "5b62c919fd98ea00112d52e7"
    },
    "owners": [
      {
        "id": "123",
        "type": "user"
      }
    ]
  }
}