Commit 838ea278 authored by Luc Yriarte's avatar Luc Yriarte
Browse files

slb code push #4 / doc, specs, schemas

parent 01eb0dd1
# Log Recognition Service
[**Introduction**](#introduction)
- [Introduction](#introduction)
- [About the service](#about-the-service)
- [How to use this service](#how-to-use-this-service)
- [How to create a custom catalog](#how-to-create-a-custom-catalog)
[**How to use this service**](#how-to-use-this-service)
## Introduction <a name="introduction"></a>
[**How to create a custom catalog**](#how-to-create-a-custom-catalog)
# **Introduction**
[Log Recognition API specification](/solutions/wellboreddms/apis/osdu-log-recognition-service)
Wellbore logs are acquired by different logging company with their
convention of defining the log name. This leads to a log called by
......@@ -18,8 +19,8 @@ classified in groups / Families based on the measurement. This would
help in identifying the logs easily and optimize the time spent looking
for the logs.
*Example: The following curves coming from the field are all gamma ray.
But have different names.*
*Example: The following curves coming from the field are all gamma ray,
but they have different names.*
![](/sites/default/files/solution/wellboreDMS/gamma-ray-logviewer.png)
......@@ -36,10 +37,10 @@ the Family attribute to the all the logs automatically using family
assignment rules. This will ensure that the correct logs are picked up
by the workflows for automatic processing.
**About the service**
## About the service <a name="about-the-service"></a>
Log Recognition service has a huge ***default catalog*** of assignment
rules. Which help in the identification of log family using the Log name
rules, which helps in the identification of log family using the Log name
/ Mnemonics, Log unit and description. This catalog cannot be modified
by user. But the users can create their own ***custom catalog*** with
different set of assignment rules specific to their data partition. The
......@@ -49,7 +50,7 @@ present in the default catalog or override some rules defined in the
default catalog that are different for their company. Then, they could
create their own customized catalog.
# **How to use this service**
## How to use this service <a name="how-to-use-this-service"></a>
Log Recognition service provides API's to assign Family attribute to
logs using the Log name / Mnemonics, Description of the Log and log
......@@ -117,7 +118,7 @@ The result will be
}
```
# **How to create a custom catalog**
## How to create a custom catalog <a name="how-to-create-a-custom-catalog"></a>
The custom catalog consists of the following attributes.
......
# Log statistics
[API specification](/solutions/wellboreddms/apis/osdu-wellbore-service#/Log/get_log_data_statistics_ddms_v2_logs__logid__statistics_get)
**Goal:** Provide statistical information for Bulk log data
**Use case 1:** Data consumers interested in specific statistics for specific log.
......@@ -8,7 +10,7 @@
When transferring bulk data to Wellbore DMS it might happened that due to various reasons (human, system)
the data is not transferred correctly and might not be discovered until the data is actually used.
By launching the calculation on the application side and comparing the results to the ones form this service,
By launching the calculation on the application side and comparing the results from this service,
you will be able to compare results quickly.
The method calculate the following statistics:
......
......@@ -2,13 +2,11 @@
The Wellbore DMS provides developers the capacity to access and manipulate various data types acquired and interpreted in Wellbores.
## Features
### Data search
First thing we all want is to be able to find the right data in the right context, quickly. To help with this challenge, we deliver various methodologies to query the data stored in the Wellbore DMS. By providing the right context, we can provide you with the relevant data that matches your criteria’s.
### Data access
Once found, it’s all about accessing the data for your service. Wellbores, Trajectories, Logs and all other data types required to your service.
And Evidently, once your service has run, placing new and improved data back in storage for it to be accessible in the next processing chain.
Once found, it’s all about accessing the data for your service: Wellbores, Trajectories, Logs and all other data types required for your service. Once your service has run, we place new and improved data back in storage for it to be accessible to the next processing chain.
### Data services
Providing a set of tools to help software developers to work consistently with data: Ingestion engines, connectors and various data manipulation tools to ease and reduce the burden from application developers.
\ No newline at end of file
We provide a set of tools to help software developers to work consistently with data: Ingestion engines, connectors and various data manipulation tools to ease and reduce the burden from application developers.
\ No newline at end of file
......@@ -8,12 +8,15 @@ The Swagger page for WDMS is available along the running service at,
`https://{hostname}/docs`.
And the OpenAPI specification file will be at `https://{hostname}/openapi.json`
E.g.: For EVT enviroment, `https://evt-mvp.managed-osdu.cloud.slb-ds.com/api/os-wellbore-ddms/openapi.json`
The `spec` directory contains the OpenAPI specification files for Wellbore DMS.
Under `spec/generated`, the OpenAPI in JSON format is saved as-is.
## Publishing to Developer Portal
API products are grouped in families as described in the table below.
API products are grouped in families as described in the table, and link below.
https://wiki.slb.com/display/mptctransformation/Subscriptions+and+Developer+Portal
API reference/Swagger | API Product | Path | Objects/services
--- | --- | --- | ---
......
......@@ -17,7 +17,7 @@ info:
title: Wellbore DDMS Geology OSDU
version: '0.2'
servers:
- url: https://api.example.com/osdu/wdms/geology/v2
- url: https://api.evq.csp.slb.com/osdu/wdms/geology/v2
security:
- bearer: [ ]
- appkey: [ ]
......@@ -43,6 +43,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -91,6 +92,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -127,6 +129,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -173,6 +176,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -207,6 +211,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......@@ -250,6 +255,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......@@ -306,6 +312,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -346,6 +353,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -387,6 +395,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -435,6 +444,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -488,6 +498,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -533,6 +544,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......@@ -588,6 +600,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......@@ -659,6 +672,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -707,6 +721,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -753,6 +768,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
responses:
......@@ -804,6 +820,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......
......@@ -17,7 +17,7 @@ info:
title: Log Recognition OSDU
version: '0.2'
servers:
- url: https://api.example.com/osdu/wdms/log-recognition/v2
- url: https://api.evq.csp.slb.com/osdu/wdms/log-recognition/v2
security:
- bearer: []
- appkey: []
......@@ -37,6 +37,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......@@ -79,6 +80,7 @@ paths:
minLength: 1
type: string
description: identifier of the data partition to query
default: slb-osdu-dev-sis-internal-hq
name: data-partition-id
in: header
requestBody:
......@@ -120,7 +122,7 @@ components:
title: Main Family Catalog
type: array
items:
$ref: '#/components/schemas/MainFanilyCatalogItem'
$ref: '#/components/schemas/MainFamilyCatalogItem'
CatalogItem:
title: CatalogItem
required:
......@@ -155,9 +157,9 @@ components:
example:
acl:
viewers:
- 'abc@example.com, cde@example.com'
- 'abc@slb.com, cde@slb.com'
owners:
- 'abc@example.com, cde@example.com'
- 'abc@slb.com, cde@slb.com'
legal:
legaltags:
- opendes-public-usa-dataset-1
......@@ -247,8 +249,8 @@ components:
type: array
items:
type: string
MainFanilyCatalogItem:
title: MainFanilyCatalogItem
MainFamilyCatalogItem:
title: MainFamilyCatalogItem
required:
- MainFamily
- Family
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment