@datocms/cma-client 5.2.0-alpha.3 → 5.2.0-alpha.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/cjs/generated/Client.js +3 -3
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js +12 -12
- package/dist/cjs/generated/resources/Role.js +8 -8
- package/dist/cjs/generated/resources/Role.js.map +1 -1
- package/dist/cjs/generated/resources/{SiteSearchSource.js → SearchIndex.js} +59 -71
- package/dist/cjs/generated/resources/SearchIndex.js.map +1 -0
- package/dist/cjs/generated/resources/{SiteSearchSourceEvent.js → SearchIndexEvent.js} +19 -19
- package/dist/cjs/generated/resources/SearchIndexEvent.js.map +1 -0
- package/dist/cjs/generated/resources/index.js +5 -5
- package/dist/cjs/generated/resources/index.js.map +1 -1
- package/dist/cjs/utilities/schemaRepository.js +131 -0
- package/dist/cjs/utilities/schemaRepository.js.map +1 -1
- package/dist/esm/generated/ApiTypes.d.ts +273 -270
- package/dist/esm/generated/Client.d.ts +2 -2
- package/dist/esm/generated/Client.js +3 -3
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +265 -258
- package/dist/esm/generated/resources/ItemType.d.ts +12 -12
- package/dist/esm/generated/resources/ItemType.js +12 -12
- package/dist/esm/generated/resources/Role.js +8 -8
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/SearchIndex.d.ts +132 -0
- package/dist/esm/generated/resources/{SiteSearchSource.js → SearchIndex.js} +58 -70
- package/dist/esm/generated/resources/SearchIndex.js.map +1 -0
- package/dist/esm/generated/resources/SearchIndexEvent.d.ts +61 -0
- package/dist/esm/generated/resources/{SiteSearchSourceEvent.js → SearchIndexEvent.js} +18 -18
- package/dist/esm/generated/resources/SearchIndexEvent.js.map +1 -0
- package/dist/esm/generated/resources/index.d.ts +2 -2
- package/dist/esm/generated/resources/index.js +2 -2
- package/dist/esm/generated/resources/index.js.map +1 -1
- package/dist/esm/utilities/schemaRepository.d.ts +42 -2
- package/dist/esm/utilities/schemaRepository.js +132 -1
- package/dist/esm/utilities/schemaRepository.js.map +1 -1
- package/dist/types/generated/ApiTypes.d.ts +273 -270
- package/dist/types/generated/Client.d.ts +2 -2
- package/dist/types/generated/RawApiTypes.d.ts +265 -258
- package/dist/types/generated/resources/ItemType.d.ts +12 -12
- package/dist/types/generated/resources/SearchIndex.d.ts +132 -0
- package/dist/types/generated/resources/SearchIndexEvent.d.ts +61 -0
- package/dist/types/generated/resources/index.d.ts +2 -2
- package/dist/types/utilities/schemaRepository.d.ts +42 -2
- package/package.json +3 -3
- package/resources.json +83 -85
- package/src/generated/ApiTypes.ts +274 -272
- package/src/generated/Client.ts +5 -5
- package/src/generated/RawApiTypes.ts +266 -259
- package/src/generated/resources/ItemType.ts +12 -12
- package/src/generated/resources/Role.ts +8 -8
- package/src/generated/resources/SearchIndex.ts +243 -0
- package/src/generated/resources/{SiteSearchSourceEvent.ts → SearchIndexEvent.ts} +32 -34
- package/src/generated/resources/index.ts +2 -2
- package/src/utilities/schemaRepository.ts +167 -9
- package/dist/cjs/generated/resources/SiteSearchSource.js.map +0 -1
- package/dist/cjs/generated/resources/SiteSearchSourceEvent.js.map +0 -1
- package/dist/esm/generated/resources/SiteSearchSource.d.ts +0 -132
- package/dist/esm/generated/resources/SiteSearchSource.js.map +0 -1
- package/dist/esm/generated/resources/SiteSearchSourceEvent.d.ts +0 -61
- package/dist/esm/generated/resources/SiteSearchSourceEvent.js.map +0 -1
- package/dist/types/generated/resources/SiteSearchSource.d.ts +0 -132
- package/dist/types/generated/resources/SiteSearchSourceEvent.d.ts +0 -61
- package/src/generated/resources/SiteSearchSource.ts +0 -267
|
@@ -83,15 +83,15 @@ export type EnvironmentIdentity = string;
|
|
|
83
83
|
*/
|
|
84
84
|
export type BuildTriggerIdentity = string;
|
|
85
85
|
/**
|
|
86
|
-
* ID of
|
|
86
|
+
* ID of search_index
|
|
87
87
|
*
|
|
88
|
-
* This interface was referenced by `
|
|
88
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
89
89
|
* via the `definition` "identity".
|
|
90
90
|
*
|
|
91
|
-
* This interface was referenced by `
|
|
91
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
92
92
|
* via the `definition` "id".
|
|
93
93
|
*/
|
|
94
|
-
export type
|
|
94
|
+
export type SearchIndexIdentity = string;
|
|
95
95
|
/**
|
|
96
96
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
97
97
|
* via the `instances.targetSchema` link.
|
|
@@ -807,35 +807,35 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
807
807
|
[k: string]: unknown;
|
|
808
808
|
};
|
|
809
809
|
/**
|
|
810
|
-
* ID of
|
|
810
|
+
* ID of search index event
|
|
811
811
|
*
|
|
812
|
-
* This interface was referenced by `
|
|
812
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
813
813
|
* via the `definition` "identity".
|
|
814
814
|
*
|
|
815
|
-
* This interface was referenced by `
|
|
815
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
816
816
|
* via the `definition` "id".
|
|
817
817
|
*/
|
|
818
|
-
export type
|
|
818
|
+
export type SearchIndexEventIdentity = string;
|
|
819
819
|
/**
|
|
820
|
-
* This interface was referenced by `
|
|
820
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
821
821
|
* via the `definition` "type".
|
|
822
822
|
*/
|
|
823
|
-
export type
|
|
823
|
+
export type SearchIndexEventType = 'search_index_event';
|
|
824
824
|
/**
|
|
825
|
-
* This interface was referenced by `
|
|
825
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
826
826
|
* via the `definition` "type".
|
|
827
827
|
*/
|
|
828
|
-
export type
|
|
828
|
+
export type SearchIndexType = 'search_index';
|
|
829
829
|
/**
|
|
830
|
-
* This interface was referenced by `
|
|
830
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
831
831
|
* via the `instances.targetSchema` link.
|
|
832
832
|
*/
|
|
833
|
-
export type
|
|
833
|
+
export type SearchIndexEventInstancesTargetSchema = SearchIndexEvent[];
|
|
834
834
|
/**
|
|
835
|
-
* This interface was referenced by `
|
|
835
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
836
836
|
* via the `instances.hrefSchema` link.
|
|
837
837
|
*/
|
|
838
|
-
export type
|
|
838
|
+
export type SearchIndexEventInstancesHrefSchema = {
|
|
839
839
|
/**
|
|
840
840
|
* Parameters to control offset-based pagination
|
|
841
841
|
*/
|
|
@@ -858,7 +858,7 @@ export type SiteSearchSourceEventInstancesHrefSchema = {
|
|
|
858
858
|
*/
|
|
859
859
|
ids?: string;
|
|
860
860
|
fields?: {
|
|
861
|
-
|
|
861
|
+
search_index_id?: {
|
|
862
862
|
eq?: string;
|
|
863
863
|
};
|
|
864
864
|
event_type?: {
|
|
@@ -876,7 +876,7 @@ export type SiteSearchSourceEventInstancesHrefSchema = {
|
|
|
876
876
|
/**
|
|
877
877
|
* Fields used to order results
|
|
878
878
|
*/
|
|
879
|
-
order_by?: '
|
|
879
|
+
order_by?: 'search_index_id_asc' | 'search_index_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
|
|
880
880
|
[k: string]: unknown;
|
|
881
881
|
};
|
|
882
882
|
/**
|
|
@@ -898,19 +898,19 @@ export type ItemInstancesHrefSchema<D extends ItemTypeDefinition = ItemTypeDefin
|
|
|
898
898
|
*/
|
|
899
899
|
filter?: {
|
|
900
900
|
/**
|
|
901
|
-
* Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]`
|
|
901
|
+
* Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]`. You can combine it with meta fields (like `_published_at`, `_status`), but _must not_ use model-specific fields
|
|
902
902
|
*/
|
|
903
903
|
ids?: string;
|
|
904
904
|
/**
|
|
905
|
-
* Model ID or `api_key` to filter. If you use this filter, you _must not_ use `filter[ids]`.
|
|
905
|
+
* Model/Block model ID or `api_key` to filter. If you use this filter, you _must not_ use `filter[ids]`. When passing a single element, you can use both meta fields and model-specific fields (note: model-specific fields only work with models, not block models). When passing multiple comma-separated values, you can use meta fields but _must not_ use model-specific fields
|
|
906
906
|
*/
|
|
907
907
|
type?: string;
|
|
908
908
|
/**
|
|
909
|
-
* Textual query to match.
|
|
909
|
+
* Textual query to match. Can be combined with other filters. When used, only records (not blocks) are returned. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
|
|
910
910
|
*/
|
|
911
911
|
query?: string;
|
|
912
912
|
/**
|
|
913
|
-
*
|
|
913
|
+
* Filter by record fields. Meta fields (like `_published_at`, `_status`) can be used in most cases. Model-specific fields (like `title`, `name`) require `filter[type]` to specify a single model, and only work with models (not block models). Same syntax as [GraphQL API records filters](/docs/content-delivery-api/filtering-records): use square brackets to indicate nesting levels. E.g. `filter[fields][parent][eq]=<ID_VALUE>`. Use snake_case for field names. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
|
|
914
914
|
*/
|
|
915
915
|
fields?: ToItemHrefSchemaField<D>;
|
|
916
916
|
/**
|
|
@@ -976,7 +976,7 @@ export type ItemSelfHrefSchema = {
|
|
|
976
976
|
*/
|
|
977
977
|
nested?: boolean;
|
|
978
978
|
/**
|
|
979
|
-
* Whether you want the currently published versions (`published
|
|
979
|
+
* Whether you want the currently published versions (`published`) of your records, or the latest available (`current`, default)
|
|
980
980
|
*/
|
|
981
981
|
version?: string;
|
|
982
982
|
[k: string]: unknown;
|
|
@@ -1346,11 +1346,11 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1346
1346
|
*/
|
|
1347
1347
|
query: string;
|
|
1348
1348
|
/**
|
|
1349
|
-
* The
|
|
1349
|
+
* The search index ID on which the search will be performed. If not provided, the first enabled search index will be used.
|
|
1350
1350
|
*/
|
|
1351
|
-
|
|
1351
|
+
search_index_id?: string;
|
|
1352
1352
|
/**
|
|
1353
|
-
*
|
|
1353
|
+
* The build trigger ID or name on which the search will be performed.
|
|
1354
1354
|
*/
|
|
1355
1355
|
build_trigger_id?: string;
|
|
1356
1356
|
/**
|
|
@@ -1540,10 +1540,10 @@ export type WebhookCallInstancesHrefSchema = {
|
|
|
1540
1540
|
*/
|
|
1541
1541
|
export type BuildTriggerInstancesTargetSchema = BuildTrigger[];
|
|
1542
1542
|
/**
|
|
1543
|
-
* This interface was referenced by `
|
|
1543
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
1544
1544
|
* via the `instances.targetSchema` link.
|
|
1545
1545
|
*/
|
|
1546
|
-
export type
|
|
1546
|
+
export type SearchIndexInstancesTargetSchema = SearchIndex[];
|
|
1547
1547
|
/**
|
|
1548
1548
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
1549
1549
|
* via the `instances.targetSchema` link.
|
|
@@ -1931,7 +1931,7 @@ export type Role = {
|
|
|
1931
1931
|
*/
|
|
1932
1932
|
can_edit_site: boolean;
|
|
1933
1933
|
/**
|
|
1934
|
-
* Can create
|
|
1934
|
+
* Can create and edit models and plugins
|
|
1935
1935
|
*/
|
|
1936
1936
|
can_edit_schema: boolean;
|
|
1937
1937
|
/**
|
|
@@ -1951,31 +1951,31 @@ export type Role = {
|
|
|
1951
1951
|
*/
|
|
1952
1952
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
1953
1953
|
/**
|
|
1954
|
-
* Can create
|
|
1954
|
+
* Can create and edit roles and invite/remove collaborators
|
|
1955
1955
|
*/
|
|
1956
1956
|
can_manage_users: boolean;
|
|
1957
1957
|
/**
|
|
1958
|
-
* Can create
|
|
1958
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
1959
1959
|
*/
|
|
1960
1960
|
can_manage_shared_filters: boolean;
|
|
1961
1961
|
/**
|
|
1962
|
-
* Can create
|
|
1962
|
+
* Can create and edit upload collections
|
|
1963
1963
|
*/
|
|
1964
1964
|
can_manage_upload_collections: boolean;
|
|
1965
1965
|
/**
|
|
1966
|
-
* Can create
|
|
1966
|
+
* Can create and edit build triggers
|
|
1967
1967
|
*/
|
|
1968
1968
|
can_manage_build_triggers: boolean;
|
|
1969
1969
|
/**
|
|
1970
|
-
* Can create
|
|
1970
|
+
* Can create and edit search indexes
|
|
1971
1971
|
*/
|
|
1972
|
-
|
|
1972
|
+
can_manage_search_indexes: boolean;
|
|
1973
1973
|
/**
|
|
1974
|
-
* Can create
|
|
1974
|
+
* Can create and edit webhooks
|
|
1975
1975
|
*/
|
|
1976
1976
|
can_manage_webhooks: boolean;
|
|
1977
1977
|
/**
|
|
1978
|
-
* Can create
|
|
1978
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
1979
1979
|
*/
|
|
1980
1980
|
can_manage_environments: boolean;
|
|
1981
1981
|
/**
|
|
@@ -1987,7 +1987,7 @@ export type Role = {
|
|
|
1987
1987
|
*/
|
|
1988
1988
|
can_access_audit_log: boolean;
|
|
1989
1989
|
/**
|
|
1990
|
-
* Can create
|
|
1990
|
+
* Can create and edit workflows
|
|
1991
1991
|
*/
|
|
1992
1992
|
can_manage_workflows: boolean;
|
|
1993
1993
|
/**
|
|
@@ -2003,9 +2003,9 @@ export type Role = {
|
|
|
2003
2003
|
*/
|
|
2004
2004
|
can_access_build_events_log: boolean;
|
|
2005
2005
|
/**
|
|
2006
|
-
* Can access the
|
|
2006
|
+
* Can access the search index events log
|
|
2007
2007
|
*/
|
|
2008
|
-
|
|
2008
|
+
can_access_search_index_events_log: boolean;
|
|
2009
2009
|
/**
|
|
2010
2010
|
* Allowed actions on a model (or all) for a role
|
|
2011
2011
|
*/
|
|
@@ -2115,16 +2115,16 @@ export type Role = {
|
|
|
2115
2115
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2116
2116
|
}[];
|
|
2117
2117
|
/**
|
|
2118
|
-
*
|
|
2118
|
+
* Search indexes that can be triggered by a role
|
|
2119
2119
|
*/
|
|
2120
|
-
|
|
2121
|
-
|
|
2120
|
+
positive_search_index_permissions: {
|
|
2121
|
+
search_index?: SearchIndexIdentity | null;
|
|
2122
2122
|
}[];
|
|
2123
2123
|
/**
|
|
2124
|
-
*
|
|
2124
|
+
* Search indexes that can't be triggered by a role
|
|
2125
2125
|
*/
|
|
2126
|
-
|
|
2127
|
-
|
|
2126
|
+
negative_search_index_permissions: {
|
|
2127
|
+
search_index?: SearchIndexIdentity | null;
|
|
2128
2128
|
}[];
|
|
2129
2129
|
inherits_permissions_from: RoleData[];
|
|
2130
2130
|
meta: RoleMeta;
|
|
@@ -2164,7 +2164,7 @@ export type RoleMeta = {
|
|
|
2164
2164
|
*/
|
|
2165
2165
|
can_edit_site: boolean;
|
|
2166
2166
|
/**
|
|
2167
|
-
* Can create
|
|
2167
|
+
* Can create and edit models and plugins
|
|
2168
2168
|
*/
|
|
2169
2169
|
can_edit_schema: boolean;
|
|
2170
2170
|
/**
|
|
@@ -2184,31 +2184,31 @@ export type RoleMeta = {
|
|
|
2184
2184
|
*/
|
|
2185
2185
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2186
2186
|
/**
|
|
2187
|
-
* Can create
|
|
2187
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2188
2188
|
*/
|
|
2189
2189
|
can_manage_users: boolean;
|
|
2190
2190
|
/**
|
|
2191
|
-
* Can create
|
|
2191
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2192
2192
|
*/
|
|
2193
2193
|
can_manage_shared_filters: boolean;
|
|
2194
2194
|
/**
|
|
2195
|
-
* Can create
|
|
2195
|
+
* Can create and edit upload collections
|
|
2196
2196
|
*/
|
|
2197
2197
|
can_manage_upload_collections: boolean;
|
|
2198
2198
|
/**
|
|
2199
|
-
* Can create
|
|
2199
|
+
* Can create and edit build triggers
|
|
2200
2200
|
*/
|
|
2201
2201
|
can_manage_build_triggers: boolean;
|
|
2202
2202
|
/**
|
|
2203
|
-
* Can create
|
|
2203
|
+
* Can create and edit search indexes
|
|
2204
2204
|
*/
|
|
2205
|
-
|
|
2205
|
+
can_manage_search_indexes: boolean;
|
|
2206
2206
|
/**
|
|
2207
|
-
* Can create
|
|
2207
|
+
* Can create and edit webhooks
|
|
2208
2208
|
*/
|
|
2209
2209
|
can_manage_webhooks: boolean;
|
|
2210
2210
|
/**
|
|
2211
|
-
* Can create
|
|
2211
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2212
2212
|
*/
|
|
2213
2213
|
can_manage_environments: boolean;
|
|
2214
2214
|
/**
|
|
@@ -2220,7 +2220,7 @@ export type RoleMeta = {
|
|
|
2220
2220
|
*/
|
|
2221
2221
|
can_access_audit_log: boolean;
|
|
2222
2222
|
/**
|
|
2223
|
-
* Can create
|
|
2223
|
+
* Can create and edit workflows
|
|
2224
2224
|
*/
|
|
2225
2225
|
can_manage_workflows: boolean;
|
|
2226
2226
|
/**
|
|
@@ -2236,9 +2236,9 @@ export type RoleMeta = {
|
|
|
2236
2236
|
*/
|
|
2237
2237
|
can_access_build_events_log: boolean;
|
|
2238
2238
|
/**
|
|
2239
|
-
* Can access the
|
|
2239
|
+
* Can access the search index events log
|
|
2240
2240
|
*/
|
|
2241
|
-
|
|
2241
|
+
can_access_search_index_events_log: boolean;
|
|
2242
2242
|
/**
|
|
2243
2243
|
* Allowed actions on a model (or all) for a role
|
|
2244
2244
|
*/
|
|
@@ -2348,16 +2348,16 @@ export type RoleMeta = {
|
|
|
2348
2348
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2349
2349
|
}[];
|
|
2350
2350
|
/**
|
|
2351
|
-
*
|
|
2351
|
+
* Search indexes that can be triggered by a role
|
|
2352
2352
|
*/
|
|
2353
|
-
|
|
2354
|
-
|
|
2353
|
+
positive_search_index_permissions: {
|
|
2354
|
+
search_index?: SearchIndexIdentity | null;
|
|
2355
2355
|
}[];
|
|
2356
2356
|
/**
|
|
2357
|
-
*
|
|
2357
|
+
* Search indexes that can't be triggered by a role
|
|
2358
2358
|
*/
|
|
2359
|
-
|
|
2360
|
-
|
|
2359
|
+
negative_search_index_permissions: {
|
|
2360
|
+
search_index?: SearchIndexIdentity | null;
|
|
2361
2361
|
}[];
|
|
2362
2362
|
};
|
|
2363
2363
|
};
|
|
@@ -2381,7 +2381,7 @@ export type RoleAttributes = {
|
|
|
2381
2381
|
*/
|
|
2382
2382
|
can_edit_site: boolean;
|
|
2383
2383
|
/**
|
|
2384
|
-
* Can create
|
|
2384
|
+
* Can create and edit models and plugins
|
|
2385
2385
|
*/
|
|
2386
2386
|
can_edit_schema: boolean;
|
|
2387
2387
|
/**
|
|
@@ -2401,31 +2401,31 @@ export type RoleAttributes = {
|
|
|
2401
2401
|
*/
|
|
2402
2402
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2403
2403
|
/**
|
|
2404
|
-
* Can create
|
|
2404
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2405
2405
|
*/
|
|
2406
2406
|
can_manage_users: boolean;
|
|
2407
2407
|
/**
|
|
2408
|
-
* Can create
|
|
2408
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2409
2409
|
*/
|
|
2410
2410
|
can_manage_shared_filters: boolean;
|
|
2411
2411
|
/**
|
|
2412
|
-
* Can create
|
|
2412
|
+
* Can create and edit upload collections
|
|
2413
2413
|
*/
|
|
2414
2414
|
can_manage_upload_collections: boolean;
|
|
2415
2415
|
/**
|
|
2416
|
-
* Can create
|
|
2416
|
+
* Can create and edit build triggers
|
|
2417
2417
|
*/
|
|
2418
2418
|
can_manage_build_triggers: boolean;
|
|
2419
2419
|
/**
|
|
2420
|
-
* Can create
|
|
2420
|
+
* Can create and edit search indexes
|
|
2421
2421
|
*/
|
|
2422
|
-
|
|
2422
|
+
can_manage_search_indexes: boolean;
|
|
2423
2423
|
/**
|
|
2424
|
-
* Can create
|
|
2424
|
+
* Can create and edit webhooks
|
|
2425
2425
|
*/
|
|
2426
2426
|
can_manage_webhooks: boolean;
|
|
2427
2427
|
/**
|
|
2428
|
-
* Can create
|
|
2428
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2429
2429
|
*/
|
|
2430
2430
|
can_manage_environments: boolean;
|
|
2431
2431
|
/**
|
|
@@ -2437,7 +2437,7 @@ export type RoleAttributes = {
|
|
|
2437
2437
|
*/
|
|
2438
2438
|
can_access_audit_log: boolean;
|
|
2439
2439
|
/**
|
|
2440
|
-
* Can create
|
|
2440
|
+
* Can create and edit workflows
|
|
2441
2441
|
*/
|
|
2442
2442
|
can_manage_workflows: boolean;
|
|
2443
2443
|
/**
|
|
@@ -2453,9 +2453,9 @@ export type RoleAttributes = {
|
|
|
2453
2453
|
*/
|
|
2454
2454
|
can_access_build_events_log: boolean;
|
|
2455
2455
|
/**
|
|
2456
|
-
* Can access the
|
|
2456
|
+
* Can access the search index events log
|
|
2457
2457
|
*/
|
|
2458
|
-
|
|
2458
|
+
can_access_search_index_events_log: boolean;
|
|
2459
2459
|
/**
|
|
2460
2460
|
* Allowed actions on a model (or all) for a role
|
|
2461
2461
|
*/
|
|
@@ -2565,16 +2565,16 @@ export type RoleAttributes = {
|
|
|
2565
2565
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2566
2566
|
}[];
|
|
2567
2567
|
/**
|
|
2568
|
-
*
|
|
2568
|
+
* Search indexes that can be triggered by a role
|
|
2569
2569
|
*/
|
|
2570
|
-
|
|
2571
|
-
|
|
2570
|
+
positive_search_index_permissions: {
|
|
2571
|
+
search_index?: SearchIndexIdentity | null;
|
|
2572
2572
|
}[];
|
|
2573
2573
|
/**
|
|
2574
|
-
*
|
|
2574
|
+
* Search indexes that can't be triggered by a role
|
|
2575
2575
|
*/
|
|
2576
|
-
|
|
2577
|
-
|
|
2576
|
+
negative_search_index_permissions: {
|
|
2577
|
+
search_index?: SearchIndexIdentity | null;
|
|
2578
2578
|
}[];
|
|
2579
2579
|
};
|
|
2580
2580
|
/**
|
|
@@ -2605,7 +2605,7 @@ export type RoleCreateSchema = {
|
|
|
2605
2605
|
*/
|
|
2606
2606
|
can_edit_site?: boolean;
|
|
2607
2607
|
/**
|
|
2608
|
-
* Can create
|
|
2608
|
+
* Can create and edit models and plugins
|
|
2609
2609
|
*/
|
|
2610
2610
|
can_edit_schema?: boolean;
|
|
2611
2611
|
/**
|
|
@@ -2625,31 +2625,31 @@ export type RoleCreateSchema = {
|
|
|
2625
2625
|
*/
|
|
2626
2626
|
environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2627
2627
|
/**
|
|
2628
|
-
* Can create
|
|
2628
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2629
2629
|
*/
|
|
2630
2630
|
can_manage_users?: boolean;
|
|
2631
2631
|
/**
|
|
2632
|
-
* Can create
|
|
2632
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2633
2633
|
*/
|
|
2634
2634
|
can_manage_shared_filters?: boolean;
|
|
2635
2635
|
/**
|
|
2636
|
-
* Can create
|
|
2636
|
+
* Can create and edit search indexes
|
|
2637
2637
|
*/
|
|
2638
|
-
|
|
2638
|
+
can_manage_search_indexes?: boolean;
|
|
2639
2639
|
/**
|
|
2640
|
-
* Can create
|
|
2640
|
+
* Can create and edit upload collections
|
|
2641
2641
|
*/
|
|
2642
2642
|
can_manage_upload_collections?: boolean;
|
|
2643
2643
|
/**
|
|
2644
|
-
* Can create
|
|
2644
|
+
* Can create and edit build triggers
|
|
2645
2645
|
*/
|
|
2646
2646
|
can_manage_build_triggers?: boolean;
|
|
2647
2647
|
/**
|
|
2648
|
-
* Can create
|
|
2648
|
+
* Can create and edit webhooks
|
|
2649
2649
|
*/
|
|
2650
2650
|
can_manage_webhooks?: boolean;
|
|
2651
2651
|
/**
|
|
2652
|
-
* Can create
|
|
2652
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2653
2653
|
*/
|
|
2654
2654
|
can_manage_environments?: boolean;
|
|
2655
2655
|
/**
|
|
@@ -2661,7 +2661,7 @@ export type RoleCreateSchema = {
|
|
|
2661
2661
|
*/
|
|
2662
2662
|
can_access_audit_log?: boolean;
|
|
2663
2663
|
/**
|
|
2664
|
-
* Can create
|
|
2664
|
+
* Can create and edit workflows
|
|
2665
2665
|
*/
|
|
2666
2666
|
can_manage_workflows?: boolean;
|
|
2667
2667
|
/**
|
|
@@ -2677,9 +2677,9 @@ export type RoleCreateSchema = {
|
|
|
2677
2677
|
*/
|
|
2678
2678
|
can_access_build_events_log?: boolean;
|
|
2679
2679
|
/**
|
|
2680
|
-
* Can access the
|
|
2680
|
+
* Can access the search index events log
|
|
2681
2681
|
*/
|
|
2682
|
-
|
|
2682
|
+
can_access_search_index_events_log?: boolean;
|
|
2683
2683
|
/**
|
|
2684
2684
|
* Allowed actions on a model (or all) for a role
|
|
2685
2685
|
*/
|
|
@@ -2789,16 +2789,16 @@ export type RoleCreateSchema = {
|
|
|
2789
2789
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2790
2790
|
}[];
|
|
2791
2791
|
/**
|
|
2792
|
-
*
|
|
2792
|
+
* Search indexes that can be triggered by a role
|
|
2793
2793
|
*/
|
|
2794
|
-
|
|
2795
|
-
|
|
2794
|
+
positive_search_index_permissions?: {
|
|
2795
|
+
search_index?: SearchIndexIdentity | null;
|
|
2796
2796
|
}[];
|
|
2797
2797
|
/**
|
|
2798
|
-
*
|
|
2798
|
+
* Search indexes that can't be triggered by a role
|
|
2799
2799
|
*/
|
|
2800
|
-
|
|
2801
|
-
|
|
2800
|
+
negative_search_index_permissions?: {
|
|
2801
|
+
search_index?: SearchIndexIdentity | null;
|
|
2802
2802
|
}[];
|
|
2803
2803
|
inherits_permissions_from?: RoleData[];
|
|
2804
2804
|
meta?: RoleMeta;
|
|
@@ -2823,7 +2823,7 @@ export type RoleUpdateSchema = {
|
|
|
2823
2823
|
*/
|
|
2824
2824
|
can_edit_site?: boolean;
|
|
2825
2825
|
/**
|
|
2826
|
-
* Can create
|
|
2826
|
+
* Can create and edit models and plugins
|
|
2827
2827
|
*/
|
|
2828
2828
|
can_edit_schema?: boolean;
|
|
2829
2829
|
/**
|
|
@@ -2843,31 +2843,31 @@ export type RoleUpdateSchema = {
|
|
|
2843
2843
|
*/
|
|
2844
2844
|
environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2845
2845
|
/**
|
|
2846
|
-
* Can create
|
|
2846
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2847
2847
|
*/
|
|
2848
2848
|
can_manage_users?: boolean;
|
|
2849
2849
|
/**
|
|
2850
|
-
* Can create
|
|
2850
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2851
2851
|
*/
|
|
2852
2852
|
can_manage_shared_filters?: boolean;
|
|
2853
2853
|
/**
|
|
2854
|
-
* Can create
|
|
2854
|
+
* Can create and edit search indexes
|
|
2855
2855
|
*/
|
|
2856
|
-
|
|
2856
|
+
can_manage_search_indexes?: boolean;
|
|
2857
2857
|
/**
|
|
2858
|
-
* Can create
|
|
2858
|
+
* Can create and edit upload collections
|
|
2859
2859
|
*/
|
|
2860
2860
|
can_manage_upload_collections?: boolean;
|
|
2861
2861
|
/**
|
|
2862
|
-
* Can create
|
|
2862
|
+
* Can create and edit build triggers
|
|
2863
2863
|
*/
|
|
2864
2864
|
can_manage_build_triggers?: boolean;
|
|
2865
2865
|
/**
|
|
2866
|
-
* Can create
|
|
2866
|
+
* Can create and edit webhooks
|
|
2867
2867
|
*/
|
|
2868
2868
|
can_manage_webhooks?: boolean;
|
|
2869
2869
|
/**
|
|
2870
|
-
* Can create
|
|
2870
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2871
2871
|
*/
|
|
2872
2872
|
can_manage_environments?: boolean;
|
|
2873
2873
|
/**
|
|
@@ -2879,7 +2879,7 @@ export type RoleUpdateSchema = {
|
|
|
2879
2879
|
*/
|
|
2880
2880
|
can_access_audit_log?: boolean;
|
|
2881
2881
|
/**
|
|
2882
|
-
* Can create
|
|
2882
|
+
* Can create and edit workflows
|
|
2883
2883
|
*/
|
|
2884
2884
|
can_manage_workflows?: boolean;
|
|
2885
2885
|
/**
|
|
@@ -2895,9 +2895,9 @@ export type RoleUpdateSchema = {
|
|
|
2895
2895
|
*/
|
|
2896
2896
|
can_access_build_events_log?: boolean;
|
|
2897
2897
|
/**
|
|
2898
|
-
* Can access the
|
|
2898
|
+
* Can access the search index events log
|
|
2899
2899
|
*/
|
|
2900
|
-
|
|
2900
|
+
can_access_search_index_events_log?: boolean;
|
|
2901
2901
|
/**
|
|
2902
2902
|
* Allowed actions on a model (or all) for a role
|
|
2903
2903
|
*/
|
|
@@ -3007,16 +3007,16 @@ export type RoleUpdateSchema = {
|
|
|
3007
3007
|
build_trigger?: BuildTriggerIdentity | null;
|
|
3008
3008
|
}[];
|
|
3009
3009
|
/**
|
|
3010
|
-
*
|
|
3010
|
+
* Search indexes that can be triggered by a role
|
|
3011
3011
|
*/
|
|
3012
|
-
|
|
3013
|
-
|
|
3012
|
+
positive_search_index_permissions?: {
|
|
3013
|
+
search_index?: SearchIndexIdentity | null;
|
|
3014
3014
|
}[];
|
|
3015
3015
|
/**
|
|
3016
|
-
*
|
|
3016
|
+
* Search indexes that can't be triggered by a role
|
|
3017
3017
|
*/
|
|
3018
|
-
|
|
3019
|
-
|
|
3018
|
+
negative_search_index_permissions?: {
|
|
3019
|
+
search_index?: SearchIndexIdentity | null;
|
|
3020
3020
|
}[];
|
|
3021
3021
|
inherits_permissions_from?: RoleData[];
|
|
3022
3022
|
meta?: RoleMeta;
|
|
@@ -3719,9 +3719,9 @@ export type SitePlan = {
|
|
|
3719
3719
|
*/
|
|
3720
3720
|
build_triggers: null | number;
|
|
3721
3721
|
/**
|
|
3722
|
-
* Number of
|
|
3722
|
+
* Number of search indexes
|
|
3723
3723
|
*/
|
|
3724
|
-
|
|
3724
|
+
search_indexes: null | number;
|
|
3725
3725
|
/**
|
|
3726
3726
|
* Number of plugins
|
|
3727
3727
|
*/
|
|
@@ -3886,7 +3886,7 @@ export type SitePlan = {
|
|
|
3886
3886
|
amount_per_packet: number;
|
|
3887
3887
|
price: number;
|
|
3888
3888
|
};
|
|
3889
|
-
|
|
3889
|
+
search_indexes?: {
|
|
3890
3890
|
amount_per_packet: number;
|
|
3891
3891
|
price: number;
|
|
3892
3892
|
};
|
|
@@ -3963,9 +3963,9 @@ export type SitePlanAttributes = {
|
|
|
3963
3963
|
*/
|
|
3964
3964
|
build_triggers: null | number;
|
|
3965
3965
|
/**
|
|
3966
|
-
* Number of
|
|
3966
|
+
* Number of search indexes
|
|
3967
3967
|
*/
|
|
3968
|
-
|
|
3968
|
+
search_indexes: null | number;
|
|
3969
3969
|
/**
|
|
3970
3970
|
* Number of plugins
|
|
3971
3971
|
*/
|
|
@@ -4130,7 +4130,7 @@ export type SitePlanAttributes = {
|
|
|
4130
4130
|
amount_per_packet: number;
|
|
4131
4131
|
price: number;
|
|
4132
4132
|
};
|
|
4133
|
-
|
|
4133
|
+
search_indexes?: {
|
|
4134
4134
|
amount_per_packet: number;
|
|
4135
4135
|
price: number;
|
|
4136
4136
|
};
|
|
@@ -4646,7 +4646,26 @@ export type UploadCollectionUpdateSchema = {
|
|
|
4646
4646
|
children?: UploadCollectionData[];
|
|
4647
4647
|
};
|
|
4648
4648
|
/**
|
|
4649
|
-
* The way you define the kind of content you can edit inside
|
|
4649
|
+
* The way you define the kind of content you can edit inside a DatoCMS project passes through the concept of **models** and **block models**. For backward-compatibility reasons, the API refers to both as "item types".
|
|
4650
|
+
*
|
|
4651
|
+
* ## Models
|
|
4652
|
+
*
|
|
4653
|
+
* Models are much like database tables — they define the structure of your main content types (e.g., blog posts, products, landing pages). Each model is composed of fields with custom validations. Records created from models exist independently and can be referenced by other records through link fields.
|
|
4654
|
+
*
|
|
4655
|
+
* ## Block Models
|
|
4656
|
+
*
|
|
4657
|
+
* Block models define complex and repeatable structures that can be embedded inside records. They are the foundation behind features like [Modular Content](/docs/content-modelling/modular-content.md) and [Structured Text](/docs/content-modelling/structured-text.md).
|
|
4658
|
+
*
|
|
4659
|
+
* ### Key differences:
|
|
4660
|
+
*
|
|
4661
|
+
* - **Models** create standalone records that can be referenced and have independent value
|
|
4662
|
+
* - **Block models** create blocks that only exist within parent records and cannot be referenced via link fields
|
|
4663
|
+
* - Block models defined in the library can be reused across different models
|
|
4664
|
+
* - When a record gets deleted, all the blocks it contains are deleted with it
|
|
4665
|
+
* - Blocks do not count towards your plan's records limit
|
|
4666
|
+
*
|
|
4667
|
+
* You can distinguish between models and block models using the `modular_block` attribute: `true` indicates a block model, `false` indicates a regular model.
|
|
4668
|
+
*
|
|
4650
4669
|
*
|
|
4651
4670
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4652
4671
|
* via the `definition` "item_type".
|
|
@@ -4655,11 +4674,11 @@ export type ItemType = {
|
|
|
4655
4674
|
id: ItemTypeIdentity;
|
|
4656
4675
|
type: ItemTypeType;
|
|
4657
4676
|
/**
|
|
4658
|
-
* Name of the model
|
|
4677
|
+
* Name of the model/block model
|
|
4659
4678
|
*/
|
|
4660
4679
|
name: string;
|
|
4661
4680
|
/**
|
|
4662
|
-
* API key of the model
|
|
4681
|
+
* API key of the model/block model
|
|
4663
4682
|
*/
|
|
4664
4683
|
api_key: string;
|
|
4665
4684
|
/**
|
|
@@ -4667,11 +4686,11 @@ export type ItemType = {
|
|
|
4667
4686
|
*/
|
|
4668
4687
|
collection_appeareance?: 'compact' | 'table';
|
|
4669
4688
|
/**
|
|
4670
|
-
* The way the model collection should be presented to the editors
|
|
4689
|
+
* The way the model/block model collection should be presented to the editors
|
|
4671
4690
|
*/
|
|
4672
4691
|
collection_appearance: 'compact' | 'table';
|
|
4673
4692
|
/**
|
|
4674
|
-
* Whether the model is single-instance or not
|
|
4693
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4675
4694
|
*/
|
|
4676
4695
|
singleton: boolean;
|
|
4677
4696
|
/**
|
|
@@ -4679,43 +4698,43 @@ export type ItemType = {
|
|
|
4679
4698
|
*/
|
|
4680
4699
|
all_locales_required: boolean;
|
|
4681
4700
|
/**
|
|
4682
|
-
* Whether editors can sort records via drag & drop or not
|
|
4701
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4683
4702
|
*/
|
|
4684
4703
|
sortable: boolean;
|
|
4685
4704
|
/**
|
|
4686
|
-
* Whether this
|
|
4705
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4687
4706
|
*/
|
|
4688
4707
|
modular_block: boolean;
|
|
4689
4708
|
/**
|
|
4690
|
-
* Whether draft/published mode is active or not
|
|
4709
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4691
4710
|
*/
|
|
4692
4711
|
draft_mode_active: boolean;
|
|
4693
4712
|
/**
|
|
4694
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4713
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4695
4714
|
*/
|
|
4696
4715
|
draft_saving_active: boolean;
|
|
4697
4716
|
/**
|
|
4698
|
-
* Whether editors can organize records in a tree or not
|
|
4717
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4699
4718
|
*/
|
|
4700
4719
|
tree: boolean;
|
|
4701
4720
|
/**
|
|
4702
|
-
* If an ordering field is set, this
|
|
4721
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4703
4722
|
*/
|
|
4704
4723
|
ordering_direction: null | 'asc' | 'desc';
|
|
4705
4724
|
/**
|
|
4706
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4725
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4707
4726
|
*/
|
|
4708
4727
|
ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
4709
4728
|
/**
|
|
4710
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4729
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4711
4730
|
*/
|
|
4712
4731
|
has_singleton_item: boolean;
|
|
4713
4732
|
/**
|
|
4714
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4733
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4715
4734
|
*/
|
|
4716
4735
|
hint: string | null;
|
|
4717
4736
|
/**
|
|
4718
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4737
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4719
4738
|
*/
|
|
4720
4739
|
inverse_relationships_enabled: boolean;
|
|
4721
4740
|
singleton_item: ItemData | null;
|
|
@@ -4776,14 +4795,14 @@ export type WorkflowData = {
|
|
|
4776
4795
|
id: WorkflowIdentity;
|
|
4777
4796
|
};
|
|
4778
4797
|
/**
|
|
4779
|
-
* Meta information regarding the
|
|
4798
|
+
* Meta information regarding the model/block model
|
|
4780
4799
|
*
|
|
4781
4800
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4782
4801
|
* via the `definition` "meta".
|
|
4783
4802
|
*/
|
|
4784
4803
|
export type ItemTypeMeta = {
|
|
4785
4804
|
/**
|
|
4786
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4805
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4787
4806
|
*/
|
|
4788
4807
|
has_singleton_item: boolean;
|
|
4789
4808
|
};
|
|
@@ -4795,11 +4814,11 @@ export type ItemTypeMeta = {
|
|
|
4795
4814
|
*/
|
|
4796
4815
|
export type ItemTypeAttributes = {
|
|
4797
4816
|
/**
|
|
4798
|
-
* Name of the model
|
|
4817
|
+
* Name of the model/block model
|
|
4799
4818
|
*/
|
|
4800
4819
|
name: string;
|
|
4801
4820
|
/**
|
|
4802
|
-
* API key of the model
|
|
4821
|
+
* API key of the model/block model
|
|
4803
4822
|
*/
|
|
4804
4823
|
api_key: string;
|
|
4805
4824
|
/**
|
|
@@ -4807,11 +4826,11 @@ export type ItemTypeAttributes = {
|
|
|
4807
4826
|
*/
|
|
4808
4827
|
collection_appeareance?: 'compact' | 'table';
|
|
4809
4828
|
/**
|
|
4810
|
-
* The way the model collection should be presented to the editors
|
|
4829
|
+
* The way the model/block model collection should be presented to the editors
|
|
4811
4830
|
*/
|
|
4812
4831
|
collection_appearance: 'compact' | 'table';
|
|
4813
4832
|
/**
|
|
4814
|
-
* Whether the model is single-instance or not
|
|
4833
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4815
4834
|
*/
|
|
4816
4835
|
singleton: boolean;
|
|
4817
4836
|
/**
|
|
@@ -4819,43 +4838,43 @@ export type ItemTypeAttributes = {
|
|
|
4819
4838
|
*/
|
|
4820
4839
|
all_locales_required: boolean;
|
|
4821
4840
|
/**
|
|
4822
|
-
* Whether editors can sort records via drag & drop or not
|
|
4841
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4823
4842
|
*/
|
|
4824
4843
|
sortable: boolean;
|
|
4825
4844
|
/**
|
|
4826
|
-
* Whether this
|
|
4845
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4827
4846
|
*/
|
|
4828
4847
|
modular_block: boolean;
|
|
4829
4848
|
/**
|
|
4830
|
-
* Whether draft/published mode is active or not
|
|
4849
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4831
4850
|
*/
|
|
4832
4851
|
draft_mode_active: boolean;
|
|
4833
4852
|
/**
|
|
4834
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4853
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4835
4854
|
*/
|
|
4836
4855
|
draft_saving_active: boolean;
|
|
4837
4856
|
/**
|
|
4838
|
-
* Whether editors can organize records in a tree or not
|
|
4857
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4839
4858
|
*/
|
|
4840
4859
|
tree: boolean;
|
|
4841
4860
|
/**
|
|
4842
|
-
* If an ordering field is set, this
|
|
4861
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4843
4862
|
*/
|
|
4844
4863
|
ordering_direction: null | 'asc' | 'desc';
|
|
4845
4864
|
/**
|
|
4846
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4865
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4847
4866
|
*/
|
|
4848
4867
|
ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
4849
4868
|
/**
|
|
4850
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4869
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4851
4870
|
*/
|
|
4852
4871
|
has_singleton_item: boolean;
|
|
4853
4872
|
/**
|
|
4854
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4873
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4855
4874
|
*/
|
|
4856
4875
|
hint: string | null;
|
|
4857
4876
|
/**
|
|
4858
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4877
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4859
4878
|
*/
|
|
4860
4879
|
inverse_relationships_enabled: boolean;
|
|
4861
4880
|
};
|
|
@@ -4885,15 +4904,15 @@ export type ItemTypeCreateSchema = {
|
|
|
4885
4904
|
id?: ItemTypeIdentity;
|
|
4886
4905
|
type?: ItemTypeType;
|
|
4887
4906
|
/**
|
|
4888
|
-
* Name of the model
|
|
4907
|
+
* Name of the model/block model
|
|
4889
4908
|
*/
|
|
4890
4909
|
name: string;
|
|
4891
4910
|
/**
|
|
4892
|
-
* API key of the model
|
|
4911
|
+
* API key of the model/block model
|
|
4893
4912
|
*/
|
|
4894
4913
|
api_key: string;
|
|
4895
4914
|
/**
|
|
4896
|
-
* Whether the model is single-instance or not
|
|
4915
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4897
4916
|
*/
|
|
4898
4917
|
singleton?: boolean;
|
|
4899
4918
|
/**
|
|
@@ -4901,31 +4920,31 @@ export type ItemTypeCreateSchema = {
|
|
|
4901
4920
|
*/
|
|
4902
4921
|
all_locales_required?: boolean;
|
|
4903
4922
|
/**
|
|
4904
|
-
* Whether editors can sort records via drag & drop or not
|
|
4923
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4905
4924
|
*/
|
|
4906
4925
|
sortable?: boolean;
|
|
4907
4926
|
/**
|
|
4908
|
-
* Whether this
|
|
4927
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4909
4928
|
*/
|
|
4910
4929
|
modular_block?: boolean;
|
|
4911
4930
|
/**
|
|
4912
|
-
* Whether draft/published mode is active or not
|
|
4931
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4913
4932
|
*/
|
|
4914
4933
|
draft_mode_active?: boolean;
|
|
4915
4934
|
/**
|
|
4916
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4935
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4917
4936
|
*/
|
|
4918
4937
|
draft_saving_active?: boolean;
|
|
4919
4938
|
/**
|
|
4920
|
-
* Whether editors can organize records in a tree or not
|
|
4939
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4921
4940
|
*/
|
|
4922
4941
|
tree?: boolean;
|
|
4923
4942
|
/**
|
|
4924
|
-
* If an ordering field is set, this
|
|
4943
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4925
4944
|
*/
|
|
4926
4945
|
ordering_direction?: null | 'asc' | 'desc';
|
|
4927
4946
|
/**
|
|
4928
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4947
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4929
4948
|
*/
|
|
4930
4949
|
ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
4931
4950
|
/**
|
|
@@ -4933,15 +4952,15 @@ export type ItemTypeCreateSchema = {
|
|
|
4933
4952
|
*/
|
|
4934
4953
|
collection_appeareance?: 'compact' | 'table';
|
|
4935
4954
|
/**
|
|
4936
|
-
* The way the model collection should be presented to the editors
|
|
4955
|
+
* The way the model/block model collection should be presented to the editors
|
|
4937
4956
|
*/
|
|
4938
4957
|
collection_appearance?: 'compact' | 'table';
|
|
4939
4958
|
/**
|
|
4940
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4959
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4941
4960
|
*/
|
|
4942
4961
|
hint?: string | null;
|
|
4943
4962
|
/**
|
|
4944
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4963
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4945
4964
|
*/
|
|
4946
4965
|
inverse_relationships_enabled?: boolean;
|
|
4947
4966
|
ordering_field?: FieldData | null;
|
|
@@ -4960,11 +4979,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4960
4979
|
id?: ItemTypeIdentity;
|
|
4961
4980
|
type?: ItemTypeType;
|
|
4962
4981
|
/**
|
|
4963
|
-
* Name of the model
|
|
4982
|
+
* Name of the model/block model
|
|
4964
4983
|
*/
|
|
4965
4984
|
name?: string;
|
|
4966
4985
|
/**
|
|
4967
|
-
* API key of the model
|
|
4986
|
+
* API key of the model/block model
|
|
4968
4987
|
*/
|
|
4969
4988
|
api_key?: string;
|
|
4970
4989
|
/**
|
|
@@ -4972,11 +4991,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4972
4991
|
*/
|
|
4973
4992
|
collection_appeareance?: 'compact' | 'table';
|
|
4974
4993
|
/**
|
|
4975
|
-
* The way the model collection should be presented to the editors
|
|
4994
|
+
* The way the model/block model collection should be presented to the editors
|
|
4976
4995
|
*/
|
|
4977
4996
|
collection_appearance?: 'compact' | 'table';
|
|
4978
4997
|
/**
|
|
4979
|
-
* Whether the model is single-instance or not
|
|
4998
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4980
4999
|
*/
|
|
4981
5000
|
singleton?: boolean;
|
|
4982
5001
|
/**
|
|
@@ -4984,43 +5003,43 @@ export type ItemTypeUpdateSchema = {
|
|
|
4984
5003
|
*/
|
|
4985
5004
|
all_locales_required?: boolean;
|
|
4986
5005
|
/**
|
|
4987
|
-
* Whether editors can sort records via drag & drop or not
|
|
5006
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4988
5007
|
*/
|
|
4989
5008
|
sortable?: boolean;
|
|
4990
5009
|
/**
|
|
4991
|
-
* Whether this
|
|
5010
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4992
5011
|
*/
|
|
4993
5012
|
modular_block?: boolean;
|
|
4994
5013
|
/**
|
|
4995
|
-
* Whether draft/published mode is active or not
|
|
5014
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4996
5015
|
*/
|
|
4997
5016
|
draft_mode_active?: boolean;
|
|
4998
5017
|
/**
|
|
4999
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
5018
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
5000
5019
|
*/
|
|
5001
5020
|
draft_saving_active?: boolean;
|
|
5002
5021
|
/**
|
|
5003
|
-
* Whether editors can organize records in a tree or not
|
|
5022
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
5004
5023
|
*/
|
|
5005
5024
|
tree?: boolean;
|
|
5006
5025
|
/**
|
|
5007
|
-
* If an ordering field is set, this
|
|
5026
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
5008
5027
|
*/
|
|
5009
5028
|
ordering_direction?: null | 'asc' | 'desc';
|
|
5010
5029
|
/**
|
|
5011
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
5030
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
5012
5031
|
*/
|
|
5013
5032
|
ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
5014
5033
|
/**
|
|
5015
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
5034
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
5016
5035
|
*/
|
|
5017
5036
|
has_singleton_item?: boolean;
|
|
5018
5037
|
/**
|
|
5019
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
5038
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
5020
5039
|
*/
|
|
5021
5040
|
hint?: string | null;
|
|
5022
5041
|
/**
|
|
5023
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
5042
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
5024
5043
|
*/
|
|
5025
5044
|
inverse_relationships_enabled?: boolean;
|
|
5026
5045
|
ordering_field?: FieldData | null;
|
|
@@ -5032,7 +5051,7 @@ export type ItemTypeUpdateSchema = {
|
|
|
5032
5051
|
workflow?: WorkflowData | null;
|
|
5033
5052
|
meta?: {
|
|
5034
5053
|
/**
|
|
5035
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
5054
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
5036
5055
|
*/
|
|
5037
5056
|
has_singleton_item?: boolean;
|
|
5038
5057
|
};
|
|
@@ -6930,7 +6949,7 @@ export type SubscriptionFeatureAttributes = {
|
|
|
6930
6949
|
enabled: boolean;
|
|
6931
6950
|
};
|
|
6932
6951
|
/**
|
|
6933
|
-
* Represents an event occurred during the deploy process of
|
|
6952
|
+
* Represents an event occurred during the deploy process of a build trigger.
|
|
6934
6953
|
*
|
|
6935
6954
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6936
6955
|
* via the `definition` "build_event".
|
|
@@ -7007,14 +7026,14 @@ export type BuildEventRelationships = {
|
|
|
7007
7026
|
build_trigger: BuildTriggerData;
|
|
7008
7027
|
};
|
|
7009
7028
|
/**
|
|
7010
|
-
* Represents an event occurred during the
|
|
7029
|
+
* Represents an event occurred during the indexing process via search indexes.
|
|
7011
7030
|
*
|
|
7012
7031
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7013
|
-
* via the `definition` "
|
|
7032
|
+
* via the `definition` "search_index_event".
|
|
7014
7033
|
*/
|
|
7015
|
-
export type
|
|
7016
|
-
id:
|
|
7017
|
-
type:
|
|
7034
|
+
export type SearchIndexEvent = {
|
|
7035
|
+
id: SearchIndexEventIdentity;
|
|
7036
|
+
type: SearchIndexEventType;
|
|
7018
7037
|
/**
|
|
7019
7038
|
* The type of activity
|
|
7020
7039
|
*/
|
|
@@ -7029,36 +7048,36 @@ export type SiteSearchSourceEvent = {
|
|
|
7029
7048
|
data: {
|
|
7030
7049
|
[k: string]: unknown;
|
|
7031
7050
|
};
|
|
7032
|
-
|
|
7051
|
+
search_index: SearchIndexData;
|
|
7033
7052
|
};
|
|
7034
|
-
export type
|
|
7053
|
+
export type SearchIndexEventSelfTargetSchema = SearchIndexEvent;
|
|
7035
7054
|
/**
|
|
7036
7055
|
* JSON API data
|
|
7037
7056
|
*
|
|
7038
|
-
* This interface was referenced by `
|
|
7057
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
7039
7058
|
* via the `definition` "data".
|
|
7040
7059
|
*/
|
|
7041
|
-
export type
|
|
7042
|
-
type:
|
|
7043
|
-
id:
|
|
7060
|
+
export type SearchIndexData = {
|
|
7061
|
+
type: SearchIndexType;
|
|
7062
|
+
id: SearchIndexIdentity;
|
|
7044
7063
|
};
|
|
7045
7064
|
/**
|
|
7046
7065
|
* JSON API data
|
|
7047
7066
|
*
|
|
7048
|
-
* This interface was referenced by `
|
|
7067
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
7049
7068
|
* via the `definition` "data".
|
|
7050
7069
|
*/
|
|
7051
|
-
export type
|
|
7052
|
-
type:
|
|
7053
|
-
id:
|
|
7070
|
+
export type SearchIndexEventData = {
|
|
7071
|
+
type: SearchIndexEventType;
|
|
7072
|
+
id: SearchIndexEventIdentity;
|
|
7054
7073
|
};
|
|
7055
7074
|
/**
|
|
7056
7075
|
* JSON API attributes
|
|
7057
7076
|
*
|
|
7058
|
-
* This interface was referenced by `
|
|
7077
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
7059
7078
|
* via the `definition` "attributes".
|
|
7060
7079
|
*/
|
|
7061
|
-
export type
|
|
7080
|
+
export type SearchIndexEventAttributes = {
|
|
7062
7081
|
/**
|
|
7063
7082
|
* The type of activity
|
|
7064
7083
|
*/
|
|
@@ -7077,11 +7096,11 @@ export type SiteSearchSourceEventAttributes = {
|
|
|
7077
7096
|
/**
|
|
7078
7097
|
* JSON API links
|
|
7079
7098
|
*
|
|
7080
|
-
* This interface was referenced by `
|
|
7099
|
+
* This interface was referenced by `SearchIndexEvent`'s JSON-Schema
|
|
7081
7100
|
* via the `definition` "relationships".
|
|
7082
7101
|
*/
|
|
7083
|
-
export type
|
|
7084
|
-
|
|
7102
|
+
export type SearchIndexEventRelationships = {
|
|
7103
|
+
search_index: SearchIndexData;
|
|
7085
7104
|
};
|
|
7086
7105
|
export type ItemCreateTargetSchema<D extends ItemTypeDefinition = ItemTypeDefinition, NestedMode extends boolean = false> = NestedMode extends false ? Item<D> : ItemInNestedResponse<D>;
|
|
7087
7106
|
export type ItemDuplicateJobSchema<D extends ItemTypeDefinition = ItemTypeDefinition, NestedMode extends boolean = false> = NestedMode extends false ? Item<D> : ItemInNestedResponse<D>;
|
|
@@ -8992,6 +9011,10 @@ export type BuildTrigger = {
|
|
|
8992
9011
|
* Name of the build trigger
|
|
8993
9012
|
*/
|
|
8994
9013
|
name: string;
|
|
9014
|
+
/**
|
|
9015
|
+
* Whether the build trigger is enabled or not
|
|
9016
|
+
*/
|
|
9017
|
+
enabled: boolean;
|
|
8995
9018
|
/**
|
|
8996
9019
|
* The type of build trigger
|
|
8997
9020
|
*/
|
|
@@ -9023,7 +9046,7 @@ export type BuildTrigger = {
|
|
|
9023
9046
|
*/
|
|
9024
9047
|
indexing_status: string;
|
|
9025
9048
|
/**
|
|
9026
|
-
* The public URL of the frontend.
|
|
9049
|
+
* The public URL of the frontend.
|
|
9027
9050
|
*/
|
|
9028
9051
|
frontend_url: string | null;
|
|
9029
9052
|
/**
|
|
@@ -9034,10 +9057,6 @@ export type BuildTrigger = {
|
|
|
9034
9057
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9035
9058
|
*/
|
|
9036
9059
|
indexing_enabled: boolean;
|
|
9037
|
-
/**
|
|
9038
|
-
* Whether the build trigger is enabled or not
|
|
9039
|
-
*/
|
|
9040
|
-
enabled: boolean;
|
|
9041
9060
|
};
|
|
9042
9061
|
export type BuildTriggerSelfTargetSchema = BuildTrigger;
|
|
9043
9062
|
export type BuildTriggerCreateTargetSchema = BuildTrigger;
|
|
@@ -9054,6 +9073,10 @@ export type BuildTriggerAttributes = {
|
|
|
9054
9073
|
* Name of the build trigger
|
|
9055
9074
|
*/
|
|
9056
9075
|
name: string;
|
|
9076
|
+
/**
|
|
9077
|
+
* Whether the build trigger is enabled or not
|
|
9078
|
+
*/
|
|
9079
|
+
enabled: boolean;
|
|
9057
9080
|
/**
|
|
9058
9081
|
* The type of build trigger
|
|
9059
9082
|
*/
|
|
@@ -9085,7 +9108,7 @@ export type BuildTriggerAttributes = {
|
|
|
9085
9108
|
*/
|
|
9086
9109
|
indexing_status: string;
|
|
9087
9110
|
/**
|
|
9088
|
-
* The public URL of the frontend.
|
|
9111
|
+
* The public URL of the frontend.
|
|
9089
9112
|
*/
|
|
9090
9113
|
frontend_url: string | null;
|
|
9091
9114
|
/**
|
|
@@ -9096,10 +9119,6 @@ export type BuildTriggerAttributes = {
|
|
|
9096
9119
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9097
9120
|
*/
|
|
9098
9121
|
indexing_enabled: boolean;
|
|
9099
|
-
/**
|
|
9100
|
-
* Whether the build trigger is enabled or not
|
|
9101
|
-
*/
|
|
9102
|
-
enabled: boolean;
|
|
9103
9122
|
};
|
|
9104
9123
|
/**
|
|
9105
9124
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
@@ -9122,13 +9141,13 @@ export type BuildTriggerCreateSchema = {
|
|
|
9122
9141
|
/**
|
|
9123
9142
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9124
9143
|
*/
|
|
9125
|
-
indexing_enabled
|
|
9144
|
+
indexing_enabled?: boolean;
|
|
9126
9145
|
/**
|
|
9127
9146
|
* Whether the build trigger is enabled or not
|
|
9128
9147
|
*/
|
|
9129
9148
|
enabled?: boolean;
|
|
9130
9149
|
/**
|
|
9131
|
-
* The public URL of the frontend.
|
|
9150
|
+
* The public URL of the frontend.
|
|
9132
9151
|
*/
|
|
9133
9152
|
frontend_url: string | null;
|
|
9134
9153
|
/**
|
|
@@ -9166,7 +9185,7 @@ export type BuildTriggerUpdateSchema = {
|
|
|
9166
9185
|
*/
|
|
9167
9186
|
enabled?: boolean;
|
|
9168
9187
|
/**
|
|
9169
|
-
* The public URL of the frontend.
|
|
9188
|
+
* The public URL of the frontend.
|
|
9170
9189
|
*/
|
|
9171
9190
|
frontend_url?: string | null;
|
|
9172
9191
|
/**
|
|
@@ -9181,28 +9200,24 @@ export type BuildTriggerUpdateSchema = {
|
|
|
9181
9200
|
};
|
|
9182
9201
|
};
|
|
9183
9202
|
/**
|
|
9184
|
-
* A
|
|
9203
|
+
* A Search Index is used to index a website to provide DatoCMS Site Search functionality.
|
|
9185
9204
|
*
|
|
9186
9205
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
9187
|
-
* via the `definition` "
|
|
9206
|
+
* via the `definition` "search_index".
|
|
9188
9207
|
*/
|
|
9189
|
-
export type
|
|
9190
|
-
id:
|
|
9191
|
-
type:
|
|
9208
|
+
export type SearchIndex = {
|
|
9209
|
+
id: SearchIndexIdentity;
|
|
9210
|
+
type: SearchIndexType;
|
|
9192
9211
|
/**
|
|
9193
|
-
* Name of the
|
|
9212
|
+
* Name of the search index
|
|
9194
9213
|
*/
|
|
9195
9214
|
name: string;
|
|
9196
9215
|
/**
|
|
9197
|
-
* Whether the
|
|
9216
|
+
* Whether the search index is enabled or not
|
|
9198
9217
|
*/
|
|
9199
9218
|
enabled: boolean;
|
|
9200
9219
|
/**
|
|
9201
|
-
*
|
|
9202
|
-
*/
|
|
9203
|
-
build_trigger_indexing_enabled: boolean;
|
|
9204
|
-
/**
|
|
9205
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9220
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9206
9221
|
*/
|
|
9207
9222
|
frontend_url: string | null;
|
|
9208
9223
|
/**
|
|
@@ -9210,21 +9225,21 @@ export type SiteSearchSource = {
|
|
|
9210
9225
|
*/
|
|
9211
9226
|
user_agent_suffix: string | null;
|
|
9212
9227
|
build_triggers: BuildTriggerData[];
|
|
9213
|
-
meta:
|
|
9228
|
+
meta: SearchIndexMeta;
|
|
9214
9229
|
};
|
|
9215
|
-
export type
|
|
9216
|
-
export type
|
|
9217
|
-
export type
|
|
9218
|
-
export type
|
|
9230
|
+
export type SearchIndexSelfTargetSchema = SearchIndex;
|
|
9231
|
+
export type SearchIndexCreateTargetSchema = SearchIndex;
|
|
9232
|
+
export type SearchIndexUpdateTargetSchema = SearchIndex;
|
|
9233
|
+
export type SearchIndexDestroyTargetSchema = SearchIndex;
|
|
9219
9234
|
/**
|
|
9220
|
-
* Meta information about the
|
|
9235
|
+
* Meta information about the search index
|
|
9221
9236
|
*
|
|
9222
|
-
* This interface was referenced by `
|
|
9237
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
9223
9238
|
* via the `definition` "meta".
|
|
9224
9239
|
*/
|
|
9225
|
-
export type
|
|
9240
|
+
export type SearchIndexMeta = {
|
|
9226
9241
|
/**
|
|
9227
|
-
* Status of the
|
|
9242
|
+
* Status of the search indexing
|
|
9228
9243
|
*/
|
|
9229
9244
|
indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
|
|
9230
9245
|
/**
|
|
@@ -9235,24 +9250,20 @@ export type SiteSearchSourceMeta = {
|
|
|
9235
9250
|
/**
|
|
9236
9251
|
* JSON API attributes
|
|
9237
9252
|
*
|
|
9238
|
-
* This interface was referenced by `
|
|
9253
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
9239
9254
|
* via the `definition` "attributes".
|
|
9240
9255
|
*/
|
|
9241
|
-
export type
|
|
9256
|
+
export type SearchIndexAttributes = {
|
|
9242
9257
|
/**
|
|
9243
|
-
* Name of the
|
|
9258
|
+
* Name of the search index
|
|
9244
9259
|
*/
|
|
9245
9260
|
name: string;
|
|
9246
9261
|
/**
|
|
9247
|
-
* Whether the
|
|
9262
|
+
* Whether the search index is enabled or not
|
|
9248
9263
|
*/
|
|
9249
9264
|
enabled: boolean;
|
|
9250
9265
|
/**
|
|
9251
|
-
*
|
|
9252
|
-
*/
|
|
9253
|
-
build_trigger_indexing_enabled: boolean;
|
|
9254
|
-
/**
|
|
9255
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9266
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9256
9267
|
*/
|
|
9257
9268
|
frontend_url: string | null;
|
|
9258
9269
|
/**
|
|
@@ -9263,32 +9274,28 @@ export type SiteSearchSourceAttributes = {
|
|
|
9263
9274
|
/**
|
|
9264
9275
|
* JSON API links
|
|
9265
9276
|
*
|
|
9266
|
-
* This interface was referenced by `
|
|
9277
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
9267
9278
|
* via the `definition` "relationships".
|
|
9268
9279
|
*/
|
|
9269
|
-
export type
|
|
9280
|
+
export type SearchIndexRelationships = {
|
|
9270
9281
|
build_triggers: BuildTriggerData[];
|
|
9271
9282
|
};
|
|
9272
9283
|
/**
|
|
9273
|
-
* This interface was referenced by `
|
|
9284
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
9274
9285
|
* via the `create.schema` link.
|
|
9275
9286
|
*/
|
|
9276
|
-
export type
|
|
9277
|
-
type?:
|
|
9287
|
+
export type SearchIndexCreateSchema = {
|
|
9288
|
+
type?: SearchIndexType;
|
|
9278
9289
|
/**
|
|
9279
|
-
* Name of the
|
|
9290
|
+
* Name of the search index
|
|
9280
9291
|
*/
|
|
9281
9292
|
name: string;
|
|
9282
9293
|
/**
|
|
9283
|
-
* Whether the
|
|
9294
|
+
* Whether the search index is enabled or not
|
|
9284
9295
|
*/
|
|
9285
9296
|
enabled: boolean;
|
|
9286
9297
|
/**
|
|
9287
|
-
*
|
|
9288
|
-
*/
|
|
9289
|
-
build_trigger_indexing_enabled?: boolean;
|
|
9290
|
-
/**
|
|
9291
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9298
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9292
9299
|
*/
|
|
9293
9300
|
frontend_url: string | null;
|
|
9294
9301
|
/**
|
|
@@ -9298,26 +9305,22 @@ export type SiteSearchSourceCreateSchema = {
|
|
|
9298
9305
|
build_triggers?: BuildTriggerData[];
|
|
9299
9306
|
};
|
|
9300
9307
|
/**
|
|
9301
|
-
* This interface was referenced by `
|
|
9308
|
+
* This interface was referenced by `SearchIndex`'s JSON-Schema
|
|
9302
9309
|
* via the `update.schema` link.
|
|
9303
9310
|
*/
|
|
9304
|
-
export type
|
|
9305
|
-
id?:
|
|
9306
|
-
type?:
|
|
9311
|
+
export type SearchIndexUpdateSchema = {
|
|
9312
|
+
id?: SearchIndexIdentity;
|
|
9313
|
+
type?: SearchIndexType;
|
|
9307
9314
|
/**
|
|
9308
|
-
* Name of the
|
|
9315
|
+
* Name of the search index
|
|
9309
9316
|
*/
|
|
9310
9317
|
name?: string;
|
|
9311
9318
|
/**
|
|
9312
|
-
* Whether the
|
|
9319
|
+
* Whether the search index is enabled or not
|
|
9313
9320
|
*/
|
|
9314
9321
|
enabled?: boolean;
|
|
9315
9322
|
/**
|
|
9316
|
-
*
|
|
9317
|
-
*/
|
|
9318
|
-
build_trigger_indexing_enabled?: boolean;
|
|
9319
|
-
/**
|
|
9320
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9323
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9321
9324
|
*/
|
|
9322
9325
|
frontend_url?: string | null;
|
|
9323
9326
|
/**
|