@datocms/cma-client 5.2.0-alpha.2 → 5.2.0-alpha.4
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/dist/cjs/generated/Client.js +3 -3
- package/dist/cjs/generated/Client.js.map +1 -1
- 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} +55 -53
- 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/esm/generated/ApiTypes.d.ts +147 -131
- 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 +148 -136
- package/dist/esm/generated/resources/Role.js +8 -8
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/{SiteSearchSource.d.ts → SearchIndex.d.ts} +40 -40
- package/dist/esm/generated/resources/{SiteSearchSource.js → SearchIndex.js} +54 -52
- 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/types/generated/ApiTypes.d.ts +147 -131
- package/dist/types/generated/Client.d.ts +2 -2
- package/dist/types/generated/RawApiTypes.d.ts +148 -136
- package/dist/types/generated/resources/{SiteSearchSource.d.ts → SearchIndex.d.ts} +40 -40
- package/dist/types/generated/resources/SearchIndexEvent.d.ts +61 -0
- package/dist/types/generated/resources/index.d.ts +2 -2
- package/package.json +3 -3
- package/resources.json +79 -77
- package/src/generated/ApiTypes.ts +148 -133
- package/src/generated/Client.ts +5 -5
- package/src/generated/RawApiTypes.ts +149 -137
- package/src/generated/resources/Role.ts +8 -8
- package/src/generated/resources/SearchIndex.ts +255 -0
- package/src/generated/resources/{SiteSearchSourceEvent.ts → SearchIndexEvent.ts} +32 -34
- package/src/generated/resources/index.ts +2 -2
- 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.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/SiteSearchSourceEvent.d.ts +0 -61
- package/src/generated/resources/SiteSearchSource.ts +0 -265
|
@@ -1,132 +1,132 @@
|
|
|
1
1
|
import BaseResource from '../../BaseResource';
|
|
2
2
|
import type * as ApiTypes from '../ApiTypes';
|
|
3
3
|
import type * as RawApiTypes from '../RawApiTypes';
|
|
4
|
-
export default class
|
|
5
|
-
static readonly TYPE: "
|
|
4
|
+
export default class SearchIndex extends BaseResource {
|
|
5
|
+
static readonly TYPE: "search_index";
|
|
6
6
|
/**
|
|
7
|
-
* List all
|
|
7
|
+
* List all search indexes for a site
|
|
8
8
|
*
|
|
9
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
9
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
|
|
10
10
|
*
|
|
11
11
|
* @throws {ApiError}
|
|
12
12
|
* @throws {TimeoutError}
|
|
13
13
|
*/
|
|
14
|
-
list(): Promise<ApiTypes.
|
|
14
|
+
list(): Promise<ApiTypes.SearchIndexInstancesTargetSchema>;
|
|
15
15
|
/**
|
|
16
|
-
* List all
|
|
16
|
+
* List all search indexes for a site
|
|
17
17
|
*
|
|
18
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
18
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
|
|
19
19
|
*
|
|
20
20
|
* @throws {ApiError}
|
|
21
21
|
* @throws {TimeoutError}
|
|
22
22
|
*/
|
|
23
|
-
rawList(): Promise<RawApiTypes.
|
|
23
|
+
rawList(): Promise<RawApiTypes.SearchIndexInstancesTargetSchema>;
|
|
24
24
|
/**
|
|
25
|
-
* Retrieve a
|
|
25
|
+
* Retrieve a search index
|
|
26
26
|
*
|
|
27
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
27
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
|
|
28
28
|
*
|
|
29
29
|
* @throws {ApiError}
|
|
30
30
|
* @throws {TimeoutError}
|
|
31
31
|
*/
|
|
32
|
-
find(
|
|
32
|
+
find(searchIndexId: string | ApiTypes.SearchIndexData): Promise<ApiTypes.SearchIndex>;
|
|
33
33
|
/**
|
|
34
|
-
* Retrieve a
|
|
34
|
+
* Retrieve a search index
|
|
35
35
|
*
|
|
36
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
36
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
|
|
37
37
|
*
|
|
38
38
|
* @throws {ApiError}
|
|
39
39
|
* @throws {TimeoutError}
|
|
40
40
|
*/
|
|
41
|
-
rawFind(
|
|
41
|
+
rawFind(searchIndexId: string): Promise<RawApiTypes.SearchIndexSelfTargetSchema>;
|
|
42
42
|
/**
|
|
43
|
-
* Create
|
|
43
|
+
* Create search index
|
|
44
44
|
*
|
|
45
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
45
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
|
|
46
46
|
*
|
|
47
47
|
* @throws {ApiError}
|
|
48
48
|
* @throws {TimeoutError}
|
|
49
49
|
*/
|
|
50
|
-
create(body: ApiTypes.
|
|
50
|
+
create(body: ApiTypes.SearchIndexCreateSchema): Promise<ApiTypes.SearchIndex>;
|
|
51
51
|
/**
|
|
52
|
-
* Create
|
|
52
|
+
* Create search index
|
|
53
53
|
*
|
|
54
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
54
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
|
|
55
55
|
*
|
|
56
56
|
* @throws {ApiError}
|
|
57
57
|
* @throws {TimeoutError}
|
|
58
58
|
*/
|
|
59
|
-
rawCreate(body: RawApiTypes.
|
|
59
|
+
rawCreate(body: RawApiTypes.SearchIndexCreateSchema): Promise<RawApiTypes.SearchIndexCreateTargetSchema>;
|
|
60
60
|
/**
|
|
61
|
-
* Update
|
|
61
|
+
* Update search index
|
|
62
62
|
*
|
|
63
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
63
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
|
|
64
64
|
*
|
|
65
65
|
* @throws {ApiError}
|
|
66
66
|
* @throws {TimeoutError}
|
|
67
67
|
*/
|
|
68
|
-
update(
|
|
68
|
+
update(searchIndexId: string | ApiTypes.SearchIndexData, body: ApiTypes.SearchIndexUpdateSchema): Promise<ApiTypes.SearchIndex>;
|
|
69
69
|
/**
|
|
70
|
-
* Update
|
|
70
|
+
* Update search index
|
|
71
71
|
*
|
|
72
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
72
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
|
|
73
73
|
*
|
|
74
74
|
* @throws {ApiError}
|
|
75
75
|
* @throws {TimeoutError}
|
|
76
76
|
*/
|
|
77
|
-
rawUpdate(
|
|
77
|
+
rawUpdate(searchIndexId: string, body: RawApiTypes.SearchIndexUpdateSchema): Promise<RawApiTypes.SearchIndexUpdateTargetSchema>;
|
|
78
78
|
/**
|
|
79
79
|
* Trigger a site search indexing
|
|
80
80
|
*
|
|
81
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
81
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
|
|
82
82
|
*
|
|
83
83
|
* @throws {ApiError}
|
|
84
84
|
* @throws {TimeoutError}
|
|
85
85
|
*/
|
|
86
|
-
trigger(
|
|
86
|
+
trigger(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
|
|
87
87
|
/**
|
|
88
88
|
* Trigger a site search indexing
|
|
89
89
|
*
|
|
90
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
90
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
|
|
91
91
|
*
|
|
92
92
|
* @throws {ApiError}
|
|
93
93
|
* @throws {TimeoutError}
|
|
94
94
|
*/
|
|
95
|
-
rawTrigger(
|
|
95
|
+
rawTrigger(searchIndexId: string): Promise<void>;
|
|
96
96
|
/**
|
|
97
97
|
* Abort a site search spidering and mark it as failed
|
|
98
98
|
*
|
|
99
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
99
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
|
|
100
100
|
*
|
|
101
101
|
* @throws {ApiError}
|
|
102
102
|
* @throws {TimeoutError}
|
|
103
103
|
*/
|
|
104
|
-
abort(
|
|
104
|
+
abort(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
|
|
105
105
|
/**
|
|
106
106
|
* Abort a site search spidering and mark it as failed
|
|
107
107
|
*
|
|
108
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
108
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
|
|
109
109
|
*
|
|
110
110
|
* @throws {ApiError}
|
|
111
111
|
* @throws {TimeoutError}
|
|
112
112
|
*/
|
|
113
|
-
rawAbort(
|
|
113
|
+
rawAbort(searchIndexId: string): Promise<void>;
|
|
114
114
|
/**
|
|
115
|
-
* Delete a
|
|
115
|
+
* Delete a search index
|
|
116
116
|
*
|
|
117
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
117
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
|
|
118
118
|
*
|
|
119
119
|
* @throws {ApiError}
|
|
120
120
|
* @throws {TimeoutError}
|
|
121
121
|
*/
|
|
122
|
-
destroy(
|
|
122
|
+
destroy(searchIndexId: string | ApiTypes.SearchIndexData): Promise<ApiTypes.SearchIndex>;
|
|
123
123
|
/**
|
|
124
|
-
* Delete a
|
|
124
|
+
* Delete a search index
|
|
125
125
|
*
|
|
126
|
-
* Read more: https://www.datocms.com/docs/content-management-api/resources/
|
|
126
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
|
|
127
127
|
*
|
|
128
128
|
* @throws {ApiError}
|
|
129
129
|
* @throws {TimeoutError}
|
|
130
130
|
*/
|
|
131
|
-
rawDestroy(
|
|
131
|
+
rawDestroy(searchIndexId: string): Promise<RawApiTypes.SearchIndexDestroyTargetSchema>;
|
|
132
132
|
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import * as Utils from '@datocms/rest-client-utils';
|
|
2
|
+
import BaseResource from '../../BaseResource';
|
|
3
|
+
import type * as ApiTypes from '../ApiTypes';
|
|
4
|
+
import type * as RawApiTypes from '../RawApiTypes';
|
|
5
|
+
export default class SearchIndexEvent extends BaseResource {
|
|
6
|
+
static readonly TYPE: "search_index_event";
|
|
7
|
+
/**
|
|
8
|
+
* List all search indexing events
|
|
9
|
+
*
|
|
10
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
|
|
11
|
+
*
|
|
12
|
+
* @throws {ApiError}
|
|
13
|
+
* @throws {TimeoutError}
|
|
14
|
+
*/
|
|
15
|
+
list(queryParams?: ApiTypes.SearchIndexEventInstancesHrefSchema): Promise<ApiTypes.SearchIndexEventInstancesTargetSchema>;
|
|
16
|
+
/**
|
|
17
|
+
* List all search indexing events
|
|
18
|
+
*
|
|
19
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
|
|
20
|
+
*
|
|
21
|
+
* @throws {ApiError}
|
|
22
|
+
* @throws {TimeoutError}
|
|
23
|
+
*/
|
|
24
|
+
rawList(queryParams?: RawApiTypes.SearchIndexEventInstancesHrefSchema): Promise<RawApiTypes.SearchIndexEventInstancesTargetSchema>;
|
|
25
|
+
/**
|
|
26
|
+
* Async iterator to auto-paginate over elements returned by list()
|
|
27
|
+
*
|
|
28
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
32
|
+
*/
|
|
33
|
+
listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.SearchIndexEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.SearchIndexEvent, void, unknown>;
|
|
34
|
+
/**
|
|
35
|
+
* Async iterator to auto-paginate over elements returned by rawList()
|
|
36
|
+
*
|
|
37
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
|
|
38
|
+
*
|
|
39
|
+
* @throws {ApiError}
|
|
40
|
+
* @throws {TimeoutError}
|
|
41
|
+
*/
|
|
42
|
+
rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.SearchIndexEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.SearchIndexEvent, void, unknown>;
|
|
43
|
+
/**
|
|
44
|
+
* Retrieve a search indexing event
|
|
45
|
+
*
|
|
46
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
|
|
47
|
+
*
|
|
48
|
+
* @throws {ApiError}
|
|
49
|
+
* @throws {TimeoutError}
|
|
50
|
+
*/
|
|
51
|
+
find(searchIndexEventId: string | ApiTypes.SearchIndexEventData): Promise<ApiTypes.SearchIndexEvent>;
|
|
52
|
+
/**
|
|
53
|
+
* Retrieve a search indexing event
|
|
54
|
+
*
|
|
55
|
+
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
|
|
56
|
+
*
|
|
57
|
+
* @throws {ApiError}
|
|
58
|
+
* @throws {TimeoutError}
|
|
59
|
+
*/
|
|
60
|
+
rawFind(searchIndexEventId: string): Promise<RawApiTypes.SearchIndexEventSelfTargetSchema>;
|
|
61
|
+
}
|
|
@@ -15,7 +15,7 @@ export { default as JobResult } from './JobResult';
|
|
|
15
15
|
export { default as SubscriptionLimit } from './SubscriptionLimit';
|
|
16
16
|
export { default as SubscriptionFeature } from './SubscriptionFeature';
|
|
17
17
|
export { default as BuildEvent } from './BuildEvent';
|
|
18
|
-
export { default as
|
|
18
|
+
export { default as SearchIndexEvent } from './SearchIndexEvent';
|
|
19
19
|
export { default as Item } from './Item';
|
|
20
20
|
export { default as ItemVersion } from './ItemVersion';
|
|
21
21
|
export { default as Upload } from './Upload';
|
|
@@ -29,7 +29,7 @@ export { default as MaintenanceMode } from './MaintenanceMode';
|
|
|
29
29
|
export { default as Webhook } from './Webhook';
|
|
30
30
|
export { default as WebhookCall } from './WebhookCall';
|
|
31
31
|
export { default as BuildTrigger } from './BuildTrigger';
|
|
32
|
-
export { default as
|
|
32
|
+
export { default as SearchIndex } from './SearchIndex';
|
|
33
33
|
export { default as ItemTypeFilter } from './ItemTypeFilter';
|
|
34
34
|
export { default as UploadFilter } from './UploadFilter';
|
|
35
35
|
export { default as SiteInvitation } from './SiteInvitation';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@datocms/cma-client",
|
|
3
|
-
"version": "5.2.0-alpha.
|
|
3
|
+
"version": "5.2.0-alpha.4",
|
|
4
4
|
"description": "JS client for DatoCMS REST Content Management API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"uuid": "^9.0.1"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
-
"@datocms/dashboard-client": "^5.2.0-alpha.
|
|
45
|
+
"@datocms/dashboard-client": "^5.2.0-alpha.4",
|
|
46
46
|
"@types/uuid": "^9.0.7"
|
|
47
47
|
},
|
|
48
|
-
"gitHead": "
|
|
48
|
+
"gitHead": "319efa216e04297104dc7278ef514c7a8ab10355"
|
|
49
49
|
}
|
package/resources.json
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"environments_access",
|
|
28
28
|
"can_manage_users",
|
|
29
29
|
"can_manage_shared_filters",
|
|
30
|
-
"
|
|
30
|
+
"can_manage_search_indexes",
|
|
31
31
|
"can_manage_upload_collections",
|
|
32
32
|
"can_manage_build_triggers",
|
|
33
33
|
"can_manage_webhooks",
|
|
@@ -38,15 +38,15 @@
|
|
|
38
38
|
"can_manage_access_tokens",
|
|
39
39
|
"can_perform_site_search",
|
|
40
40
|
"can_access_build_events_log",
|
|
41
|
-
"
|
|
41
|
+
"can_access_search_index_events_log",
|
|
42
42
|
"positive_item_type_permissions",
|
|
43
43
|
"negative_item_type_permissions",
|
|
44
44
|
"positive_upload_permissions",
|
|
45
45
|
"negative_upload_permissions",
|
|
46
46
|
"positive_build_trigger_permissions",
|
|
47
47
|
"negative_build_trigger_permissions",
|
|
48
|
-
"
|
|
49
|
-
"
|
|
48
|
+
"positive_search_index_permissions",
|
|
49
|
+
"negative_search_index_permissions"
|
|
50
50
|
],
|
|
51
51
|
"relationships": ["inherits_permissions_from"]
|
|
52
52
|
},
|
|
@@ -92,7 +92,7 @@
|
|
|
92
92
|
"environments_access",
|
|
93
93
|
"can_manage_users",
|
|
94
94
|
"can_manage_shared_filters",
|
|
95
|
-
"
|
|
95
|
+
"can_manage_search_indexes",
|
|
96
96
|
"can_manage_upload_collections",
|
|
97
97
|
"can_manage_build_triggers",
|
|
98
98
|
"can_manage_webhooks",
|
|
@@ -103,15 +103,15 @@
|
|
|
103
103
|
"can_manage_access_tokens",
|
|
104
104
|
"can_perform_site_search",
|
|
105
105
|
"can_access_build_events_log",
|
|
106
|
-
"
|
|
106
|
+
"can_access_search_index_events_log",
|
|
107
107
|
"positive_item_type_permissions",
|
|
108
108
|
"negative_item_type_permissions",
|
|
109
109
|
"positive_upload_permissions",
|
|
110
110
|
"negative_upload_permissions",
|
|
111
111
|
"positive_build_trigger_permissions",
|
|
112
112
|
"negative_build_trigger_permissions",
|
|
113
|
-
"
|
|
114
|
-
"
|
|
113
|
+
"positive_search_index_permissions",
|
|
114
|
+
"negative_search_index_permissions"
|
|
115
115
|
],
|
|
116
116
|
"relationships": ["inherits_permissions_from"]
|
|
117
117
|
},
|
|
@@ -2159,22 +2159,22 @@
|
|
|
2159
2159
|
"resourceClassName": "BuildEvent"
|
|
2160
2160
|
},
|
|
2161
2161
|
{
|
|
2162
|
-
"jsonApiType": "
|
|
2162
|
+
"jsonApiType": "search_index_event",
|
|
2163
2163
|
"endpoints": [
|
|
2164
2164
|
{
|
|
2165
2165
|
"returnsItem": false,
|
|
2166
2166
|
"requestBodyRequiresItem": false,
|
|
2167
2167
|
"offersNestedItemsOptionInQueryParams": false,
|
|
2168
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
2168
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances",
|
|
2169
2169
|
"rel": "instances",
|
|
2170
|
-
"urlTemplate": "/
|
|
2170
|
+
"urlTemplate": "/search-index-events",
|
|
2171
2171
|
"method": "GET",
|
|
2172
|
-
"comment": "List all
|
|
2172
|
+
"comment": "List all search indexing events",
|
|
2173
2173
|
"urlPlaceholders": [],
|
|
2174
2174
|
"optionalRequestBody": false,
|
|
2175
|
-
"queryParamsType": "
|
|
2175
|
+
"queryParamsType": "SearchIndexEventInstancesHrefSchema",
|
|
2176
2176
|
"queryParamsRequired": false,
|
|
2177
|
-
"responseType": "
|
|
2177
|
+
"responseType": "SearchIndexEventInstancesTargetSchema",
|
|
2178
2178
|
"paginatedResponse": {
|
|
2179
2179
|
"defaultLimit": 30,
|
|
2180
2180
|
"maxLimit": 500
|
|
@@ -2186,32 +2186,32 @@
|
|
|
2186
2186
|
"returnsItem": false,
|
|
2187
2187
|
"requestBodyRequiresItem": false,
|
|
2188
2188
|
"offersNestedItemsOptionInQueryParams": false,
|
|
2189
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
2189
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index_event/self",
|
|
2190
2190
|
"rel": "self",
|
|
2191
|
-
"urlTemplate": "/
|
|
2191
|
+
"urlTemplate": "/search-index-events/${searchIndexEventId}",
|
|
2192
2192
|
"method": "GET",
|
|
2193
|
-
"comment": "Retrieve a
|
|
2193
|
+
"comment": "Retrieve a search indexing event",
|
|
2194
2194
|
"urlPlaceholders": [
|
|
2195
2195
|
{
|
|
2196
|
-
"variableName": "
|
|
2196
|
+
"variableName": "searchIndexEventId",
|
|
2197
2197
|
"isEntityId": true,
|
|
2198
|
-
"relType": "
|
|
2198
|
+
"relType": "SearchIndexEventData"
|
|
2199
2199
|
}
|
|
2200
2200
|
],
|
|
2201
2201
|
"entityIdPlaceholder": {
|
|
2202
|
-
"variableName": "
|
|
2202
|
+
"variableName": "searchIndexEventId",
|
|
2203
2203
|
"isEntityId": true,
|
|
2204
|
-
"relType": "
|
|
2204
|
+
"relType": "SearchIndexEventData"
|
|
2205
2205
|
},
|
|
2206
2206
|
"optionalRequestBody": false,
|
|
2207
2207
|
"queryParamsRequired": false,
|
|
2208
|
-
"responseType": "
|
|
2208
|
+
"responseType": "SearchIndexEventSelfTargetSchema",
|
|
2209
2209
|
"name": "find",
|
|
2210
2210
|
"rawName": "rawFind"
|
|
2211
2211
|
}
|
|
2212
2212
|
],
|
|
2213
|
-
"namespace": "
|
|
2214
|
-
"resourceClassName": "
|
|
2213
|
+
"namespace": "searchIndexEvents",
|
|
2214
|
+
"resourceClassName": "SearchIndexEvent"
|
|
2215
2215
|
},
|
|
2216
2216
|
{
|
|
2217
2217
|
"jsonApiType": "item",
|
|
@@ -4000,21 +4000,21 @@
|
|
|
4000
4000
|
"resourceClassName": "BuildTrigger"
|
|
4001
4001
|
},
|
|
4002
4002
|
{
|
|
4003
|
-
"jsonApiType": "
|
|
4003
|
+
"jsonApiType": "search_index",
|
|
4004
4004
|
"endpoints": [
|
|
4005
4005
|
{
|
|
4006
4006
|
"returnsItem": false,
|
|
4007
4007
|
"requestBodyRequiresItem": false,
|
|
4008
4008
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4009
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4009
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/instances",
|
|
4010
4010
|
"rel": "instances",
|
|
4011
|
-
"urlTemplate": "/
|
|
4011
|
+
"urlTemplate": "/search-indexes",
|
|
4012
4012
|
"method": "GET",
|
|
4013
|
-
"comment": "List all
|
|
4013
|
+
"comment": "List all search indexes for a site",
|
|
4014
4014
|
"urlPlaceholders": [],
|
|
4015
4015
|
"optionalRequestBody": false,
|
|
4016
4016
|
"queryParamsRequired": false,
|
|
4017
|
-
"responseType": "
|
|
4017
|
+
"responseType": "SearchIndexInstancesTargetSchema",
|
|
4018
4018
|
"name": "list",
|
|
4019
4019
|
"rawName": "rawList"
|
|
4020
4020
|
},
|
|
@@ -4022,26 +4022,26 @@
|
|
|
4022
4022
|
"returnsItem": false,
|
|
4023
4023
|
"requestBodyRequiresItem": false,
|
|
4024
4024
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4025
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4025
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/self",
|
|
4026
4026
|
"rel": "self",
|
|
4027
|
-
"urlTemplate": "/
|
|
4027
|
+
"urlTemplate": "/search-indexes/${searchIndexId}",
|
|
4028
4028
|
"method": "GET",
|
|
4029
|
-
"comment": "Retrieve a
|
|
4029
|
+
"comment": "Retrieve a search index",
|
|
4030
4030
|
"urlPlaceholders": [
|
|
4031
4031
|
{
|
|
4032
|
-
"variableName": "
|
|
4032
|
+
"variableName": "searchIndexId",
|
|
4033
4033
|
"isEntityId": true,
|
|
4034
|
-
"relType": "
|
|
4034
|
+
"relType": "SearchIndexData"
|
|
4035
4035
|
}
|
|
4036
4036
|
],
|
|
4037
4037
|
"entityIdPlaceholder": {
|
|
4038
|
-
"variableName": "
|
|
4038
|
+
"variableName": "searchIndexId",
|
|
4039
4039
|
"isEntityId": true,
|
|
4040
|
-
"relType": "
|
|
4040
|
+
"relType": "SearchIndexData"
|
|
4041
4041
|
},
|
|
4042
4042
|
"optionalRequestBody": false,
|
|
4043
4043
|
"queryParamsRequired": false,
|
|
4044
|
-
"responseType": "
|
|
4044
|
+
"responseType": "SearchIndexSelfTargetSchema",
|
|
4045
4045
|
"name": "find",
|
|
4046
4046
|
"rawName": "rawFind"
|
|
4047
4047
|
},
|
|
@@ -4049,26 +4049,27 @@
|
|
|
4049
4049
|
"returnsItem": false,
|
|
4050
4050
|
"requestBodyRequiresItem": false,
|
|
4051
4051
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4052
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4052
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/create",
|
|
4053
4053
|
"rel": "create",
|
|
4054
|
-
"urlTemplate": "/
|
|
4054
|
+
"urlTemplate": "/search-indexes",
|
|
4055
4055
|
"method": "POST",
|
|
4056
|
-
"comment": "Create
|
|
4056
|
+
"comment": "Create search index",
|
|
4057
4057
|
"urlPlaceholders": [],
|
|
4058
|
-
"requestBodyType": "
|
|
4058
|
+
"requestBodyType": "SearchIndexCreateSchema",
|
|
4059
4059
|
"optionalRequestBody": false,
|
|
4060
4060
|
"requestStructure": {
|
|
4061
|
-
"type": "
|
|
4061
|
+
"type": "search_index",
|
|
4062
4062
|
"attributes": [
|
|
4063
4063
|
"name",
|
|
4064
4064
|
"enabled",
|
|
4065
4065
|
"build_trigger_indexing_enabled",
|
|
4066
|
-
"frontend_url"
|
|
4066
|
+
"frontend_url",
|
|
4067
|
+
"user_agent_suffix"
|
|
4067
4068
|
],
|
|
4068
4069
|
"relationships": ["build_triggers"]
|
|
4069
4070
|
},
|
|
4070
4071
|
"queryParamsRequired": false,
|
|
4071
|
-
"responseType": "
|
|
4072
|
+
"responseType": "SearchIndexCreateTargetSchema",
|
|
4072
4073
|
"name": "create",
|
|
4073
4074
|
"rawName": "rawCreate"
|
|
4074
4075
|
},
|
|
@@ -4076,38 +4077,39 @@
|
|
|
4076
4077
|
"returnsItem": false,
|
|
4077
4078
|
"requestBodyRequiresItem": false,
|
|
4078
4079
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4079
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4080
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/update",
|
|
4080
4081
|
"rel": "update",
|
|
4081
|
-
"urlTemplate": "/
|
|
4082
|
+
"urlTemplate": "/search-indexes/${searchIndexId}",
|
|
4082
4083
|
"method": "PUT",
|
|
4083
|
-
"comment": "Update
|
|
4084
|
+
"comment": "Update search index",
|
|
4084
4085
|
"urlPlaceholders": [
|
|
4085
4086
|
{
|
|
4086
|
-
"variableName": "
|
|
4087
|
+
"variableName": "searchIndexId",
|
|
4087
4088
|
"isEntityId": true,
|
|
4088
|
-
"relType": "
|
|
4089
|
+
"relType": "SearchIndexData"
|
|
4089
4090
|
}
|
|
4090
4091
|
],
|
|
4091
4092
|
"entityIdPlaceholder": {
|
|
4092
|
-
"variableName": "
|
|
4093
|
+
"variableName": "searchIndexId",
|
|
4093
4094
|
"isEntityId": true,
|
|
4094
|
-
"relType": "
|
|
4095
|
+
"relType": "SearchIndexData"
|
|
4095
4096
|
},
|
|
4096
|
-
"requestBodyType": "
|
|
4097
|
+
"requestBodyType": "SearchIndexUpdateSchema",
|
|
4097
4098
|
"optionalRequestBody": false,
|
|
4098
4099
|
"requestStructure": {
|
|
4099
|
-
"type": "
|
|
4100
|
+
"type": "search_index",
|
|
4100
4101
|
"idRequired": true,
|
|
4101
4102
|
"attributes": [
|
|
4102
4103
|
"name",
|
|
4103
4104
|
"enabled",
|
|
4104
4105
|
"build_trigger_indexing_enabled",
|
|
4105
|
-
"frontend_url"
|
|
4106
|
+
"frontend_url",
|
|
4107
|
+
"user_agent_suffix"
|
|
4106
4108
|
],
|
|
4107
4109
|
"relationships": ["build_triggers"]
|
|
4108
4110
|
},
|
|
4109
4111
|
"queryParamsRequired": false,
|
|
4110
|
-
"responseType": "
|
|
4112
|
+
"responseType": "SearchIndexUpdateTargetSchema",
|
|
4111
4113
|
"name": "update",
|
|
4112
4114
|
"rawName": "rawUpdate"
|
|
4113
4115
|
},
|
|
@@ -4115,22 +4117,22 @@
|
|
|
4115
4117
|
"returnsItem": false,
|
|
4116
4118
|
"requestBodyRequiresItem": false,
|
|
4117
4119
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4118
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4120
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/trigger",
|
|
4119
4121
|
"rel": "trigger",
|
|
4120
|
-
"urlTemplate": "/
|
|
4122
|
+
"urlTemplate": "/search-indexes/${searchIndexId}/trigger",
|
|
4121
4123
|
"method": "POST",
|
|
4122
4124
|
"comment": "Trigger a site search indexing",
|
|
4123
4125
|
"urlPlaceholders": [
|
|
4124
4126
|
{
|
|
4125
|
-
"variableName": "
|
|
4127
|
+
"variableName": "searchIndexId",
|
|
4126
4128
|
"isEntityId": true,
|
|
4127
|
-
"relType": "
|
|
4129
|
+
"relType": "SearchIndexData"
|
|
4128
4130
|
}
|
|
4129
4131
|
],
|
|
4130
4132
|
"entityIdPlaceholder": {
|
|
4131
|
-
"variableName": "
|
|
4133
|
+
"variableName": "searchIndexId",
|
|
4132
4134
|
"isEntityId": true,
|
|
4133
|
-
"relType": "
|
|
4135
|
+
"relType": "SearchIndexData"
|
|
4134
4136
|
},
|
|
4135
4137
|
"optionalRequestBody": false,
|
|
4136
4138
|
"queryParamsRequired": false,
|
|
@@ -4141,22 +4143,22 @@
|
|
|
4141
4143
|
"returnsItem": false,
|
|
4142
4144
|
"requestBodyRequiresItem": false,
|
|
4143
4145
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4144
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4146
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/abort",
|
|
4145
4147
|
"rel": "abort",
|
|
4146
|
-
"urlTemplate": "/
|
|
4148
|
+
"urlTemplate": "/search-indexes/${searchIndexId}/abort",
|
|
4147
4149
|
"method": "DELETE",
|
|
4148
4150
|
"comment": "Abort a site search spidering and mark it as failed",
|
|
4149
4151
|
"urlPlaceholders": [
|
|
4150
4152
|
{
|
|
4151
|
-
"variableName": "
|
|
4153
|
+
"variableName": "searchIndexId",
|
|
4152
4154
|
"isEntityId": true,
|
|
4153
|
-
"relType": "
|
|
4155
|
+
"relType": "SearchIndexData"
|
|
4154
4156
|
}
|
|
4155
4157
|
],
|
|
4156
4158
|
"entityIdPlaceholder": {
|
|
4157
|
-
"variableName": "
|
|
4159
|
+
"variableName": "searchIndexId",
|
|
4158
4160
|
"isEntityId": true,
|
|
4159
|
-
"relType": "
|
|
4161
|
+
"relType": "SearchIndexData"
|
|
4160
4162
|
},
|
|
4161
4163
|
"optionalRequestBody": false,
|
|
4162
4164
|
"queryParamsRequired": false,
|
|
@@ -4167,32 +4169,32 @@
|
|
|
4167
4169
|
"returnsItem": false,
|
|
4168
4170
|
"requestBodyRequiresItem": false,
|
|
4169
4171
|
"offersNestedItemsOptionInQueryParams": false,
|
|
4170
|
-
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/
|
|
4172
|
+
"docUrl": "https://www.datocms.com/docs/content-management-api/resources/search-index/destroy",
|
|
4171
4173
|
"rel": "destroy",
|
|
4172
|
-
"urlTemplate": "/
|
|
4174
|
+
"urlTemplate": "/search-indexes/${searchIndexId}",
|
|
4173
4175
|
"method": "DELETE",
|
|
4174
|
-
"comment": "Delete a
|
|
4176
|
+
"comment": "Delete a search index",
|
|
4175
4177
|
"urlPlaceholders": [
|
|
4176
4178
|
{
|
|
4177
|
-
"variableName": "
|
|
4179
|
+
"variableName": "searchIndexId",
|
|
4178
4180
|
"isEntityId": true,
|
|
4179
|
-
"relType": "
|
|
4181
|
+
"relType": "SearchIndexData"
|
|
4180
4182
|
}
|
|
4181
4183
|
],
|
|
4182
4184
|
"entityIdPlaceholder": {
|
|
4183
|
-
"variableName": "
|
|
4185
|
+
"variableName": "searchIndexId",
|
|
4184
4186
|
"isEntityId": true,
|
|
4185
|
-
"relType": "
|
|
4187
|
+
"relType": "SearchIndexData"
|
|
4186
4188
|
},
|
|
4187
4189
|
"optionalRequestBody": false,
|
|
4188
4190
|
"queryParamsRequired": false,
|
|
4189
|
-
"responseType": "
|
|
4191
|
+
"responseType": "SearchIndexDestroyTargetSchema",
|
|
4190
4192
|
"name": "destroy",
|
|
4191
4193
|
"rawName": "rawDestroy"
|
|
4192
4194
|
}
|
|
4193
4195
|
],
|
|
4194
|
-
"namespace": "
|
|
4195
|
-
"resourceClassName": "
|
|
4196
|
+
"namespace": "searchIndexes",
|
|
4197
|
+
"resourceClassName": "SearchIndex"
|
|
4196
4198
|
},
|
|
4197
4199
|
{
|
|
4198
4200
|
"jsonApiType": "item_type_filter",
|