AsyncAPI Tool File

A validating AsyncAPI tool files

Type object
File match .asyncapi-tool
Schema URL https://catalog.lintel.tools/schemas/schemastore/asyncapi-tool-file/latest.json
Source https://raw.githubusercontent.com/asyncapi/website/master/scripts/tools/tools-schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

title string required

Human-readable name of the tool that will be visible to people in the list of tools.

Examples: "AsyncAPI Generator", "Cupid"
filters object required
4 nested properties
categories string[] required

Categories are used to group tools by different use case, like documentation or code generation. If have a list of fixed categories. If you use different one that your tool lands under "other" category. Feel free to add your category through a pull request to AsyncAPI website repository.

Examples: "api", "code-first", "code-generator", "converter", "directory", "documentation-generator", "editor", "ui-component", "dsl", "framework", "github-action", "mocking-and-testing", "validator", "compare-tool", "other", "cli", "bundler", "ide-extension"
minItems=1
language string | string[]

The language referred to is the runtime language selected by the user, not the generator or library language. For example, the Generator written in JavaScript generates Python code from the JavaScript template and the result of generation is a Python app, so the language for Generator is specified as Python. But for the Bundler library, users need to know if it can be integrated into their TypeScript codebase, so its language is specified as TypeScript. If some language in the schema's enum is omitted, it can be added through a pull request to the AsyncAPI website repository.

technology string[]

Provide a list of different technologies used in the tool. Put details useful for tool user and tool contributor.

Examples: "Express.js", "Kafka"
hasCommercial boolean

Indicate if your tool is open source or commercial offering, like SAAS for example

Default: false
description string

By default scripts read description of repository there project is stored. You can override this behaviour by providing custom description.