api.yaml

openapi: "3.0.1"
info:
  description: "This is a set of APIs that are provided for Domain Data Management Service (DDMS) developers."
  version: "1.0.0"
  title: "DELFI Data Ecosystem Domain Extensions Services"
  termsOfService: "http://osdu.opengroup.org/terms/"
  contact:
    email: "osdu-sre@opengroup.org"
servers:
  - url: https://api.{environment}.csp.opengroup.org/dataecosystem
    variables:
      environment:
        default: p4d
        enum:
          - evd
          - evt
          - p4d

tags:
  - name: "registration"
    description: "APIs for registration"
    externalDocs:
      description: "Find out more"
      url: "https://test.devportal.apigee.io/solutions/dataecosystem/tutorials"

security:
  - Bearer: []

paths:
  "/registration/v1/ddms":
    post:
      tags:
        - "registration"
      summary: "Add a new DDMS to the Data Ecosystem"
      description: "Create a DDMS registration."
      operationId: "postDMS"
      parameters:
        - $ref: "#/components/parameters/correlation-id"
        - $ref: "#/components/parameters/data-partition-id"
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/DMSOpenAPISpec'
                - $ref: '#/components/schemas/DMSBasicSpec'
            example:
              name: logDMS
              description: "This DDMS is used to manage log data."
              contact:
                email: "osdu-sre@opengroup.org"
              servers:
                - url: "https://logstore/v1"
                  spec: "REST"
                  description: "Global logstore deployment"
                  isMultiDataPartition: true

      responses:
        '200':
          description: "Given DDMS has been registered."
          headers:
            "correlation-id":
              $ref: "#/components/headers/correlation-id"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DMSId'
        default:
          description: "Unexpected error"
          content: