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.


![image](https://github.com/user-attachments/assets/980d825f-49a2-426d-933a-2ff3d205ea24)


![image](https://github.com/user-attachments/assets/d0b1f288-1ea1-4d80-8c05-003d59a4e41a)

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:
Alessio Gravili
2024-12-19 20:22:43 -07:00
committed by GitHub
parent 46e50c4572
commit b3308736c4
21 changed files with 323 additions and 47 deletions

View File

@@ -107,6 +107,9 @@ export interface User {
export interface Product {
id: string;
name?: string | null;
/**
* All pricing information is managed in Stripe and will be reflected here.
*/
price?: {
stripePriceID?: string | null;
stripeJSON?: string | null;
@@ -123,6 +126,9 @@ export interface Product {
export interface Customer {
id: string;
name?: string | null;
/**
* All subscriptions are managed in Stripe and will be reflected here. Use the link in the sidebar to go directly to this customer in Stripe to begin managing their subscriptions.
*/
subscriptions?:
| {
stripeSubscriptionID?: string | null;