Commit 8425d754 authored by Charles Onojeghuo's avatar Charles Onojeghuo
Browse files

Upload New File

parent b695c281
openapi: "3.0.3"
info:
title: OSDU External Data Fetch Service
description: |
The OSDU External Data Fetch Service enables you to modulate the metaddata fetch process from external Suppliers.
termsOfService: ''
contact:
name: OSDU External Data Services team
url: https://community.opengroup.org/osdu/platform/data-flow/ingestion/external-data-sources/external-data-framework/-/wikis/home#team-members
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 0.1.0
servers:
- url: https://{awsDevServerUrl}/api/external-metadata-fetch/{version}
description: AWS Development server
variables:
awsDevServerUrl:
default: demo-aws-dev.osdu.org
description: Base URL of the AWS OSDU development environment.
version:
default: v1
description: Version of the API
- url: https://{awsTestServerUrl}/api/external-metadata-fetch/{version}
description: AWS Test server
variables:
awsTestServerUrl:
default: demo-aws-test.osdu.org
description: Base URL of the AWS OSDU test environment.
version:
default: v1
description: Version of the API
- url: https://{azureDevServerUrl}/api/external-metadata-fetch/{version}
description: Azure Development server
variables:
azureDevServerUrl:
default: demo-azure-dev.osdu.org
description: Base URL of the Azure OSDU development environment.
version:
default: v1
description: Version of the API
- url: https://{azureTestServerUrl}/api/external-metadata-fetch/{version}
description: Azure Test server
variables:
azureTestServerUrl:
default: demo-azure-test.osdu.org
description: Base URL of the Azure OSDU test environment.
version:
default: v1
description: Version of the API
- url: https://{gcpDevServerUrl}/api/external-metadata-fetch/{version}
description: GCP Development server
variables:
gcpDevServerUrl:
default: demo-gcp-dev.osdu.org
description: Base URL of the GCP OSDU development environment.
version:
default: v1
description: Version of the API
- url: https://{gcpTestServerUrl}/api/external-metadata-fetch/{version}
description: GCP Test server
variables:
gcpTestServerUrl:
default: demo-gcp-test.osdu.org
description: Base URL of the GCP OSDU test environment.
version:
default: v1
description: Version of the API
- url: https://{ibmDevServerUrl}/api/external-metadata-fetch/{version}
description: IBM Development server
variables:
azureDevServerUrl:
default: demo-azure-dev.osdu.org
description: Base URL of the IBM OSDU development environment.
version:
default: v1
description: Version of the API
- url: https://{ibmTestServerUrl}/api/external-metadata-fetch/{version}
description: IBM Test server
variables:
azureTestServerUrl:
default: demo-ibm-test.osdu.org
description: Base URL of the IBM OSDU test environment.
version:
default: v1
description: Version of the API
tags:
- name: externalmetadata
description: External MetaData
paths:
/query:
get:
operationId: getExternalMetaDataRequests
description: |
Returns an array of submitted external data job requests from Operator.
tags:
- externalmetadata
responses:
'200':
description: |
200 Ok - returns an array of submitted external data job requests from Operator
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/externalMetaDataRequest'
'400':
$ref: "#/components/responses/badRequest"
'401':
$ref: "#/components/responses/unauthorized"
'404':
$ref: "#/components/responses/notFound"
'500':
$ref: "#/components/responses/serverError"
security:
- security_auth:
- externalmetadata.read
post:
operationId: createExternalMetaDataRequest
description: |
Creates an external data job requests from Operator.
tags:
- externalmetadata
requestBody:
description: |
External Data Request object.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/externalMetaDataRequest'
responses:
'201':
description: |
201 OK - record created.
'204':
description: |
204 No Content - success with no content returned.
'400':
$ref: "#/components/responses/badRequest"
'401':
$ref: "#/components/responses/unauthorized"
'404':
$ref: "#/components/responses/notFound"
'500':
$ref: "#/components/responses/serverError"
security:
- security_auth:
- externalmetadata.write
/query/{connectedSourceDataJobInstanceID}:
get:
operationId: getExternalMetaDataRequest
description: |
Returns a submitted external data job request from Operator using an instance guid.
tags:
- externalmetadata
parameters:
- name: connectedSourceDataJobInstanceID
description: GUID for a single external data request.
in: path
required: true
schema:
type: string
responses:
'200':
description: |
200 Ok - returns a submitted external data job request from Operator using an instance guid.
content:
application/json:
schema:
$ref: '#/components/schemas/externalMetaDataRequest'
'400':
$ref: "#/components/responses/badRequest"
'401':
$ref: "#/components/responses/unauthorized"
'404':
$ref: "#/components/responses/notFound"
'500':
$ref: "#/components/responses/serverError"
security:
- security_auth:
- externalmetadata.read
/status:
get:
operationId: getExternalMetaDataRequestsStatus
description: |
Returns an array of job status information from Supplier for submitted external data job requests from Operator.
tags:
- externalmetadata
responses:
'200':
description: |
200 Ok - returns an array of job status information from Supplier for submitted external data job requests from Operator.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/externalMetaDataRequestStatus'
'400':
$ref: "#/components/responses/badRequest"
'401':
$ref: "#/components/responses/unauthorized"
'404':
$ref: "#/components/responses/notFound"
'500':
$ref: "#/components/responses/serverError"
security:
- security_auth:
- externalmetadata.read
/status/{connectedSourceDataJobInstanceID}:
get:
operationId: getExternalMetaDataRequestStatus
description: |
Returns the job status information from a Supplier for of a single submitted external data job request from Operator using an instance guid.
tags:
- externalmetadata
parameters:
- name: connectedSourceDataJobInstanceID
description: GUID for a single external data request.
in: path
required: true
schema:
type: string
responses:
'200':
description: |
200 Ok - returns the job status information from a Supplier for of a single submitted external data job request from Operator using an instance guid.
content:
application/json:
schema:
$ref: '#/components/schemas/externalMetaDataRequestStatus'
'400':
$ref: "#/components/responses/badRequest"
'401':
$ref: "#/components/responses/unauthorized"
'404':
$ref: "#/components/responses/notFound"
'500':
$ref: "#/components/responses/serverError"
security:
- security_auth:
- externalmetadata.read
/records/{connectedSourceDataJobInstanceID}:
get:
operationId: getExternalDataResponse
description: |
Returns the processe response from the Supplier corresponding to a single job request from an Operator
tags:
- externalmetadata
parameters:
- name: connectedSourceDataJobInstanceID
description: GUID for a single external data request.
in: path
required: true
schema:
type: string
responses:
'200':
description: |
200 Ok - returns the processed response from the Supplier corresponding to a single job request from an Operator
content:
application/json:
schema:
$ref: '#/components/schemas/externalMetaDataResponse'
'400':
$ref: "#/components/responses/badRequest"
'401':
$ref: "#/components/responses/unauthorized"
'404':
$ref: "#/components/responses/notFound"
'500':
$ref: "#/components/responses/serverError"
security:
- security_auth:
- externalmetadata.read
components:
schemas:
externalMetaDataRequest:
type: object
properties:
connectedSourceDataJobInstanceID:
type: string
connectedSourceDataJobFilter:
$ref: "#/components/schemas/connectedSourceDataJobFilter"
createTime:
type: string
format: date-time
connectedSourceDataJobFilter:
type: object
properties:
kind:
type: string
example: "osdu:wks:master-data--WellLog:1.0.1"
limit:
type: integer
query:
type: string
queryAsOwner:
type: boolean
returnedFields:
type: array
items:
type: string
offset:
type: integer
externalMetaDataRequestStatus:
type: object
properties:
connectedSourceDataJobInstanceID:
type: string
status:
type: string
enum:
- "NOT_STARTED"
- "IN_PROGRESS"
- "COMPLETED"
createTime:
type: string
format: date-time
modifyTime:
type: string
format: date-time
externalMetaDataResponse:
type: object
properties:
connectedSourceDataJobInstanceID:
type: string
results:
type: array
items:
$ref: "#/components/schemas/searchResults"
searchResults:
type: object
properties:
data:
type: object
kind:
type: string
namespace:
type: string
legal:
type: object
id:
type: string
acl:
type: object
version:
type: integer
format: int64
type:
type: string
tags:
type: object
createTime:
type: string
createUser:
type: string
modifyTime:
type: string
modifyUser:
type: string
ancestry:
type: object
meta:
type: object
AppError:
type: object
properties:
code:
type: integer
reason:
type: string
message:
type: string
responses:
badRequest:
description:
400 Bad Request - invalid parameters were given on the request.
content:
application/json:
schema:
$ref: '#/components/schemas/AppError'
unauthorized:
description: |
401 Unauthorized - the call lacks proper authentication credentials
for the resource requested when authentication is possible.
content:
application/json:
schema:
$ref: '#/components/schemas/AppError'
notFound:
description: |
404 Not Found - the requested resource was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AppError'
serverError:
description: |
500 Internal Server Error - an internal server error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/AppError'
securitySchemes:
security_auth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: /oauth/authorize
tokenUrl: /oauth/token
refreshUrl: /oauth/token
scopes:
externalmetadata.read: Read
externalmetadata.write: Create
clientCredentials:
tokenUrl: /oauth/token
refreshUrl: /oauth/token
scopes:
externalmetadata.read: Read
externalmetadata.write: Create
Markdown is supported
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