diff --git a/docs/api.md b/docs/api.md index a9f6a59..3d076ae 100644 --- a/docs/api.md +++ b/docs/api.md @@ -115,6 +115,7 @@ associated metadata and schemata, and for interacting with farmOS servers. | [remote.authorize] | function | | [remote.getToken] | function | | asset | [FarmEntityMethods](#FarmEntityMethods) | +| file | [FarmEntityMethods](#FarmEntityMethods) | | log | [FarmEntityMethods](#FarmEntityMethods) | | plan | [FarmEntityMethods](#FarmEntityMethods) | | quantity | [FarmEntityMethods](#FarmEntityMethods) | @@ -208,6 +209,7 @@ associated metadata and schemata. | meta | Object | | meta.isUnsynced | function | | asset | [ModelEntityMethods](#ModelEntityMethods) | +| file | [ModelEntityMethods](#ModelEntityMethods) | | log | [ModelEntityMethods](#ModelEntityMethods) | | plan | [ModelEntityMethods](#ModelEntityMethods) | | quantity | [ModelEntityMethods](#ModelEntityMethods) | @@ -238,21 +240,20 @@ Create a farm model for generating and manipulating farmOS data structures. * [model](#model) ⇒ [FarmModel](#FarmModel) - * [~getSchemata([entity], [bundle])](#model..getSchemata) ⇒ [EntitySchemata](#EntitySchemata) \| [BundleSchemata](#BundleSchemata) \| [JsonSchemaDereferenced](#JsonSchemaDereferenced) + * [~getSchemata(...args)](#model..getSchemata) ⇒ [EntitySchemata](#EntitySchemata) \| [BundleSchemata](#BundleSchemata) \| [JsonSchemaDereferenced](#JsonSchemaDereferenced) * [~setSchemata(...args)](#model..setSchemata) -### model~getSchemata([entity], [bundle]) ⇒ [EntitySchemata](#EntitySchemata) \| [BundleSchemata](#BundleSchemata) \| [JsonSchemaDereferenced](#JsonSchemaDereferenced) +### model~getSchemata(...args) ⇒ [EntitySchemata](#EntitySchemata) \| [BundleSchemata](#BundleSchemata) \| [JsonSchemaDereferenced](#JsonSchemaDereferenced) Retrieve all schemata that have been previously set, or the schemata of a particular entity, or one bundle's schema, if specified. **Kind**: inner method of [model](#model) -| Param | Type | Description | -| --- | --- | --- | -| [entity] | String | The name of a farmOS entity (eg, 'asset', 'log', etc). | -| [bundle] | String | The entity's bundle (eg, 'activity' for type 'log--activity'). | +| Param | Type | +| --- | --- | +| ...args | String | @@ -328,6 +329,7 @@ from a farmOS Drupal 9 server using JSON:API. | schema | Object | | schema.fetch | [FetchSchema](#FetchSchema) | | asset | [ClientEntityMethods](#ClientEntityMethods) | +| file | [ClientEntityMethods](#ClientEntityMethods) | | log | [ClientEntityMethods](#ClientEntityMethods) | | plan | [ClientEntityMethods](#ClientEntityMethods) | | quantity | [ClientEntityMethods](#ClientEntityMethods) | @@ -418,6 +420,7 @@ Create a farm client for interacting with farmOS servers. | Name | Type | | --- | --- | | asset | [EntityConfig](#EntityConfig) | +| file | [EntityConfig](#EntityConfig) | | log | [EntityConfig](#EntityConfig) | | plan | [EntityConfig](#EntityConfig) | | quantity | [EntityConfig](#EntityConfig) |