Files

T

Oliver Sand 46b9ae82ba Add filters to API Explorer (#2830 )

* fix: support nested fields in table filter

Add support for nested fields like metadata.name to the table filters. Previously only top-level fields were allowed. In addition, support for filtering on fields that are arrays is introduced (like tags). Filters are now distinct.

* feat: introduce table filters to the api explorer

* fix: allow to close select in multiple mode

* fix: export TableFilter

2020-10-13 09:45:25 +02:00

dev

feat(api-docs): add plugin that provides widgets that display api docs

2020-08-12 13:53:34 +02:00

docs

[ImgBot] Optimize images (#2747 )

2020-10-05 14:39:56 +02:00

src

Add filters to API Explorer (#2830 )

2020-10-13 09:45:25 +02:00

.eslintrc.js

feat(api-docs): add plugin that provides widgets that display api docs

2020-08-12 13:53:34 +02:00

package.json

v0.1.1-alpha.25

2020-10-12 22:42:54 +02:00

README.md

feat: TechDocs - Add vale linter to check words quality in md files. (#2631 )

2020-10-02 07:20:47 +02:00

README.md

API Documentation

WORK IN PROGRESS

This is an extension for the catalog plugin that provides components to discover and display API entities. APIs define the interface between components, see the system model for details. They are defined in machine readable formats and provide a human readable documentation.

The plugin provides a standalone list of APIs, as well as an integration into the API tab of a catalog entity.

Right now, the following API formats are supported:

Other formats are displayed as plain text, but this can easily be extended.

To fill the catalog with APIs, provide entities of kind API. To link that an component implements an API, see implementsApis property on components.

README.md

API Documentation

Links