|
|
# Document indexing service
|
|
|
|
|
|
|
|
|
<a name="overview"></a>
|
|
|
## Overview
|
|
|
Endpoints to index well documents
|
|
|
|
|
|
|
|
|
### Version information
|
|
|
*Version* : 1.0.0
|
|
|
|
|
|
|
|
|
### URI scheme
|
|
|
*Host* : cmz-discovery-index-service.endpoints.dtw-migration-sandbox.cloud.goog
|
|
|
*BasePath* : /search-index/api
|
|
|
*Schemes* : HTTPS
|
|
|
|
|
|
|
|
|
### Tags
|
|
|
|
|
|
* Indexing Service
|
|
|
|
|
|
|
|
|
### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="paths"></a>
|
|
|
## Paths
|
|
|
|
|
|
<a name="file-event-indexer"></a>
|
|
|
### Auto-Index the document based on fileRecord subscription event
|
|
|
```
|
|
|
POST /search/v1/fileRecordEventListener
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Body**|**Subscription Request Payload** <br>*required*|Encoded data for file record being created/updated/deleted in datalake|[SubRecieverRequest](#subrecieverrequest)|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|successful operation|[IndexResponse](#indexresponse)|
|
|
|
|**400**|Validation Error|No Content|
|
|
|
|**403**|Not Authorized|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Indexing Service
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**apiKey**|**[Bearer](#bearer)**|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="index"></a>
|
|
|
### Index documents
|
|
|
```
|
|
|
POST /search/v1/index
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
Index well documents
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Body**|**body** <br>*required*|Index request|[IndexRequest](#indexrequest)|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[IndexResponse](#indexresponse)|
|
|
|
|**400**|Validation Error|No Content|
|
|
|
|**403**|Not Authorized|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Indexing Service
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**apiKey**|**[Bearer](#bearer)**|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="search-reindexer"></a>
|
|
|
### ReIndex the document and update metadata
|
|
|
```
|
|
|
POST /search/v1/reIndex
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Body**|**ReIndex Request Payload** <br>*required*|Enter the location which need to be indexed|[ReIndexRequest](#reindexrequest)|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|successful operation|[IndexResponse](#indexresponse)|
|
|
|
|**400**|Validation Error|No Content|
|
|
|
|**403**|Not Authorized|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Indexing Service
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**apiKey**|**[Bearer](#bearer)**|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="well-event-indexer"></a>
|
|
|
### Auto-Index the document based on wellRecord subscription event
|
|
|
```
|
|
|
POST /search/v1/wellRecordEventListener
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|
|
|
|
|---|---|---|---|
|
|
|
|**Body**|**Subscription Request Payload** <br>*required*|Encoded data for well record being created/updated/deleted in datalake|[SubRecieverRequest](#subrecieverrequest)|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|successful operation|[IndexResponse](#indexresponse)|
|
|
|
|**400**|Validation Error|No Content|
|
|
|
|**403**|Not Authorized|No Content|
|
|
|
|**404**|Not Found|No Content|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Indexing Service
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**apiKey**|**[Bearer](#bearer)**|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="definitions"></a>
|
|
|
## Definitions
|
|
|
|
|
|
<a name="indexrequest"></a>
|
|
|
### IndexRequest
|
|
|
|
|
|
|Name|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**limit** <br>*optional*|**Default** : `-1` <br>**Minimum value** : `1`|integer (int32)|
|
|
|
|**query** <br>*optional*|Query to filter records that need to be indexed <br>**Default** : `"Folder_Filename=.pdf OR Folder_Filename=.tif OR Folder_Filename=.tiff"`|string|
|
|
|
|**wellFileRecordKind** <br>*required*|Datalake well document kind <br>**Example** : `"oga:wellFileRecord:1.0.0"`|string|
|
|
|
|**wellboreKind** <br>*required*|Datalake wellbore kind <br>**Example** : `"oga:wellbore:1.0.0"`|string|
|
|
|
|**workFlowType** <br>*optional*|Used to update only the meta information <br>**Example** : `"metaUpdate"`|string|
|
|
|
|
|
|
|
|
|
<a name="indexresponse"></a>
|
|
|
### IndexResponse
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**code** <br>*optional*|integer (int32)|
|
|
|
|**message** <br>*optional*|string|
|
|
|
|**status** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="reindexrequest"></a>
|
|
|
### ReIndexRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**url** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="subrecieverrequest"></a>
|
|
|
### SubRecieverRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**message** <br>*optional*|[message](#subrecieverrequest-message)|
|
|
|
|
|
|
<a name="subrecieverrequest-message"></a>
|
|
|
**message**
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**data** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="securityscheme"></a>
|
|
|
## Security
|
|
|
|
|
|
<a name="api-key"></a>
|
|
|
### api-key
|
|
|
*Type* : apiKey
|
|
|
*Name* : key
|
|
|
*In* : QUERY
|
|
|
|
|
|
|
|
|
<a name="sauth_id_token"></a>
|
|
|
### sauth_id_token
|
|
|
*Type* : oauth2
|
|
|
*Flow* : implicit
|
|
|
*Token URL* : https://opsauth-dot-cfsauth-preview.appspot.com/v1/auth
|
|
|
|
|
|
|
|
|
<a name="bearer"></a>
|
|
|
### Bearer
|
|
|
*Type* : apiKey
|
|
|
*Name* : Authorization
|
|
|
*In* : HEADER
|
|
|
|
|
|
|
|
|
|