chore: copy comments from RepoUrlPicker to stay consistent

Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
2024-06-19 13:48:49 +02:00
parent 8329e930c6
commit 80738256c3
2 changed files with 10 additions and 0 deletions
@@ -24,6 +24,13 @@ import { useApi } from '@backstage/core-plugin-api';
 import { RepoBranchPickerState } from './types';
 import FormHelperText from '@material-ui/core/FormHelperText';

+/**
+ * The underlying component that is rendered in the form for the `BitbucketRepoBranchPicker`
+ * field extension.
+ *
+ * @public
+ *
+ */
 export const BitbucketRepoBranchPicker = ({
  onChange,
  state,
@@ -77,4 +77,7 @@ export type RepoBranchPickerUiOptions =

 export type RepoBranchPickerProps = typeof RepoBranchPickerFieldSchema.type;

+// NOTE: There is a bug with this failing validation in the custom field explorer due
+// to https://github.com/rjsf-team/react-jsonschema-form/issues/675 even if
+// requestUserCredentials is not defined
 export const RepoBranchPickerSchema = RepoBranchPickerFieldSchema.schema;