Skip to content

Commit d5c7995

Browse files
authored
chore(orchestrator): add TOC to orchestratorFormWidgets.md (#1238)
1 parent 651de2c commit d5c7995

1 file changed

Lines changed: 39 additions & 3 deletions

File tree

workspaces/orchestrator/docs/orchestratorFormWidgets.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,48 @@ Key Differentiators:
1717

1818
Implementation of the HTTP endpoints is out of the scope of this library, they are expected to be custom developed to match rules and data sources of target environment.
1919

20-
## Content
21-
22-
The frontend plugin provides implementation of `OrchestratorFormApi` (for `orchestratorFormApiRef`) to extend the Workflow execution form for custom provided `ui:widgets`.
20+
## Table of Content
21+
22+
- [The orchestrator-form-widgets library](#the-orchestrator-form-widgets-library)
23+
- [Development of a workflow using orchestrator-form-widgets](#development-of-a-workflow-using-orchestrator-form-widgets)
24+
- [Table of Content](#table-of-content)
25+
- [Context](#context)
26+
- [Deployment considerations](#deployment-considerations)
27+
- [SchemaUpdater widget](#schemaupdater-widget)
28+
- [Example of the SchemaUpdater use in workflow's input data schema](#example-of-the-schemaupdater-use-in-workflows-input-data-schema)
29+
- [Expected response for the SchemaUpdater](#expected-response-for-the-schemaupdater)
30+
- [Using selector to narrow complex response in SchemaUpdater](#using-selector-to-narrow-complex-response-in-schemaupdater)
31+
- [Default mandatory data](#default-mandatory-data)
32+
- [SchemaUpdater widget ui:props](#schemaupdater-widget-uiprops)
33+
- [ActiveTextInput widget](#activetextinput-widget)
34+
- [ActiveTextInput Data fetching](#activetextinput-data-fetching)
35+
- [ActiveTextInput Data validation](#activetextinput-data-validation)
36+
- [Autocomplete](#autocomplete)
37+
- [ActiveTextInput widget ui:props](#activetextinput-widget-uiprops)
38+
- [ActiveDropdown widget](#activedropdown-widget)
39+
- [ActiveDropdown Data Fetching and validation](#activedropdown-data-fetching-and-validation)
40+
- [ActiveDropdown widget ui:props](#activedropdown-widget-uiprops)
41+
- [ActiveMultiSelect widget](#activemultiselect-widget)
42+
- [ActiveMultiSelect Data Fetching and validation](#activemultiselect-data-fetching-and-validation)
43+
- [ActiveMultiSelect widget ui:props](#activemultiselect-widget-uiprops)
44+
- [ActiveText widget](#activetext-widget)
45+
- [ActiveText Data Fetching](#activetext-data-fetching)
46+
- [Dynamic Text Templating](#dynamic-text-templating)
47+
- [ActiveText widget ui:props](#activetext-widget-uiprops)
48+
- [Content of `ui:props`](#content-of-uiprops)
49+
- [List of widget properties](#list-of-widget-properties)
50+
- [Specifics for templates in fetch:body, validate:body, fetch:headers or validate:headers](#specifics-for-templates-in-fetchbody-validatebody-fetchheaders-or-validateheaders)
51+
- [Authentication](#authentication)
52+
- [Backend Proxy](#backend-proxy)
53+
- [Templating and Backstage API Exposed Parts](#templating-and-backstage-api-exposed-parts)
54+
- [Example](#example)
55+
- [Retrieving Data from Backstage Catalog](#retrieving-data-from-backstage-catalog)
56+
- [Customization](#customization)
2357

2458
## Context
2559

60+
The frontend plugin provides implementation of `OrchestratorFormApi` (for `orchestratorFormApiRef`) to extend the Workflow execution form for custom provided `ui:widgets`.
61+
2662
The provided widgets enable forms to incorporate dynamically retrieved data.
2763

2864
This data can be fetched from external HTTP servers, the Backstage API, as well as from other form fields, with all evaluations performed in real time during use.

0 commit comments

Comments
 (0)