Skip to main content
Version: 9.x (Current)

CRUD Data Model Configuration

This section describes the data model with its related collections used by the Mia-Backoffice (our Content Management System) for the management of the Developer Portal.

Currently, there are four collections: components, categories, requests, icons.

info

In order to facilitate the experience, we suggest importing the fields from the following JSON files.

NameInternal EndpointJSON File
components/components
categories/categories
tags/tags
requests/requests
icons/icons

Components

This collection is used to store the components that will be displayed in the marketplace.

Excluding the default properties of the CRUD (_id, creatorId, createdAt, updaterId, updatedAt, STATE), the defined fields are:

  • title: the title of the component;
  • icon: the Object that contains the file icon definition. For more detail, refer to the icons section;
  • type: the type of the component (API, Event...);
  • category: the category to which the component belongs;
  • tags: the tags to which the component is associated to;
  • description: the description of the component, that will be displayed in the component detail;
  • linkApiPortal: the URL used to redirect the user to the API portal;
  • linkDocumentation: the URL used to redirect the documentation portal;
  • supporterName: name of the entity that supports the component;
  • supporterIcon: the Object that contains the supporter icon definition. For more detail, refer to the icons section.

Categories

This collection is used to save the name and description of the categories that can be used to group your components inside the marketplace.

Excluding the default properties of the CRUD (_id, creatorId, createdAt, updaterId, updatedAt, STATE), the defined fields are:

  • name: Contains the name of the category;
  • description: Contains the description of the category.

Tags

This collection is used to save the name and description of the tags that can be used to enrich your components inside the Marketplace.

Excluding the default properties of the CRUD (_id, creatorId, createdAt, updaterId, updatedAt, STATE), the defined fields are:

  • name: Contains the name of the tag;
  • description: Contains the description of the tag.

Requests

This collection is used to save the access requests to your components, made from the components marketplace.

Excluding the default properties of the CRUD (_id, creatorId, createdAt, updaterId, updatedAt, STATE), the defined fields are:

  • userEmail: the email of the user that is requesting the access;
  • userName: the name of the user that is requesting the access;
  • status: the current status of the request (open, completed...);
  • userOrganization: the organization to which the user belongs to;
  • requestedComponentId: ID of the component that the user want to access;
  • publicKey: the RSA public key of the user that is requesting the access;
  • additionalDescription: an additional description field to include further details regarding the request.

Icons

This collection is used to icons that you associate with each component.

Excluding the default properties of the CRUD (_id, creatorId, createdAt, updaterId, updatedAt, STATE), the defined fields are:

  • name: the original name of the uploaded file;
  • size: the size of the uploaded file;
  • location: the location of the file on the bucket;
  • file: the name of the file on the bucket.