OPopenintegrationhub
components

Update a component

Changed on

Update a component

patch/components/{id}

Request

Path parameters

idstring required

ID of component to update

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

  • 52b0a03f1868Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • d6ffebabd3dbRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property