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"
      }
    ]
  }
}

Changes

Changed in 5 of the 11 revisions of this API.3125

Nov 3, 202152b0a03f18686See the full diff
- ○
  added the new optional request property active
  new-optional-request-property
- ○
  added the new optional request property id
  new-optional-request-property
- ○
  added the new optional request property isGlobal
  new-optional-request-property
- ○
  added the optional property data/active to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property data/id to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property data/isGlobal to the response with the 201 status
  response-optional-property-added
Mar 17, 2021d6ffebabd3db216See the full diff
- ▲
  added the new required request property distribution
  new-required-request-property
- ▲
  added the new required request property name
  new-required-request-property
- ●
  removed the request property data
  request-property-removed
- ○
  added the new optional request property access
  new-optional-request-property
- ○
  added the new optional request property applicationUid
  new-optional-request-property
- ○
  added the new optional request property description
  new-optional-request-property
- ○
  added the new optional request property descriptor
  new-optional-request-property
- ○
  added the new optional request property logo
  new-optional-request-property
- ○
  added the new optional request property owners
  new-optional-request-property
Aug 20, 2019a1efb09ed2202See the full diff
- ○
  added the new optional request property data/logo
  new-optional-request-property
- ○
  added the optional property data/logo to the response with the 201 status
  response-optional-property-added
Aug 20, 2019566ed0364ce02See the full diff
- ○
  added the new optional request property data/applicationUid
  new-optional-request-property
- ○
  added the optional property data/applicationUid to the response with the 201 status
  response-optional-property-added
May 16, 201977e6b7addc6e19See the full diff
- ▲
  removed the success response with the status 200
  response-success-status-removed
- ○
  the endpoint scheme security api_key was removed from the API
  api-security-removed
- ○
  the request property data/access became optional
  request-property-became-optional
- ○
  the request property data/description became optional
  request-property-became-optional
- ○
  the request property data/descriptor became optional
  request-property-became-optional
- ○
  the request property data/owners became optional
  request-property-became-optional
- ○
  the access request property default value private was added
  request-property-default-value-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  removed the non-success response with the status 405
  response-non-success-status-removed
- ○
  added the success response with the status 201
  response-success-status-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history