Mia-Platform

https://docs.mia-platform.eu/
Admin
Mia-Platform is an AI-native Developer Platform Foundation that consolidates platform engineering,...
Tokens:1,333,741
Snippets:13,165
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example Configuration and State

Source: https://docs.mia-platform.eu/docs/products/microfrontend-composer/back-kit/components/state_adapter

Example setup for the State Adapter configuration and the corresponding window state object.

```json
{
  "tag": "bk-state-adapter",
  "properties": {
    "initKey": "key_0",
    "configMap": {
      "key_1": "loading-data",
      "key_2": "add-new"
    }
  }
}
```

```json
{
  "key_0": [
    {
      "label": "change-query",
      "payload": {"pageSize": 10}
    }
  ],
  "key_1": {
    "loading": true
  },
  "key_2": {
    "foo": "bar"
  }
}
```

--------------------------------

### Example: Creating GET /hello-world Endpoint

Source: https://docs.mia-platform.eu/docs/runtime-components/templates/node.js-mia-care-samd-template/walkthrough

An example of using the 'npm run new-endpoint' command to create a GET endpoint at '/hello-world' with the method name 'getHelloWorld'.

```bash
npm run new-endpoint GET /hello-world getHelloWorld  
```

--------------------------------

### Example Configuration

Source: https://docs.mia-platform.eu/docs/products/fast_data/runtime_management/workloads?workload=ps

An example of a Control Plane Client JSON configuration.

```APIDOC
## Example Configuration

### Description
This is an example of a JSON configuration object used to connect a Fast Data service to a Control Plane.

### Request Example
```json
{
  "settings": {
    "host": "http://control-plane-operator"
  }
}
```
```

--------------------------------

### Tables Configuration Example

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/crud-sql/configuration

A practical example of a table configuration for an 'authors' collection.

```json
{
  "version": 1,
  "id": "authors",
  "name": "authors",
  "endpointBasePath": "/authors",
  "schema": {
    "type": "object",
    "required": [
      "name",
      "surname"
    ],
    "properties": {
      "id": {
        "type": "number"
      },
      "__STATE__": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "surname": {
        "type": "string"
      },
      "creatorId": {
        "type": "string",
        "description": "User id that has created this object"
      },
      "createdAt": {
        "type": "string",
        "format": "date-time",
        "description": "Date of the request that has performed the object creation"
      },
      "updaterId": {
        "type": "string",
        "description": "User id that has requested the last change successfully"
      },
      "updatedAt": {
        "type": "string",
        "format": "date-time",
        "description": "Date of the request that has performed the last change"
      }
    }
  },
  "metadata": {
    "primaryKey": "id",
    "creatorId": "creatorId",
    "updaterId": "updaterId",
    "createdAt": "createdAt",
    "updatedAt": "updatedAt",
    "timezone": "Europe/Rome",
    "manageIdColumn": "true"
  }
}
```

--------------------------------

### Full Configuration Example

Source: https://docs.mia-platform.eu/docs/products/microfrontend-composer/back-kit/components/bulk_actions_button

A complete configuration example including data schema and enabled confirmation.

```json
{
  "tag": "bk-bulk-actions",
  "properties": {
    "dataSchema": {
      "name": {"type": "string"},
      "isMarried": {"type": "boolean"},
      "dayOff": {
        "type": "string",
        "enum": ["Mon", "Tue", "Wed", "Thu", "Fri"]
      }
    },
    "requireConfirm": true
  }
}
```

--------------------------------

### GET /{id} Response Example

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/form-service-backend/submit_urls

Example of the JSON response body returned by the GET /{id} route.

```json
{
  "data": {
    "property1": "value1",
    "property2": "value2",
    "...": "..."
  },
  "isValid": true,
  "hasDraft": false
}
```

--------------------------------

### Example FHIR Adapter GET Request

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/fhir-adapter/configuration

An example GET request to a FHIR Adapter endpoint using a mapped search parameter.

```bash
curl -X GET https://your-url/ClinicalImpression/?recordedAt=2024-01-01T09:00:00Z \
-H  "accept: application/json"  \
-H  "content-type: application/json" \
-H  "client-key: client-key"  
```

--------------------------------

### Example configuration file

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/messaging-service/configuration

A sample JSON configuration file demonstrating user field mapping.

```json
{
  "userFields": {  
    "id": "fiscalCode",  
    "emailAddress": "mail",  
    "clusters": "groups"  
  },

```

--------------------------------

### Examples for applying Marketplace configurations

Source: https://docs.mia-platform.eu/docs/products/console/cli/miactl/commands

Common usage patterns for applying Marketplace configurations from files and directories.

```bash
  
# Apply the configuration of the file myFantasticGoTemplate.json located in the current directory to the Marketplace  
miactl marketplace apply -f myFantasticGoTemplate.json  
  
# Apply the configurations in myFantasticGoTemplate.json and myFantasticNodeTemplate.yml to the Marketplace, with relative paths  
miactl marketplace apply -f ./path/to/myFantasticGoTemplate.json -f ./path/to/myFantasticNodeTemplate.yml  
  
# Apply all the valid configuration files in the directory myFantasticGoTemplates to the Marketplace  
miactl marketplace apply -f myFantasticGoTemplates  
```

--------------------------------

### GET /providers Response Payload

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/pharma-ecommerce-backend/usage

Example of the JSON response structure returned by the GET /providers endpoint.

```json
{
  "providers": [
    "pharmaPrime"
  ]
}
```

--------------------------------

### Route Specific GET Request

Source: https://docs.mia-platform.eu/docs/products/console/api-console/advanced-section/api-gateway/how-to

Example mapping a specific GET request pattern to a target service.

```nginx
"~^(secreted|unsecreted)-(0|1)-GET-/login-site" "demo-login-site";  

```

--------------------------------

### Examples for applying Catalog configurations

Source: https://docs.mia-platform.eu/docs/products/console/cli/miactl/commands

Various ways to apply configuration files to the Catalog.

```bash
# Apply the configuration of the file myFantasticGoTemplate.json located in the current directory to the Catalog  
miactl catalog apply -f myFantasticGoTemplate.json  
  
# Apply the configurations in myFantasticGoTemplate.json and myFantasticNodeTemplate.yml to the Catalog, with relative paths  
miactl catalog apply -f ./path/to/myFantasticGoTemplate.json -f ./path/to/myFantasticNodeTemplate.yml  
  
# Apply all the valid configuration files in the directory myFantasticGoTemplates to the Catalog  
miactl catalog apply -f myFantasticGoTemplates  
```

--------------------------------

### Example Configuration Objects

Source: https://docs.mia-platform.eu/docs_files_to_download/data-catalog-agent/configuration.schema.json

These examples demonstrate how to define connections for PostgreSQL via ODBC and a CRUD service via HTTP, alongside the required target configuration.

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "configuration",
  "examples": [
    {
      "connections": {
        "postgres-16": {
          "configuration": {
            "params": {
              "database": "my-database",
              "host": "0.0.0.0",
              "port": 5432,
              "pwd": "*******",
              "uid": "my-user"
            },
            "vendor": "postgres"
          },
          "type": "odbc"
        }
      },
      "target": {
        "baseUrl": "https://console.cloud.mia-platform.eu",
        "credentials": {
          "clientId": "<CLIENT_ID>",
          "clientKeyId": "<CLIENT_KEY_ID>",
          "privateKey": "tls/private-key.pem"
        },
        "oauthTokenEndpoint": "/api/m2m/oauth/token",
        "projectId": "1234",
        "revision": "main",
        "type": "mia-console"
      }
    },
    {
      "connections": {
        "crud-service": {
          "configuration": {
            "params": {
              "baseUrl": "http://mia-crud-service:3000",
              "endpoint": "/-/schemas",
              "headers": {
                "accept": "application/x-ndjson"
              }
            },
            "vendor": "mia-crud-service"
          },
          "type": "http"
        }
      },
      "target": {
        "baseUrl": "https://console.cloud.mia-platform.eu",
        "credentials": {
          "clientId": "<CLIENT_ID>",
          "clientKeyId": "<CLIENT_KEY_ID>",
          "privateKey": "tls/private-key.pem"
        },
        "oauthTokenEndpoint": "/api/m2m/oauth/token",
        "projectId": "1234",
        "revision": "main",
        "type": "mia-console"
      }
    }
  ],
  "type": "object",
  "properties": {
    "connections": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/connection"
      }
    },
    "target": {
      "default": {
        "type": "stdout"
      },
      "allOf": [
        {
          "$ref": "#/definitions/target"
        }
      ]
    }
  },
  "definitions": {
    "OracleMode": {
      "oneOf": [
        {
          "type": "string",
          "enum": [
            "user"
          ]
        },
        {
          "type": "object",
          "required": [
            "all"
          ],
          "properties": {
            "all": {
              "type": "object",
              "properties": {
                "owners": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "additionalProperties": false
        },
        {
          "type": "object",
          "required": [
            "dba"
          ],
          "properties": {
            "dba": {
              "type": "object",
              "properties": {
                "owners": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "additionalProperties": false
        }
      ]
    },
    "Settings": {
      "type": "object",
      "properties": {
        "batchSize": {
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        },
        "columnBatchSize": {
          "type": [
            "integer",
            "null"
          ],
          "format": "uint32",
          "minimum": 0.0
        },
        "connectionName": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "connection": {
      "oneOf": [
        {
          "type": "object",
          "required": [
            "configuration",
            "type"
          ],
          "properties": {
            "configuration": {
              "$ref": "#/definitions/odbc-configuration"
            },
            "type": {
              "type": "string",
              "enum": [
                "odbc"
              ]
            }
          }
        },
        {
          "type": "object",
          "required": [
            "configuration",
            "type"
          ],
          "properties": {
            "configuration": {
              "$ref": "#/definitions/http-configuration"
            },
            "type": {
              "type": "string",
              "enum": [
                "http"
              ]
            }
          }
        }
      ]
    },
    "credentials": {
      "type": "object",
      "required": [
        "clientId",
        "clientKeyId",
        "privateKey"
      ],
      "properties": {
        "clientId": {
          "type": "string"
        },
        "clientKeyId": {
          "$ref": "#/definitions/secret"
        },
        "privateKey": {

```

--------------------------------

### Control Plane Configuration Example

Source: https://docs.mia-platform.eu/docs/products/fast_data/runtime_management/control_plane

A complete configuration example demonstrating cache, persistence, and settings definitions.

```json
{
  "cache": {
    "type": "redis",
    "configuration": {
      "url": {
        "type": "file",
        "path": "/run/secrets/data-fabric/control-plane.ini",
        "key": "REDIS_URL"
      }
    }
  },
  "persistence": {
    "type": "mongodb",
    "configuration": {
      "type": "file",
      "path": "/run/secrets/data-fabric/control-plane.ini",
      "key": "MONGODB_URL"
    }
  },
  "settings": {
    "apiPrefix": "/api"
  }
}
```

--------------------------------

### Install Flow Manager Client

Source: https://docs.mia-platform.eu/docs/runtime-components/libraries/flow-manager-client/setup

Installs the @mia-platform/flow-manager-client package using npm. This is the initial setup step for the project.

```bash
npm i --save @mia-platform/flow-manager-client  

```

--------------------------------

### Cache Configuration Example

Source: https://docs.mia-platform.eu/docs/products/fast_data/runtime_management/control_plane

Example showing how to define the cache configuration using a direct connection string.

```json
{
  "cache": {
    "type": "redis",
    "configuration": {
      "url": "redis://<redis-instance-address>:6379"
    }
  },
  // ...other control plane configurations
}
```

--------------------------------

### GET /orders API Response

Source: https://docs.mia-platform.eu/docs/products/fast_data/tutorials/low-code

This is an example response from the GET /orders API endpoint, showing a successfully ingested order record.

```json
[
  {
    "_id": "63cebcb6d65321231236c857e76b6ab",
    "__STATE__": "PUBLIC",
    "createdAt": "2023-01-23T16:58:30.201Z",
    "date": "2024-02-16T11:13:48.322Z",
    "name": "order-1",
    "order_id": "ord-1",
    "price": 123,
    "registry_id": "reg-1",
    "updatedAt": "2023-01-23T16:58:30.201Z"
  }
]
```

--------------------------------

### Kustomization File Example

Source: https://docs.mia-platform.eu/docs/products/console/set-up-infrastructure/migration-and-creation-project

This example shows the updated `kustomization.yml` file for an environment when using Kustomize. Ensure the resource paths are correctly set to point to the environments directory.

```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- ../../environments/dev

```

--------------------------------

### GET /registry API Response

Source: https://docs.mia-platform.eu/docs/products/fast_data/tutorials/low-code

This is an example response from the GET /registry API endpoint, showing a successfully ingested registry record.

```json
[
  {
    "_id": "63ceb97233241d6536c857e759c02",
    "__STATE__": "PUBLIC",
    "address": "customer address",
    "city": "customer city",
    "createdAt": "2023-01-23T16:44:33.006Z",
    "email": "customer1@mail.com",
    "name": "customer 1",
    "phone": "customer phone",
    "registry_id": "reg-1",
    "state": "customer state",
    "updatedAt": "2023-01-23T16:44:33.006Z"
  }
]
```

--------------------------------

### Example Response for GET /-/proxies

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/http-proxy-manager/how_to_use

This is an example response when listing proxies. It shows the structure of proxy configurations, excluding sensitive fields like client secrets.

```json
[
  {
    "authentication": "oauth2",
    "tokenIssuerUrl": "http://external-service.com/auth/oauth/token",
    "targetBaseUrl": "https://external-service.com",
    "basePath": "/external-service",
    "grantType": "client_credentials",
    "clientId": "6779ef20e75817b79602"
    // client secret is not returned
  },
  {
    "authentication": "none",
    "targetBaseUrl": "https://other-service.com",
    "basePath": "/other-service"
  }
]
```

--------------------------------

### Privileges Configuration Example

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/teleconsultation-service-backend/configuration

Example configuration for basic and plus user roles, defining associated groups and enabled tools.

```json
"privileges": {  
  "basic": {  
    "groups": ["customer"],  
    "tools": {  
      "chat": true,  
      "screen_sharing": true,  
      "file_upload": true,  
      "whiteboard": true,  
      "snapshot": true,  
      "live_edit": true,  
      "live_pointer": true,  
      "present_to_everyone": true  
    }  
  },  
  "plus": {  
    "groups": ["doctor"],  
    "tools": {  
      "chat": true,  
      "screen_sharing": true,  
      "file_upload": true,  
      "whiteboard": true,  
      "snapshot": true,  
      "live_edit": true,  
      "live_pointer": true,  
      "present_to_everyone": true  
    }  
  }  
}
```

--------------------------------

### Start Server with DataSource

Source: https://docs.mia-platform.eu/docs/runtime-components/templates/crud-sql-template/configuration

Start the Server by providing a configured DataSource obtained from the DB_URL environment variable. This is the main entry point for the application.

```kotlin
fun main(): Unit = runBlocking {
    Server().start(getDataSource(System.getenv("DB_URL")))
}

```

--------------------------------

### Execute GET Request

Source: https://docs.mia-platform.eu/docs/products/console/tutorials/protect-your-endpoints-with-policies

Example curl command to fetch data from the authorized endpoint.

```bash
curl --request GET --url 'https://<your-host>.mia-platform.eu/v2/books/' --header 'accept: */*'  
  
[  
  {"_id":"620bc957634b240014b06de2", ...},  
  {"_id":"620bc957634b240014b06de4", ...},  
  ...  
]  

```

--------------------------------

### Project Creation Prompts

Source: https://docs.mia-platform.eu/docs/products/console/mcp/mcp-server/prompt_gallery

Prompts for initializing new projects with specific blueprints and deployment configurations.

```text
Create a Mia-Platform Project named {projectName} using the default project blueprint in the tenant {tenantName}
```

```text
Create a Mia-Platform Project named {projectName} using the microservices-oriented blueprint in the tenant {tenantName} and enable continuous deployment
```

```text
Create a Mia-Platform Project named {projectName} for a data analytics platform. Use the {blueprintName} blueprint in the tenant {tenantName}. Configure three environments: DEV, STAGING, and PRODUCTION
```

--------------------------------

### Example Notification Messages Response

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/notification-manager-service/usage

A sample JSON array returned by the GET /notification-messages/ endpoint.

```json
[
  {
    "_id": "663ccd65dee93b2a6a6885d1-fea80f2db003d4ebc4536023814aa885",
    "event": "Update appointment",
    "recipient": "663ccce5dee93b2a6a6885ty",
    "channel": "email",
    "templateName": "new-appointment",
    "status": "SUCCESS"
  },
  {
    "_id": "663ccd65dee93b2a6a6885d1-0956d2fbd5d5c29844a4d21ed2f76e0c",
    "event": "Update appointment",
    "recipient": "663ccce5dee93b2a6a6885ty",
    "channel": "sms",
    "templateName": "new-appointment",
    "status": "FAILED"
  },
  {
    "_id": "812rcd65dee93b2a6a9845z98-3a685826dee20d9afd3bc637b0615adb",
    "event": "New appointment",
    "recipient": "675cdse5dee93b2a6a64565rf",
    "channel": "email",
    "templateName": "new-appointment",
    "status": "SUCCESS"
  }
]
```

--------------------------------

### Get Teleconsultation Data

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/teleconsultation-service-backend/overview

Returns all data required to instantiate a teleconsultation UI and start the call.

```APIDOC
## GET /teleconsultation/:teleconsultationId

### Description
Return all data required to instantiate a teleconsultation UI and start the call.

### Method
GET

### Endpoint
/teleconsultation/:teleconsultationId

### Parameters
#### Path Parameters
- **teleconsultationId** (string) - Required - The ID of the teleconsultation.

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
All data required to instantiate the teleconsultation UI and start the call.

#### Response Example
{
  "example": "response body"
}
```

--------------------------------

### Start Custom View Creator with Strategies

Source: https://docs.mia-platform.eu/docs/products/fast_data/configuration/single_view_creator/template

Use the `startCustom` method to initiate a custom view creator, passing in your specific upsert and delete functions along with other configurations.

```javascript
const resolvedOnStop = singleViewCreator.startCustom({
  strategy: aggregatorBuilder(projectionsDB),
  mapper,
  validator,
  singleViewKeyGetter: singleViewKey,
  upsertSingleView: upsertFnSV,
  deleteSingleView: deleteSV,
})
```

--------------------------------

### Install Authentication Client

Source: https://docs.mia-platform.eu/docs/products/console/project-configuration/auth-flow/frontend-application

Commands to install the authentication client library using npm or yarn.

```bash
npm install @mia-platform-internal/authtool-client-js  
# or  
yarn add @mia-platform-internal/authtool-client-js
```

--------------------------------

### Calendar Filter Configuration Example

Source: https://docs.mia-platform.eu/docs/products/microfrontend-composer/back-kit/components/calendar

This example shows how to configure custom names for the start and end date filters used by the Calendar component. The 'name' property should correspond to the value of the 'filtersName' property.

```json
{
  "name": ..., // value of property `filtersName.start`, or "bk-calendar-start-date-filter" 
  "operator": "lessEqual",
  "property": "startDate",
  "value": "2021-09-20T00:00:00.000Z"
},
{
  "name": ..., // value of property `filtersName.end`, or "bk-calendar-end-date-filter" 
  "operator": "greaterEqual",
  "property": "endDate",
  "value": "2021-09-13T00:00:00.000Z"
}
```

--------------------------------

### Get Provider ID Token Response Example

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/authentication-service/usage

This is an example of the JSON response when successfully retrieving a provider's OIDC id_token. This feature is only available for the 'microsoft' provider and requires specific configuration.

```json
{
    "idToken": <the-provider-id-token>
}
```

--------------------------------

### Kafka Consumer Configuration Example

Source: https://docs.mia-platform.eu/docs/products/fast_data/configuration/projection_storer_config

Example configuration for a Kafka consumer. This setup is used by the service to consume messages from ingestion topics. Note that `max.poll.timeout.ms` is an ad-hoc property not part of standard Kafka configurations.

```json
"consumer": {
  "type": "kafka",
  "configuration": {
    "client.id": "galaxy.fast-data.DEV.inventory-projection-storer-consumer",
    "bootstrap.servers": "localhost:9092",
    "group.id": "galaxy.fast-data.DEV.inventory-projection-storer",
    "auto.offset.reset": "latest",
    "max.poll.records": 2000,
    "max.poll.timeout.ms": 500
  }
}
```

--------------------------------

### Access /books/ endpoint with GET

Source: https://docs.mia-platform.eu/docs/products/console/tutorials/protect-your-endpoints-with-policies

Demonstrates the response when the X-Api-Key header is missing from a GET request.

```bash
curl --request GET --url 'https://<your-host>.mia-platform.eu/v2/books/' --header 'accept: */*'  
  
{"error":"RBAC policy evaluation failed","statusCode":403,"message":"You do not have permissions to access this feature, contact the project administrator for more information."}
```

--------------------------------

### GET /categories Response Payload

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/pharma-ecommerce-backend/usage

Example of the JSON response structure for product categories and their associated subcategories.

```json
{
  [
    "id": 1,
    "name": "Category 1",
    "subcategories": []
  ],
  [
    "id": 2,
    "name": "Category 2",
    "subcategories": [
      {
        "id": 1,
        "name": "Subcategory 1"
      }
    ]
  ],
    [
    "id": 3,
    "name": "Category 3",
    "subcategories": [
      {
        "id": 1,
        "name": "Subcategory 1"
      },
      {
        "id": 2,
        "name": "Subcategory 2"
      }
    ]
  ]
}
```

--------------------------------

### Example HTTP Action Configuration

Source: https://docs.mia-platform.eu/docs/products/microfrontend-composer/back-kit/actions

An example of an HTTP action configuration, including headers, query parameters, and downloading the result as a file.

```json
{
  "type": "http",
  "config": {
    "url": "/orders",
    "method": "GET",
    "config": {
      "headers": {"foo": "bar"},
      "params": {
        "some": "query-params"
      },
      "downloadAsFile": true
    }
  }
}

```

--------------------------------

### GET /theme-info Endpoint

Source: https://docs.mia-platform.eu/docs/products/microfrontend-composer/back-kit/components/antd_theme_manager

Example response from the /theme-info endpoint, providing dynamic theme color information.

```APIDOC
## GET /theme-info

### Description
This endpoint is called by the Antd Theme Manager to dynamically fetch theme color information. The response is used to initialize theme variables.

### Method
GET

### Endpoint
/theme-info

### Response
#### Success Response (200)
- **colors**: (object) - An object containing various color definitions.
  - **primary**: (string) - The primary color value.
  - **success**: (string) - The success color value.

#### Response Example
```json
{
  "colors": {
    "primary": "#43FA54",
    "success": "#46C872"
  }
}
```
```

--------------------------------

### Build the plugin binary

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/integration-connector-agent/processors/rpc_plugin

Compile the Go plugin into a binary file.

```bash
go build -o my-rpc-plugin  
```

--------------------------------

### Endpoint Folder Structure Example

Source: https://docs.mia-platform.eu/docs/runtime-components/templates/node.js-mia-care-samd-template/walkthrough

An example of the folder structure for a specific endpoint within the 'endpoints' directory. Each endpoint has subdirectories for different HTTP methods (e.g., 'get', 'post') and includes tests, handlers, and schemas.

```bash
... 
├── endpoints  
│ ├── route-name  
│ | ├── get  
│ | | ├── **tests** 
│ | | ├── index.js 
│ | | ├── handler.js 
│ | | └── schema.js 
│ | ├── post  
│ | | ├── **tests** 
│ | | ├── index.js 
│ | | ├── handler.js 
│ | | └── schema.js 
│ | └── ... 
└── ... 
└── ...
```

--------------------------------

### Projection Configuration Example

Source: https://docs.mia-platform.eu/docs/products/fast_data/configuration/projection_storer_config

A complete configuration example for a projection named 'pr_products', defining ingestion topics, storage namespace, primary keys, and field mappings with cast functions.

```json
"projections": {  
  "pr_products": {  
    "topics": {  
      "ingestion": {  
        "name": "galaxy.fast-data.DEV.products.ingestion"  
      },  
      "prUpdate": {  
        "name": "galaxy.fast-data.DEV.products.pr-update"  
      }  
    },  
    "customStorageNamespace": "products",  
    "primaryKeys": [  
      "id"  
    ],  
    "fieldsMapping": {  
      "id": {  
        "targetField": "id",  
        "castFunction": "identity"  
      },  
      "name": {  
        "targetField": "name",  
        "castFunction": "castToString"  
      },  
      "description": {  
        "targetField": "description",  
        "castFunction": "castToString"  
      },  
      "weight": {  
        "targetField": "weight",  
        "castFunction": "castToFloat"  
      },  
      "material": {  
        "targetField": "material",  
        "castFunction": "castToString"  
      },  
      "price": {  
        "targetField": "price",  
        "castFunction": "castToFloat"  
      }  
    }  
  }  
}  
```

--------------------------------

### Monitoring Prototype JSON Response

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/therapy-and-monitoring-manager/usage

Example JSON structure for a monitoring prototype returned by the GET /prototypes/ endpoint.

```json
[{  
    "identifier": "bloodPressure",  
    "type": "measurement",  
    "name": "Blood Pressure Prototype",  
    "schema": {  
      "type": "object",  
      "properties": {  
        "minimumBloodPressure": {  
          "type": "integer",  
          "minimum": 60,  
          "maximum": 150  
        },  
        "maximumBloodPressure": {  
          "type": "integer",  
          "minimum": 80,  
          "maximum": 250  
        }  
      },  
      "required": ["minimumBloodPressure", "maximumBloodPressure"]  
    },  
    "labels": {  
      "minimumBloodPressure": {  
        "en": "minimum pressure",  
        "it": "pressione minima"  
      },  
      "maximumBloodPressure": {  
        "en": "maximum pressure",  
        "it": "pressione massima"  
      }  
    },  
    "values": {  
      "minimumBloodPressure": {   
        "path": "observations[0].value"  
      },  
      "maximumBloodPressure": {   
        "path": "observations[1].value"  
      }  
    },  
  }]
```

--------------------------------

### Example Kafka Configuration File

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/flow-manager-router/configuration

An example of a valid Kafka configuration file. This includes broker details, authentication, and topic configurations for consumers and producers.

```json
{
  "brokers": "broker:9093",
  "authMechanism": "PLAIN",
  "username": "username",
  "password": "password",
  "consumerConfig": {
    "groupId": "router-0",
    "eventsTopic": "router-events",
    "notificationsTopic": "router-notification"
  },
  "producerConfig": {
    "mainFlowTopic": "main-flow"
  }
}

```

--------------------------------

### Therapy Prototype JSON Response

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/therapy-and-monitoring-manager/usage

Example JSON structure for a therapy prototype returned by the GET /prototypes/ endpoint.

```json
[{  
  "identifier": "drugPrescription",  
  "type": "therapy",  
  "name": "Drug prescription",  
  "schema": {  
    "type": "object",  
    "properties": {  
      "drugName": {  
        "type": "string"  
      },  
      "drugDosage": {  
        "type": "string"  
      }  
    },  
    "required": [  
      "drugName",  
      "drugDosage"  
    ]  
  },  
  "labels": {  
    "drugName": {  
      "en": "Drug name",  
      "it": "Nome del farmaco"  
    },  
    "drugDosage": {  
      "en": "Drug dosage",  
      "it": "Dosaggio farmaco"  
    }  
  },  
  "hints": {  
    "drugName": [{  
      "en": "Amoxicillin",  
      "it": "Amoxicillina"  
    },  
    {  
      "en": "Levofloxacin",  
      "it": "Levofloxacina"  
    },  
    {  
      "en": "Moxifloxacin",  
      "it": "Moxifloxacina"  
    }],  
    "drugDosage": [{  
      "en": "One per day",  
      "it": "Una volta al giorno"  
    },  
    {  
      "en": "Two per day",  
      "it": "Due volte al giorno"  
    },  
    {  
      "en": "Three per day",  
      "it": "Tre volte al giorno"  
    }]  
  }  
}]
```

--------------------------------

### Download and Enable BFF Key Setup Script

Source: https://docs.mia-platform.eu/docs/products/console/project-configuration/auth-flow/configuration

Use this script to generate cryptographic keys for session signing and token encryption.

```bash
version=latest  
curl -o setup_bff_keys.sh "https://cdn.mia-platform.eu/runtime/platform/auth/authtool/authtool_bff/${version}/setup_bff_keys.sh"  
  
# enable execution  
chmod +x setup_bff_keys.sh  
```

--------------------------------

### Kafka Topic Configuration Example

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/kafka2rest-service/configuration

A practical example of a configuration map. Ensure the baseUrl ends with a trailing slash.

```json
{
  "space-topic": {
    "baseUrl": "http://super-cool-service/notify/",
    "messageSchema": {
      "type": "object",
      "required": [
        "score"
      ],
      "properties": {
        "score": {
          "type": "number"
        },
        "user": {
          "type": "string"
        }
      }
    },
    "pathProcessor": "computed",
    "bodyProcessor": "payloadBased",
    "validatorProcessor": "winner"
  },
  "notification-topic": {
    "authentication": "privateKeyJwt",
    "tokenIssuerUrl": "http://client-credentials",
    "clientId": "pk-client",
    "privateKeyPath": "./path/to/the/id_rsa_priv.pem",
    "kid": "key-id",
    "miaJwtIss": "mia-idp",
    "requestedAudiences": ["dih"],
    "baseUrl": "http://space-notifications/",
    "messageSchema": {
      "type": "object",
      "required": [
        "result"
      ],
      "properties": {
        "result": {
          "type": "string",
          "enum": [
            "OK",
            "KO"
          ]
        }
      }
    },
    "pathProcessor": "constant",
    "bodyProcessor": "constantBody",
    "validatorProcessor": "default"
  },
  "interesting-topic": {
    "authentication": "basic",
    "tokenIssuerUrl": "http://client-credentials",
    "clientId": "my-client",
    "clientSecret": "if i tell you i have to kill you",
    "requestedAudiences": ["dih"],
    "baseUrl": "http://target-url-with-auth",
    "messageSchema": {
      "type": "object",
      "required": [
        "result"
      ],
      "properties": {
        "result": {
          "type": "string",
          "enum": [
            "OK",
            "KO"
          ]
```

--------------------------------

### Configure CRUD Client with Rerouting Rules

Source: https://docs.mia-platform.eu/docs/products/microfrontend-composer/back-kit/components/crud_client

Use `reroutingRules` to define custom paths for GET and PATCH requests. This example shows how to reroute GET requests to '/list/' and PATCH requests to '/update/', utilizing captured URL groups.

```json
{
  "tag": "bk-crud-client",
  "properties": {
    "basePath": "/orders",
    "dataSchema": {
      "type": "object",
      "properties": {
        "_id": {"type": "string"},
        "__STATE__": {"type": "string"},
        "name": {"type": "string"}
      }
    },
    "reroutingRules": [
      {
        "from": {
          "url": "^/orders/$",
          "method": "GET"
        },
        "to": "/list/"
      },
      {
        "from": {
          "url": "^/orders/([^/]+)$",
          "method": "PATCH"
        },
        "to": "/update/$1"
      }
    ]
  }
}
```

--------------------------------

### Kafka Producer Configuration Example

Source: https://docs.mia-platform.eu/docs/products/fast_data/configuration/projection_storer_config

Example configuration for a Kafka producer. This setup is used by the service to trigger projection updates as output events. Key Kafka producer properties like `acks` and `enable.idempotence` are managed by the service and cannot be customized.

```json
"producer": {
  "type": "kafka",
  "configuration": {
    "client.id": "galaxy.fast-data.DEV.inventory-projection-storer-producer",
    "bootstrap.servers": "localhost:9092"
  }
}
```

--------------------------------

### Example SubFlows Configuration File

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/flow-manager-router/configuration

An example of a valid sub-flow configuration file. This demonstrates how to define custom rules and their associated service URLs.

```json
[
  {
    "id": "customRule",
    "info": {
      "flowManagerUrl": "http://custom-flow-manager-service",
      "crudServiceUrl": "http://crud-service/custom-saga-collection/"
    },
    "rules": {
      "someKey": "someValue",
      "nestedObject": {
        "nestedKey": "nestedValue"
      }
    }
  },
  {
    "id": "default",
    "info": {
      "flowManagerUrl": "http://default-flow-manager-service",
      "crudServiceUrl": "http://crud-service/default-saga-collection/"
    },
    "rules": {}
  }
]

```

--------------------------------

### Initialize Single View Creator

Source: https://docs.mia-platform.eu/docs/products/fast_data/configuration/single_view_creator/template

Instantiate the service and initialize the environment using the Custom Plugin Lib.

```javascript
const singleViewCreator = getSingleViewCreator(log, config, customMetrics)  
  
await singleViewCreator  
  .initEnvironment() // connect Mongo, Kafka and create the patient instance  
service.decorate('patient', singleViewCreator.k8sPatient)  
```

--------------------------------

### GET /detections/chart-data Request and Filters

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/device-manager/usage

Examples of the response format and the Back-kit filter structure used for querying TMM detections.

```json
[
  {
    "name": "systolicBloodPressure [Pa]",
    "data": [
      {
        "x": 1716819504000,
        "y": 16400
      }
    ]
  },
  {
    "name": "diastolicBloodPressure [Pa]",
    "data": [
      {
        "x": 1716819504000,
        "y": 10533
      }
    ]
  }
]
```

```json
[
  {
    "property":"recordedAt",
    "operator":"between",
    "value":[
      "2023-03-01T12:44:52.428Z",
      "2023-05-31T12:44:55.428Z"
    ]
  },
  {
    "property":"planId",
    "operator":"equal",
    "value":"668253dd1f4092358e249610"
  }
]
```

--------------------------------

### Kafka Configuration Examples

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/flow-manager-service/configuration

JSON configurations for Kafka consumers, producers, and full setups including authentication and topic definitions.

```json
{
  "id": "myKafkaConsumer",
  "type": "kafka",
  "configurations": {
    "brokers": [
      "myKafkaNode1:9092",
      "myKafkaNode2:9092",
    ],
    "inputTopics": [
      "topic-to-subscribe"
    ],
    "consumerGroup": "myConsumer",
    "authenticationProperties": {
      "ssl": true,
      "sasl": {
        "mechanism": "plain",
        "username": "username",
        "password": "password"
      }
    }
  }
}
```

```json
{
  "id": "myKafkaProducer",
  "type": "kafka",
  "configurations": {
    "brokers": "myKafkaNode1:9092,myKafkaNode2:9092",
    "outputTopics": [
      "topic-to-publish-on"
    ]
  }
}
```

```json
{
  "id": "myKafka",
  "type": "kafka",
  "configurations": {
    "brokers": [
      "myKafka:9092"
    ],
    "inputTopics": [
      "topic-to-subscribe"
    ],
    "outputTopics": [
      "topic-to-publish-on"
    ],
    "consumerGroup": "myConsumer",
    "authenticationProperties": {
      "ssl": true,
      "sasl": {
        "mechanism": "plain",
        "username": "username",
        "password": "password"
      }
    }
  }
}
```

--------------------------------

### Example hello.js Function

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/function-service/configuration

This example demonstrates a basic 'hello-world' POST endpoint. It includes a schema for request and response validation, and exports the required fields for a function service endpoint.

```javascript
'use strict'

const schema = {
    body: {},
    response: {
        '200': {
            type: 'object',
            properties: {
                'text': {type: 'string'},
            },
        },
    },
}

async function handler(req, res) {
    res.send({
        'text': 'hello-world',
    })
}

module.exports = {
    method: 'POST',
    path: '/hello-world',
    name: 'Hello World',
    handler,
    schema,
}
```

--------------------------------

### Retrieve Token Information Response

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/authentication-service/usage

Example JSON response from the GET /tokeninfo endpoint containing user details and provider-specific information.

```json
{
    "userId": "63cacfa530a2a89a7f057dce",
    "groups": [
        "testgroup"
    ],
    "email": "some@email.com",
    "name": "John Doe",
    "provider": {
        "accessToken": "provider-token",
        "id": "provider-id",
        "baseUrl": "provider base url",
        "userId": "provider-user-id"
    }
}
```

--------------------------------

### Define the plugin entry point

Source: https://docs.mia-platform.eu/docs/runtime-components/plugins/integration-connector-agent/processors/rpc_plugin

Use the rpcprocessor package to serve the custom processor implementation in the main function.

```go
package main  
  
import (  
	"log"  
  
	rpcprocessor "github.com/mia-platform/integration-connector-agent/adapters/rpc-processor"  
)  
  
func main() {  
	l, err := rpcprocessor.NewLogger("trace")  
	if err != nil {  
		log.Fatal(err)  
	}  
  
	processor := &CustomProcessor{  
		logger: l,  
	}  
	rpcprocessor.Serve(&rpcprocessor.Config{  
		Processor: processor,  
		Logger:    l,  
	})  
}  
```
Tokens:
Raw