@@ -10,33 +10,15 @@ import Link from '@docusaurus/Link';
10
10
11
11
## API Definition
12
12
13
- | Name | Definition |
14
- | :----------------------------: | ------------------------------------------------ |
15
- | [ Endpoint] ( /rest/api/Endpoint ) | Async methods |
16
- | [ Schema] ( ./normalization.md ) | Declarative Data model |
17
- | [ Entity] ( /rest/api/Entity ) | A type of schema defining a single unique object |
18
- | Resource | Collection of methods for a given data model. |
13
+ | Name | Definition |
14
+ | :----------------------------------: | --------------------------------------------- |
15
+ | [ Endpoint] ( /rest/api/Endpoint ) | Async methods |
16
+ | [ Schema] ( ./normalization.md ) | Declarative Data model |
17
+ | [ Resource] ( /rest/api/createResource ) | Collection of methods for a given data model. |
19
18
20
- ## Client
19
+ ### Endpoint Conditions
21
20
22
- <ThemedImage
23
- alt="FLUX"
24
- sources={{
25
- light: useBaseUrl('/img/flux.png'),
26
- dark: useBaseUrl('/img/flux-dark.png'),
27
- }}
28
- />
29
-
30
- | Name | Definition |
31
- | :--------------------------------: | ---------------------------------------------------------------------------------- |
32
- | Flux | Unidirectional data flow |
33
- | Store | Centralized location for holding data and processing it |
34
- | [ Manager] ( ./managers.md ) | Orchestrates global control flow. Interfaces with store by providing a middleware. |
35
- | [ Controller] ( ../api/Controller.md ) | Type-safe imperative access to store. |
36
-
37
- ## Endpoint Conditions
38
-
39
- <table width =" 100% " >
21
+ <table >
40
22
<thead>
41
23
<tr>
42
24
<th>Value</th>
@@ -70,3 +52,37 @@ sources={{
70
52
</tr>
71
53
</tbody>
72
54
</table >
55
+
56
+ <!-- #### Endpoint Options
57
+
58
+ | Name | Definition |
59
+ | :-------------------: | ------------------------------------------------------------------------ |
60
+ | schema | Declarative Data model |
61
+ | sideEffect | `false` means it is safe to run more than once without consequence. |
62
+ | dataExpiryLength | Lifetime when successful. |
63
+ | errorExpiryLength | Lifetime in case of failure. |
64
+ | errorPolicy | Uses `error` to determine [expiryPolicy](./expiry-policy.md). |
65
+ | invalidIfStale | `Stale` cache should always be considered `Invalid`. |
66
+ | pollFrequency | Miliseconds before refetch when Endpoint is subscribed. |
67
+ | getOptimisticResponse | Enables immediate mutation updates, without waiting on async resolution. | -->
68
+
69
+ ### Schema
70
+
71
+ <SchemaTable />
72
+
73
+ ## Client
74
+
75
+ <ThemedImage
76
+ alt="FLUX"
77
+ sources={{
78
+ light: useBaseUrl('/img/flux-full.png'),
79
+ dark: useBaseUrl('/img/flux-full-dark.png'),
80
+ }}
81
+ />
82
+
83
+ | Name | Definition |
84
+ | :--------------------------------------------------------------------: | ---------------------------------------------------------------------------------- |
85
+ | [ Flux] ( https://facebookarchive.github.io/flux/docs/in-depth-overview/ ) | Unidirectional data flow |
86
+ | Store | Centralized location for holding data and processing it |
87
+ | [ Manager] ( ./managers.md ) | Orchestrates global control flow. Interfaces with store by providing a middleware. |
88
+ | [ Controller] ( ../api/Controller.md ) | Type-safe imperative access to store. |
0 commit comments