Skip to content

Commit fc19f55

Browse files
committed
improve MARKETPLACE_ITEM_TYPE param description
1 parent 10c56eb commit fc19f55

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/tools/descriptions.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,16 @@ export const paramsDescriptions = {
130130
MARKETPLACE_ITEM_ID: `The marketplace item to use to create the service. Can be found in the itemId field of the ${toolNames.LIST_MARKETPLACE} tool`,
131131
MARKETPLACE_ITEM_TYPE: `
132132
Type of marketplace item to filter, empty string means no filter.
133-
Possible values are:
133+
It can be a full Item Type Definition URN (following the pattern \`urn:<itd.metadata.namespace.id>:mktp:itd:<itd.metadata.name>\`), or a just an Item Type Definition name (i.e., \`itd.metadata.name\`) which will be considered belonging to the Mia-Platform default namespace. The relevant Item Type Definition fields can be found in the metadata.namespace.id and metadata.name fields of the ${toolNames.LIST_MARKETPLACE_ITEM_TYPE_DEFINITIONS} tool.
134+
The following values are built-in types belonging to the default Mia-Platform namespace:
134135
- application: Applications are bundles of resources that brings together services (i.e., plugins, templates, and examples), endpoints, CRUD collections, and public variables to ease the setup of large-scale artifacts.
135136
- example: Examples works no differently than templates, in the sense that they too provide an archive with base configurations. Unlike templates, examples should come with some features already implemented and tailored to help the user better familiarize with the development environment.
136137
- extension: Extensions are custom pages that enhances Console capabilities by integrating it into the sidebar navigation. Since extensions have their own dedicated section, they are left out by the Software Catalog UI. Extensions can still be managed with miactl, and API calls.
137138
- custom-resource: Infrastructure resources are custom objects that are not part of the standard Console supported resources. They can be managed from the dedicated section of the Console Design area.
138139
- plugin: Plugins are services that can be instantiated from the microservices section of the Console Design area. Practically speaking, plugins are Docker images that comes with some predefined configurations to make them work in Console projects (e.g., environment variables, config maps, probes...).
139140
- proxy: Proxies are specific configurations used to invoke APIs that are not part of the current project but may be exposed by an external provider or another project. Proxies can be instantiated from the dedicated section of the Console Design area.
140141
- sidecar: Sidecars are secondary utility containers running side by side with the main container in the same host. They are Docker images that can be instantiated from the dedicated section of the Console Design area.
141-
- template: Teamplates can be instantiated in Console the same as plugins. The difference is that they provide an archive that is cloned in the Project scope, instead of a Docker image, giving developers direct access to the codebase to evolve it at will. Templates are meant to be starting points with the bear minimum needed to start a service. Just like plugins, templates may also come with some predefined configurations.
142+
- template: Templates can be instantiated in Console the same as plugins. The difference is that they provide an archive that is cloned in the Project scope, instead of a Docker image, giving developers direct access to the codebase to evolve it at will. Templates are meant to be starting points with the bear minimum needed to start a service. Just like plugins, templates may also come with some predefined configurations.
142143
- infrastructure-component-runtime: Infrastructure Component runtime items are custom objects that are not part of the standard Console supported resources. They can be managed in the context of Infrastructure Project to be able to collect runtime data for visualization within Console.
143144
`,
144145
MARKETPLACE_ITEM_TENANT_ID: `The tenant of the marketplace item. Can be found in the tenantId field of the ${toolNames.LIST_MARKETPLACE} tool`,

0 commit comments

Comments
 (0)