components

Retrieve all components

Retrieve all components from the repository.

get/components/

Query parameters

page[size]integer

The amount of components per page returned. Defaults to 50.

page[number]integer

The number of the page to be returned. Defaults to 1.

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 4 of the 11 revisions of this API.48

Nov 3, 202152b0a03f18683See the full diff
- ○
  added the optional property data/items/active to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/isGlobal to the response with the 200 status
  response-optional-property-added
Aug 20, 2019a1efb09ed2201See the full diff
- ○
  added the optional property data/items/logo to the response with the 200 status
  response-optional-property-added
Aug 20, 2019566ed0364ce01See the full diff
- ○
  added the optional property data/items/applicationUid to the response with the 200 status
  response-optional-property-added
May 16, 201977e6b7addc6e43See the full diff
- ▲
  the response property data/items/access became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/items/description became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/items/descriptor became optional for the status 200
  response-property-became-optional
- ▲
  the response property data/items/owners became optional for the status 200
  response-property-became-optional
- ○
  the endpoint scheme security api_key was removed from the API
  api-security-removed
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  the access response's property default value private was added for the status 200
  response-property-default-value-added
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history