Batch endpoint

It allows to retrieve a set of components with a single request to the API. While this should be convenient during the server-side rendering, it is not a good practice for client-side rendering.

Server-side rendering via rest API using the post route

curl http://my-components-registry.mydomain.com/
  -X POST
  -H "Content-Type: application/json"
  -d '{components:[{"name": hello-world", "version": "1.X.X"}, {"name": "my-component", "parameters": { "something": 2345 }}]}'

[{
  "status": 200,
  "response": {
    "href": "https://my-components-registry.mydomain.com/hello-world/1.X.X",
    "name": "hello-world",
    "version": "1.0.0",
    "requestVersion": "1.X.X",
    "html": "Hello John doe!",
    "type": "oc-component",
    "renderMode": "rendered"
  }
},{
  "status": 200,
  "response": {
    "href": "https://my-components-registry.mydomain.com/my-component/?something=2345",
    "name": "my-component",
    "version": "1.0.0",
    "requestVersion": "",
    "html": "Bla bla",
    "type": "oc-component",
    "renderMode": "rendered"
  }
}]

Payload API

Parameter	Type	Mandatory	Description
components	array of objects	yes	Components to retrieve
components[index].name	string	yes	Component name
components[index].version	string	no	Default latest, the component's version
components[index].parameters	object	no	Component's parameters
omitHref	boolean	no	Default false, when true omits the href value in the response of each component
parameters	object	no	Global parameters for all components to retrieve. When component has its own parameters, globals will be overwritten