feat: jsdocs for generated types, by using admin.description (#9917)
This makes use of admin.description to generate JSDocs for field,
collection and global generated types.


For the future, we should add a dedicated property to override these
JSDocs.
You can view the effect of this PR on our test suite generated types
here:
05f552bbbc
This commit is contained in:
@@ -216,6 +216,9 @@ export interface Form {
|
||||
)[]
|
||||
| null;
|
||||
submitButtonLabel?: string | null;
|
||||
/**
|
||||
* Choose whether to display an on-page message or redirect to a different page after they submit the form.
|
||||
*/
|
||||
confirmationType?: ('message' | 'redirect') | null;
|
||||
confirmationMessage?: {
|
||||
root: {
|
||||
@@ -240,6 +243,9 @@ export interface Form {
|
||||
} | null;
|
||||
url?: string | null;
|
||||
};
|
||||
/**
|
||||
* Send custom emails when the form submits. Use comma separated lists to send the same email to multiple recipients. To reference a value from this form, wrap that field's name with double curly brackets, i.e. {{firstName}}. You can use a wildcard {{*}} to output all data and {{*:table}} to format it as an HTML table in the email.
|
||||
*/
|
||||
emails?:
|
||||
| {
|
||||
emailTo?: string | null;
|
||||
@@ -248,6 +254,9 @@ export interface Form {
|
||||
replyTo?: string | null;
|
||||
emailFrom?: string | null;
|
||||
subject: string;
|
||||
/**
|
||||
* Enter the message that should be sent in this email.
|
||||
*/
|
||||
message?: {
|
||||
root: {
|
||||
type: string;
|
||||
@@ -304,6 +313,9 @@ export interface FormSubmission {
|
||||
payment?: {
|
||||
field?: string | null;
|
||||
status?: string | null;
|
||||
/**
|
||||
* Amount in cents
|
||||
*/
|
||||
amount?: number | null;
|
||||
paymentProcessor?: string | null;
|
||||
creditCard?: {
|
||||
|
||||
Reference in New Issue
Block a user