asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: generate references manually (#10325)

Browse Source 
* docs: generate references

* prep changes
This commit is contained in:
Shahed Nasser
2024-11-27 19:27:25 +02:00
committed by GitHub
parent 137913b469
commit 030b0cc095
153 changed files with 183455 additions and 140828 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/references/region_models/variables/region_models.Country/page.mdx
+1 -1
View File
@@ -8,6 +8,6 @@ import { TypeList } from "docs-ui"
# Country - Region Module Data Models Reference
This documentation provides a reference to the Country . This belongs to the Region Module.
This documentation provides a reference to the Country data model. It belongs to the Region Module.
<TypeList types={[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;&#62;&#62;","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Country"/>
www/apps/resources/references/region_models/variables/region_models.Region/page.mdx
+1 -1
View File
@@ -8,6 +8,6 @@ import { TypeList } from "docs-ui"
# Region - Region Module Data Models Reference
This documentation provides a reference to the Region . This belongs to the Region Module.
This documentation provides a reference to the Region data model. It belongs to the Region Module.
<TypeList types={[{"name":"id","type":"PrimaryKeyModifier&#60;IdProperty&#62;","description":"The ID of the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`TextProperty`","description":"The ISO 3-character currency code of the region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"automatic_taxes","type":"`BooleanProperty`","description":"Whether taxes are calculated automatically during checkout in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"countries","type":"HasMany&#60;[Country](../region_models.Country/page.mdx)&#62;","description":"The countries that belong to the region.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"iso_2","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 2-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"iso_3","type":"`TextProperty`","description":"The ISO 3-character code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"num_code","type":"`TextProperty`","description":"The ISO numeric code of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_name","type":"`TextProperty`","description":"The display name of the country","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"RelationNullableModifier&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => DmlEntity<{ iso_2: PrimaryKeyModifier<string, TextProperty>; iso_3: TextProperty; num_code: TextProperty; name: TextProperty; display_name: TextProperty; region: RelationNullableModifier<...>; metadata: NullableModifier<...>; } & { ...; } & {} & DMLSchemaDefaults, { ...; }>&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;, BelongsTo&#60;() => [DmlEntity](../../../dml/entity/classes/dml.entity.DmlEntity/page.mdx)&#60;&#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & &#123; id: PrimaryKeyModifier&#60;IdProperty&#62; ; name: TextProperty ; currency_code: TextProperty ; automatic_taxes: BooleanProperty ; countries: HasMany&#60;() => ...&#62; ; metadata?: JSONProperty &#125; & {} & DMLSchemaDefaults, \"region\"&#62;&#62;&#62;","description":"The region it belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`JSONProperty`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Region"/>