paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 42 Packages Projects Releases Wiki Activity

Merge pull request #27116 from backstage/blam/fix-api-report

Browse Source 
Fix API Report warning validation
This commit is contained in:
Ben Lambert
2024-10-15 12:20:02 +02:00
committed by GitHub
parent 7da76080bd 4b60e0c2b8
commit 56f656343d
219 changed files with 54 additions and 4218 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder-react/report-alpha.api.md
+6 -47
View File
@@ -48,6 +48,12 @@ export type BackstageOverrides = Overrides & {
>;
};
// @alpha (undocumented)
export type BackstageTemplateStepperClassKey =
| 'backButton'
| 'footer'
| 'formWrapper';
// @alpha (undocumented)
export const createAsyncValidators: (
rootSchema: JsonObject,
@@ -374,52 +380,5 @@ export type WorkflowProps = {
| 'layouts'
>;
// Warnings were encountered during analysis:
//
// src/next/blueprints/types.d.ts:5:1 - (ae-undocumented) Missing documentation for "FormFieldExtensionData".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:7:5 - (ae-undocumented) Missing documentation for "rawDescription".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:8:5 - (ae-undocumented) Missing documentation for "errors".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:9:5 - (ae-undocumented) Missing documentation for "rawErrors".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:10:5 - (ae-undocumented) Missing documentation for "help".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:11:5 - (ae-undocumented) Missing documentation for "rawHelp".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:12:5 - (ae-undocumented) Missing documentation for "required".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:13:5 - (ae-undocumented) Missing documentation for "disabled".
// src/next/components/ScaffolderField/ScaffolderField.d.ts:14:5 - (ae-undocumented) Missing documentation for "displayLabel".
// src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.d.ts:5:1 - (ae-undocumented) Missing documentation for "ScaffolderPageContextMenuProps".
// src/next/components/ScaffolderPageContextMenu/ScaffolderPageContextMenu.d.ts:14:1 - (ae-undocumented) Missing documentation for "ScaffolderPageContextMenu".
// src/next/components/Stepper/createAsyncValidators.d.ts:6:1 - (ae-undocumented) Missing documentation for "FormValidation".
// src/next/components/Stepper/createAsyncValidators.d.ts:10:22 - (ae-undocumented) Missing documentation for "createAsyncValidators".
// src/next/components/TaskSteps/TaskSteps.d.ts:10:5 - (ae-undocumented) Missing documentation for "steps".
// src/next/components/TaskSteps/TaskSteps.d.ts:11:5 - (ae-undocumented) Missing documentation for "activeStep".
// src/next/components/TaskSteps/TaskSteps.d.ts:12:5 - (ae-undocumented) Missing documentation for "isComplete".
// src/next/components/TaskSteps/TaskSteps.d.ts:13:5 - (ae-undocumented) Missing documentation for "isError".
// src/next/components/TemplateCard/TemplateCard.d.ts:9:5 - (ae-undocumented) Missing documentation for "template".
// src/next/components/TemplateCard/TemplateCard.d.ts:10:5 - (ae-undocumented) Missing documentation for "additionalLinks".
// src/next/components/TemplateCard/TemplateCard.d.ts:15:5 - (ae-undocumented) Missing documentation for "onSelected".
// src/next/components/TemplateCategoryPicker/TemplateCategoryPicker.d.ts:3:1 - (ae-undocumented) Missing documentation for "ScaffolderReactTemplateCategoryPickerClassKey".
// src/next/components/TemplateGroup/TemplateGroup.d.ts:10:5 - (ae-undocumented) Missing documentation for "templates".
// src/next/components/TemplateGroup/TemplateGroup.d.ts:18:5 - (ae-undocumented) Missing documentation for "onSelected".
// src/next/components/TemplateGroup/TemplateGroup.d.ts:19:5 - (ae-undocumented) Missing documentation for "title".
// src/next/components/TemplateGroup/TemplateGroup.d.ts:20:5 - (ae-undocumented) Missing documentation for "components".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:8:1 - (ae-undocumented) Missing documentation for "TemplateGroupsProps".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:9:5 - (ae-undocumented) Missing documentation for "groups".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:10:5 - (ae-undocumented) Missing documentation for "templateFilter".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:11:5 - (ae-undocumented) Missing documentation for "TemplateCardComponent".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:14:5 - (ae-undocumented) Missing documentation for "onTemplateSelected".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:15:5 - (ae-undocumented) Missing documentation for "additionalLinksForEntity".
// src/next/components/TemplateGroups/TemplateGroups.d.ts:24:22 - (ae-undocumented) Missing documentation for "TemplateGroups".
// src/next/components/Workflow/Workflow.d.ts:7:1 - (ae-undocumented) Missing documentation for "WorkflowProps".
// src/next/components/Workflow/Workflow.d.ts:20:22 - (ae-undocumented) Missing documentation for "Workflow".
// src/next/components/Workflow/Workflow.d.ts:24:22 - (ae-undocumented) Missing documentation for "EmbeddableWorkflow".
// src/next/hooks/useTemplateParameterSchema.d.ts:5:22 - (ae-undocumented) Missing documentation for "useTemplateParameterSchema".
// src/next/hooks/useTemplateSchema.d.ts:10:5 - (ae-undocumented) Missing documentation for "uiSchema".
// src/next/hooks/useTemplateSchema.d.ts:11:5 - (ae-undocumented) Missing documentation for "mergedSchema".
// src/next/hooks/useTemplateSchema.d.ts:12:5 - (ae-undocumented) Missing documentation for "schema".
// src/next/hooks/useTemplateSchema.d.ts:13:5 - (ae-undocumented) Missing documentation for "title".
// src/next/hooks/useTemplateSchema.d.ts:14:5 - (ae-undocumented) Missing documentation for "description".
// src/next/overridableComponents.d.ts:6:1 - (ae-undocumented) Missing documentation for "ScaffolderReactComponentsNameToClassKey".
// src/next/overridableComponents.d.ts:8:5 - (ae-forgotten-export) The symbol "BackstageTemplateStepperClassKey" needs to be exported by the entry point alpha.d.ts
// src/next/overridableComponents.d.ts:11:1 - (ae-undocumented) Missing documentation for "BackstageOverrides".
// (No @packageDocumentation comment for this package)
```
plugins/scaffolder-react/report.api.md
-45
View File
@@ -558,50 +558,5 @@ export const useTaskEventStream: (taskId: string) => TaskStream;
// @public
export const useTemplateSecrets: () => ScaffolderUseTemplateSecrets;
// Warnings were encountered during analysis:
//
// src/api/ref.d.ts:3:22 - (ae-undocumented) Missing documentation for "scaffolderApiRef".
// src/api/types.d.ts:53:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputLink".
// src/api/types.d.ts:60:1 - (ae-undocumented) Missing documentation for "ScaffolderOutputText".
// src/api/types.d.ts:67:1 - (ae-undocumented) Missing documentation for "ScaffolderTaskOutput".
// src/api/types.d.ts:95:5 - (ae-undocumented) Missing documentation for "templateRef".
// src/api/types.d.ts:96:5 - (ae-undocumented) Missing documentation for "values".
// src/api/types.d.ts:97:5 - (ae-undocumented) Missing documentation for "secrets".
// src/api/types.d.ts:105:5 - (ae-undocumented) Missing documentation for "taskId".
// src/api/types.d.ts:113:5 - (ae-undocumented) Missing documentation for "allowedHosts".
// src/api/types.d.ts:121:5 - (ae-undocumented) Missing documentation for "integrations".
// src/api/types.d.ts:133:5 - (ae-undocumented) Missing documentation for "isTaskRecoverable".
// src/api/types.d.ts:134:5 - (ae-undocumented) Missing documentation for "taskId".
// src/api/types.d.ts:135:5 - (ae-undocumented) Missing documentation for "after".
// src/api/types.d.ts:138:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunOptions".
// src/api/types.d.ts:139:5 - (ae-undocumented) Missing documentation for "template".
// src/api/types.d.ts:140:5 - (ae-undocumented) Missing documentation for "values".
// src/api/types.d.ts:141:5 - (ae-undocumented) Missing documentation for "secrets".
// src/api/types.d.ts:142:5 - (ae-undocumented) Missing documentation for "directoryContents".
// src/api/types.d.ts:148:1 - (ae-undocumented) Missing documentation for "ScaffolderDryRunResponse".
// src/api/types.d.ts:149:5 - (ae-undocumented) Missing documentation for "directoryContents".
// src/api/types.d.ts:154:5 - (ae-undocumented) Missing documentation for "log".
// src/api/types.d.ts:155:5 - (ae-undocumented) Missing documentation for "steps".
// src/api/types.d.ts:156:5 - (ae-undocumented) Missing documentation for "output".
// src/api/types.d.ts:164:5 - (ae-undocumented) Missing documentation for "getTemplateParameterSchema".
// src/api/types.d.ts:172:5 - (ae-undocumented) Missing documentation for "getTask".
// src/api/types.d.ts:185:5 - (ae-undocumented) Missing documentation for "listTasks".
// src/api/types.d.ts:193:5 - (ae-undocumented) Missing documentation for "getIntegrationsList".
// src/api/types.d.ts:198:5 - (ae-undocumented) Missing documentation for "streamLogs".
// src/api/types.d.ts:199:5 - (ae-undocumented) Missing documentation for "dryRun".
// src/api/types.d.ts:200:5 - (ae-undocumented) Missing documentation for "autocomplete".
// src/components/types.d.ts:7:1 - (ae-undocumented) Missing documentation for "TemplateGroupFilter".
// src/extensions/types.d.ts:13:5 - (ae-undocumented) Missing documentation for "uiSchema".
// src/extensions/types.d.ts:30:5 - (ae-undocumented) Missing documentation for ""ui:options"".
// src/layouts/createScaffolderLayout.d.ts:16:5 - (ae-undocumented) Missing documentation for "name".
// src/layouts/createScaffolderLayout.d.ts:17:5 - (ae-undocumented) Missing documentation for "component".
// src/secrets/SecretsContext.d.ts:14:5 - (ae-undocumented) Missing documentation for "setSecrets".
// src/secrets/SecretsContext.d.ts:15:5 - (ae-undocumented) Missing documentation for "secrets".
// src/utils.d.ts:4:1 - (ae-undocumented) Missing documentation for "makeFieldSchema".
// src/utils.d.ts:15:5 - (ae-undocumented) Missing documentation for "type".
// src/utils.d.ts:17:5 - (ae-undocumented) Missing documentation for "uiOptionsType".
// src/utils.d.ts:18:5 - (ae-undocumented) Missing documentation for "schema".
// src/utils.d.ts:19:5 - (ae-undocumented) Missing documentation for "TProps".
// (No @packageDocumentation comment for this package)
```
plugins/scaffolder-react/src/next/components/Stepper/index.ts
+5 -1
View File
@@ -13,7 +13,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
export { Stepper, type StepperProps } from './Stepper';
export {
Stepper,
type StepperProps,
type BackstageTemplateStepperClassKey,
} from './Stepper';
export {
createAsyncValidators,
type FormValidation,