Common Terminology

Term	Definition
API Entity	Platform element of Kind: API. Created based on provided API Specification.
API Specification	YAML file of OpenAPI 2.0 or OpenAPI 3.0 standards. Describes API to import into T-matic and to generate SDK for.
Code Component	Software Catalog Component. Generated by T-matic Code Generator based on API Specification from API Entity. It can be downloaded or Pushed to repo.
Artifact	Platform element of Kind: Artifact. Software package or Docker image to Publish to Registry. Usually consists of code related to Code Component and extra files describing package/image for the target Registry.
Resource	An element required for a runtime of an application or a resource.
Registry	An external or internal system that stores and distributes software packages/Docker images for a particular Code Component. For example, npm, Docker Registry.
Template	SSoftware Catalog Component of Kind: Template. A template of actions performed in the background and rendered on the front-end in a step-by-step manner.
Workflow	Argo Workflow Workflow.
Sensor	Argo Events Sensor. Event dependency manager to execute triggers.
Configuration Credential	A set of key-values which is required to authenticate Backstage in a 3rd-party system. There are 4 types of integration based on Configuration Credentials: Integration, Catalog Provider, Proxy, Standalone BE Plugin. Each Configuration Credential has its own set of fields for key-values and that is defined by 3rd-party authentication requirements and integration type.
Discovery	Process of scanning and downloading updates for platform elements based on 3rd-party integrations from Configuration Credentials.
Push	Process of uploading generated code (package or Docker image) to external storage - for example, to AWS S3, GitHub repo, or Docker Registry.
Publish	Process of uploading Artifact to external storage - for example, to npm.
API Tech Docs	A set of markdown documents generated based on API Specification from API Entity. Necessary for developers who work with generated SDK.
API Developer Portal	Static HTML that is generated based on API Specification from API Entity. Shows available endpoints and schemas, and gives the ability to execute example API requests using provided authorization by the user. Can be placed in public to show API capabilities of the user's product.
Metric	Time series of a scalar value with an explicitly defined unit of measure related to a certain platform component. It is usually set by external or internal services to be used for visualization and scorecard calculation.
Event	An object with a start and end time of a certain type related to a certain component. It is usually set by external or internal services to build a timeline of activities on the platform.
Scorecard	A set of conditions with different weights which are compared with actual metrics (directly measured or calculated) and represent milestones of completion towards a certain goal.
Announcement	A message to be sent on a certain datetime, is related to a certain component and is sent to recipients related to that component.
Notification	A message to be sent on a certain event, it is related to a certain scorecard and is sent to explicitly set recipients.