core-data.yaml

openapi: 3.1.0
info:
  title: Edgex Foundry - Core Data API
  description: This is the definition of the API for the Core Data service in the EdgeX Foundry IOT microservice platform. Core Data is responsible for storing event and reading data ingested from edge devices in the environment.
  version: 4.0.0
  
servers:
  - url: http://localhost:59880/api/v3
    description: URL for local development and testing
  
components:
  schemas:
    AddEventRequest:
      allOf:
        - $ref: '#/components/schemas/BaseRequest'
      description: "A request for ingesting a new event/reading data"
      type: object
      properties:
        event:
          $ref: '#/components/schemas/Event'
      required:
        - event
    BaseReading:
      description: "A base reading type containing common properties from which more specific reading types inherit. This definition should not be implemented but is used elsewhere to indicate support for a mixed list of simple/binary readings in a single event."
      type: object
      properties:
        origin:
          description: "A Unix timestamp (nanoseconds) indicating when the reading was originated at the source device"
          type: integer
        deviceName:
          description: "The name of the device from which the reading originated"
          type: string
        resourceName:
          description: "The device resource name for the reading"
          type: string
        profileName:
          description: "The device profile name for the reading"
          type: string
        valueType:
          description: "Indicates the datatype of the value property"
          type: string
          enum:
            - Bool
            - String
            - Uint8
            - Uint16
            - Uint32
            - Uint64
            - Int8
            - Int16
            - Int32
            - Int64
            - Float32
            - Float64
            - Binary
            - BoolArray
            - StringArray
            - Uint8Array
            - Uint16Array
            - Uint32Array
            - Uint64Array
            - Int8Array
            - Int16Array
            - Int32Array
            - Int64Array
            - Float32Array
            - Float64Array
            - Object
      required:
        - deviceName
        - resourceName
        - profileName
        - origin
        - valueType
    BaseRequest:
      description: "Defines basic properties which all use-case specific request DTO instances should support."
      type: object
      properties:
        requestId:
          description: "Uniquely identifies this request. For implementation, recommend this value be generated by the type's constructor."
          type: string
          format: uuid
          example: "e6e8a2f4-eb14-4649-9e2b-175247911369"
        apiVersion:
          description: "A version number shows the API version in DTOs."
          type: string
          example: v3
      required:
        - apiVersion
    BaseResponse:
      description: "Defines basic properties which all use-case specific response DTO instances should support"
      type: object
      properties:
        apiVersion:
          description: "A version number shows the API version in DTOs."
          type: string
        requestId:
          description: "Uniquely identifies the request that resulted in this response."
          type: string
          format: uuid
          example: "e6e8a2f4-eb14-4649-9e2b-175247911369"
        statusCode:
          description: "A numeric code signifying the operational status of the response."
          type: integer
    BaseWithIdResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
      description: "Defines basic properties which all use-case specific response DTO instances should support"
      type: object
      properties:
        id:
          description: "The unique identifier for the instance."
          type: string
          format: uuid
    BaseWithTotalCountResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
      description: "Defines basic properties which all use-case specific response DTO instances should support"
      type: object
      properties:
        totalCount:
          description: "The total count of all multi instances."
          type: integer
    SimpleReading:
      description: "An event reading for a simple data type"
      allOf:
        - $ref: '#/components/schemas/BaseReading'
        - type: object
          properties:
            value:
              description: "A string representation of the reading's value"
              type: string
      required:
        - value    
    BinaryReading:
      description: "An event reading for a binary data type"
      allOf:
        - $ref: '#/components/schemas/BaseReading'
        - type: object
          properties:
            binaryValue:
              description: "If the value of the reading is binary, it will be found in this property as a byte array"
              type: string
              format: byte
            mediaType:
              description: "E.g. MIME Type, indicates what the content type of the binaryValue property is if it's populated."
              type: string
          required:
            - binaryValue
            - mediaType
    ObjectReading:
      description: "An event reading for a object data type"
      allOf:
        - $ref: '#/components/schemas/BaseReading'
        - type: object
          properties:
            objectValue:
              description: "If the value type of the reading is Object, it will be found in this property as a object value"
              type: string
              format: byte
          required:
            - objectValue
    CountResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
      description: "Returns an aggregate count of specified objects, e.g. events or readings, in uint32 integer type."
      type: object
      properties:
        count:
          type: integer
    Event:
      description: "A discrete event containing one or more readings"
      properties:
        apiVersion:
          description: "A version number shows the API version in DTOs."
          type: string
        id:
          description: "The unique identifier for the event"
          type: string
          format: uuid
        deviceName:
          description: "The name of the device from which the event originated"
          type: string
        profileName:
          description: "The name of the device profile from which the event originated"
          type: string
        sourceName:
          description: "SourceName indicates the name of the resource or device command in the device profile which describes the event to generate"
          type: string
        origin:
          description: "A Unix timestamp (nanoseconds) indicating when the event was originated at the source device"
          type: integer
        readings:
          description: "One or more readings captured at the time of the event"
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/SimpleReading'
              - $ref: '#/components/schemas/BinaryReading'
              - $ref: '#/components/schemas/ObjectReading'
          example: [
            {
                "deviceName": "Random-Boolean-Device",
                "profileName": "Random-Boolean-Device",
                "resourceName": "Bool",
                "origin": 1692721935934211905,
                "valueType": "Bool",
                "value": "false"
            }
        ]
        tags:
          description: "List of zero or more Tags attached to the Event which give more context to the Event"
          title: tags
          type: object
          example: {
            "Gateway-id": "HoustonStore-000123",
            "latitude": {
              "degrees": 25.0,
              "minute": 1.0,
              "second": 26.6268000000062
            },
            "longitude": {
              "degree": 121.0,
              "minute": 31.0,
              "second": 19.600799999980154
            }
          }
      required:
        - id
        - deviceName
        - profileName
        - sourceName
        - origin
        - readings
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
      description: "A response type for returning a generic error to the caller."
      type: object
      properties:
        message:
          description: "A field that can contain a free-form message, such as an error message."
          type: string
    EventResponse:
      allOf:
        - $ref: '#/components/schemas/BaseResponse'
      description: "A response type for returning an Event to the caller."
      type: object
      properties:
        event:
          $ref: '#/components/schemas/Event'
    ConfigResponse:
      description: "Provides a response containing the configuration for the targeted service."
      type: object
      properties:
        apiVersion:
          description: "A version number shows the API version in DTOs."
          type: string
        serviceName:
          description: "Outputs the name of the service the response is from"
          type: string
        config:
          description: "An object containing the service's configuration. Please refer the configuration documentation of each service for more details at [EdgeX Foundry Documentation](https://docs.edgexfoundry.org)."
          type: object
    MultiEventsResponse:
      allOf:
        - $ref: '#/components/schemas/BaseWithTotalCountResponse'
      description: "A response type for returning Events to the caller."
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
    MultiReadingsResponse:
      allOf:
        - $ref: '#/components/schemas/BaseWithTotalCountResponse'
      description: "A response type for returning Readings to the caller."
      type: object
      properties:
        readings:
          type: array
          items:
            $ref: '#/components/schemas/BaseReading'
    PingResponse:
      type: object
      properties:
        apiVersion:
          description: "A version number shows the API version in DTOs."
          type: string
        timestamp:
          description: "Outputs the current server timestamp in RFC1123 format"
          example: "Mon, 02 Jan 2006 15:04:05 MST"
          type: string
        serviceName:
          description: "Outputs the name of the service the response is from"
          type: string
    VersionResponse:
      description: "A response returned from the /version endpoint whose purpose is to report out the latest version supported by the service."
      type: object
      properties:
        apiVersion:
          description: "A version number shows the API version in DTOs."
          type: string
        version:
          description: "The latest version supported by the service."
          type: string
        serviceName:
          description: "Outputs the name of the service the response is from"
          type: string
    SecretRequest:
      allOf:
        - $ref: '#/components/schemas/BaseRequest'
      description: Defines the secret data to be stored
      type: object
      properties:
        secretName:
          description: Specifies the name of the secret
          type: string
          example: "credentials"
        secretData:
          description: A list of the key/value pairs of secret data to store
          type: array
          items:
            $ref: '#/components/schemas/SecretDataKeyValue'
      required:
        - secretName
        - secretData
    SecretDataKeyValue:
      description: Defines a key/value pair of secret data
      type: object
      properties:
        key:
          description: The key to identify the secret data
          type: string
          example: "secret-key"
        value:
          description: The value of the secret data
          type: string
          example: "secret-value"
      required:
        - key
        - value 
  parameters:
    offsetParam:
      in: query
      name: offset
      required: false
      schema:
        type: integer
        minimum: -1
        default: 0
      description: "The number of items to skip before starting to collect the result set. Setting this value to -1 will skip counting the total number of events or readings, which can improve performance when working with large datasets."
    limitParam:
      in: query
      name: limit
      required: false
      schema:
        type: integer
        minimum: -1
        default: 20
      description: "The numbers of items to return.  Specify -1 will return all remaining items after offset.  The maximum will be the MaxResultCount as defined in the configuration of service."
    correlatedRequestHeader:
      in: header
      name: X-Correlation-ID
      description: "A unique identifier correlating a request to its associated response, facilitating tracing through being included on requests originating from the initiating request."
      schema:
        type: string
        format: uuid
      example: "14a42ea6-c394-41c3-8bcd-a29b9f5e6835"
  headers:
    correlatedResponseHeader:
      description: "A response header that returns the unique correlation ID used to initiate the request."
      schema:
        type: string
        format: uuid
      example: "14a42ea6-c394-41c3-8bcd-a29b9f5e6835"
  examples:
    200Example:
      value:
        apiVersion: "v3"
        statusCode: 200
    202Example:
      value:
        apiVersion: "v3"
        statusCode: 202
    400Example:
      value:
        apiVersion: "v3"
        statusCode: 400
        message: "Bad Request" 
    404Example:
      value:
        apiVersion: "v3"
        statusCode: 404
        message: "Not Found"
    409Example:
      value:
        apiVersion: "v3"
        statusCode: 409
        message: "Data Duplicate"
    416Example:
      value:
        apiVersion: "v3"
        statusCode: 416
        message: "Range Not Satisfiable"
    500Example:
      value:
        apiVersion: "v3"
        statusCode: 500
        message: "Interval Server Error" 
    EventExample:
      value:
        apiVersion: "v3"
        statusCode: 200
        event:
          apiVersion: "v3"
          id: "040bd523-ec33-440d-9d72-e5813a465f37"
          deviceName: "device-001"
          profileName: "profile-001"
          sourceName: "source-1"
          origin: 1602168089665565300
          tags:
            Gateway: "HoustonStore-000123"
            Latitude:
              degrees: 25.0
              minute: 1.0
              second: 26.6268000000062
            Longitude:
              degree: 121.0
              minute: 31.0
              second: 19.600799999980154
          readings:
            - deviceName: "device-001"
              resourceName: "resource-001"
              profileName: "profile-001"
              modified: 1594975851631
              origin: 1602168089665565300
              valueType: "Float32"
              value: "39.5"
            - create: 1594876281221
              deviceName: "device-001"
              resourceName: "resource-001"
              profileName: "profile-001"
              origin: 1602168089665565300
              valueType: "Int8"
              value: "75"
    AllEventsExample:
      value:
        apiVersion: "v3"
        statusCode: 200
        totalCount: 3
        events: 
          - apiVersion: "v3"
            id: "040bd523-ec33-440d-9d72-e5813a465f37"
            deviceName: "device-001"
            profileName: "profile-001"
            sourceName: "source-1"
            origin: 1602168089665565300
            tags:
              Gateway: "HoustonStore-000123"
              Latitude:
                degrees: 25.0
                minute: 1.0
                second: 26.6268000000062
              Longitude:
                degree: 121.0
                minute: 31.0
                second: 19.600799999980154
            readings:
              - deviceName: "device-001"
                resourceName: "resource-001"
                profileName: "profile-001"
                modified: 1594975851631
                origin: 1602168089665565300
                valueType: "Float32"
                value: "39.5"
              - create: 1594876281221
                deviceName: "device-001"
                resourceName: "resource-001"
                profileName: "profile-001"
                origin: 1602168089665565300
                valueType: "Int8"
                value: "75"
          - apiVersion: "v3"
            deviceName: "device-002"
            profileName: "profile-002"
            sourceName: "source-2"
            id: "73fc4f9c-2d64-4920-addb-b1f33a8f8514"
            origin: 1602168089665565300
            readings:
              - deviceName: "device-002"
                resourceName: "resource-002"
                profileName: "profile-002"
                origin: 1602168089665565300
                valueType: "Binary"
                binaryValue: [12,34]
                mediaType: "image"
              - deviceName: "device-002"
                resourceName: "resource-003"
                profileName: "profile-002"
                origin: 1602168089665565300
                valueType: "Object"
                objectValue:
                  Attr1: "yyz"
                  Attr2: -45
                  Attr3: [ 255, 1, 0 ]
          - apiVersion: "v3"
            deviceName: "device-002"
            profileName: "profile-002"
            sourceName: "source-3"
            id: "d5471d59-2810-419a-8744-18eb8fa03465"
            origin: 1602168089665565300
            readings:
              - deviceName: "device-002"
                resourceName: "resource-002"
                profileName: "profile-002"
                origin: 1602168089665565300
                valueType: "Float32"
                value: "12.2"
    AllReadingsExample:
      value:
        apiVersion: "v3"
        statusCode: 200
        totalCount: 5
        readings:
          - deviceName: "Random-Boolean-Device"
            resourceName: "Bool"
            profileName: "Random-Boolean-Device"
            origin: 1602168089665565300
            valueType: "Bool"
            value: "false"
          - deviceName: "Random-Integer-Device"
            resourceName: "Int8"
            profileName: "Random-Integer-Device"
            origin: 1602168089665565300
            valueType: "Int8"
            value: "75" 
          - deviceName: "Random-Binary-Device"
            resourceName: "resource-002"
            profileName: "Random-Binary-Device"
            origin: 1602168089665565300
            valueType: "Binary"
            binaryValue: [12,34]
            mediaType: "image"
          - deviceName: "Random-Float-Device"
            resourceName: "Float32"
            profileName: "Random-Float-Device"
            origin: 1602168089665565300
            valueType: "Float32"
            value: "12.2"
          - deviceName: "Random-UnsignedInteger-Device"
            resourceName: "Uint8"
            profileName: "Random-UnsignedInteger-Device"
            origin: 1602168089665565300
            valueType: "Uint8"
            value: "77"
    ReadingsByResourceNameAndTimeRangeExample:
      value:
        apiVersion: "v3"
        statusCode: 200
        totalCount: 6
        readings:
          - deviceName: "device-001"
            resourceName: "resource-001"
            profileName: "profile-001"
            origin: 1602168089665565300
            valueType: "Float32"
            value: "39.5"
          - deviceName: "device-001"
            resourceName: "resource-001"
            profileName: "profile-001"
            origin: 1602168089665565300
            valueType: "Float32"
            value: "38.6"
    CountExample:
      value:
        apiVersion: "v3"
        statusCode: 200
        count: 3
paths:
  /event/{serviceName}/{profileName}/{deviceName}/{sourceName}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: serviceName
      in: path
      required: true
      schema:
        type: string
      description: "Identifies the device service generating the new event"
    - name: profileName
      in: path
      required: true
      schema:
        type: string
      description: "Uniquely identifies a given device profile"
    - name: deviceName
      in: path
      required: true
      schema:
        type: string
      description: "Uniquely identifies a given device"
    - name: sourceName
      in: path
      required: true
      schema:
        type: string
      description: "The sourceName is the name of the source that created the Event (ResourceName or CommandName)"
    post:
      summary: "Allows for the ingestion of event/reading data, and the deviceName and profileName of Event must match to the given deviceName and profileName as specified in the path"
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddEventRequest'
            example:
              apiVersion: v3
              event:
                apiVersion: v3
                deviceName: Random-Boolean-Device
                profileName: Random-Boolean-Device
                sourceName: Bool
                id: 563513b3-f020-46fa-ae44-0fdd1d129185
                origin: 1692721935934211905
                tags:
                  Gateway: "HoustonStore-000123"
                  Latitude:
                    degrees: 25.0
                    minute: 1.0
                    second: 26.6268000000062
                  Longitude:
                    degree: 121.0
                    minute: 31.0
                    second: 19.600799999980154
                readings:
                  - deviceName: Random-Boolean-Device
                    resourceName: Bool
                    profileName: Random-Boolean-Device
                    origin: 1692721935934211905
                    valueType: Bool
                    value: 'false'
      responses:
        '201':
          description: "Indicates the event has been successfully added."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseWithIdResponse'
              example:
                apiVersion: "v3"
                statusCode: 201
                id: "d5471d59-2810-419a-8744-18eb8fa03465"
        '400':
          description: "Request is in an invalid state"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '409':
          description: "Conflict detected. Event Id must be universally unique."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                409Example:
                  $ref: '#/components/examples/409Example'
        '500':
          description: An unexpected error occurred on the server
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /event/all:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Given the entire range of events sorted by origin descending, returns a portion of that range according to the offset and limit parameters."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                  $ref: '#/components/schemas/MultiEventsResponse'
              examples:
                MultiEventsExample:
                  $ref: '#/components/examples/AllEventsExample'
        '400':
          description: "Request is in an invalid state"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /event/id/{id}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: "An ID of datatype string, by default a GUID."
    get:
      summary: "Returns an event by ID"
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventResponse'
              examples:
                EventExample:
                  $ref: '#/components/examples/EventExample'
        '404':
          description: "The requested resource does not exist"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                404Example:
                  $ref: '#/components/examples/404Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
    delete:
      summary: "Deletes an event by ID"
      responses:
        '200':
          description: "Delete successful"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              examples:
                200Example:
                  $ref: '#/components/examples/200Example'
        '404':
          description: "The requested resource does not exist"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                404Example:
                  $ref: '#/components/examples/404Example'                
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /event/count:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    get:
      summary: "Return a count of all of events currently stored in the database."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResponse'
              examples:
                CountExample:
                  $ref: '#/components/examples/CountExample'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /event/count/device/name/{name}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: name
      in: path
      required: true
      schema:
        type: string
      description: "Uniquely identifies a given device"
    get:
      summary: "Return a count of all of events currently stored in the database, sourced from the specified device."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResponse'
              examples:
                CountExample:
                  $ref: '#/components/examples/CountExample'
        '404':
          description: "The requested resource does not exist"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                404Example:
                  $ref: '#/components/examples/404Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /event/device/name/{name}:
    get:
      summary: "Given the entire range of events sorted by origin descending, returns a portion of that range according to the device name, offset and limit parameters."
      parameters:
        - $ref: '#/components/parameters/correlatedRequestHeader'
        - name: name
          in: path
          required: true
          schema:
            type: string
          description: "Uniquely identifies a given device"
        - $ref: '#/components/parameters/offsetParam'
        - $ref: '#/components/parameters/limitParam'
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiEventsResponse'
              examples:
                MultiEventsExample:
                  $ref: '#/components/examples/AllEventsExample'
        '404':
          description: "The requested resource does not exist"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                404Example:
                  $ref: '#/components/examples/404Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
    delete:
      summary: "Deletes all events for the specified device"
      parameters:
        - $ref: '#/components/parameters/correlatedRequestHeader'
        - name: name
          in: path
          required: true
          schema:
            type: string
          description: "Uniquely identifies a given device"
      responses:
        '202':
          description: "Delete request accepted"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              examples:
                202Example:
                  $ref: '#/components/examples/202Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /event/start/{start}/end/{end}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: start
      in: path
      required: true
      schema:
        type: integer
      description: "Unix timestamp (nanoseconds) indicating the start of a date/time range"
    - name: end
      in: path
      required: true
      schema:
        type: integer
      description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
    - $ref: '#/components/parameters/offsetParam'
    - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Return a paginated range of events sorted by origin descending with a create date inside the specified start/end values."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiEventsResponse'
              examples:
                MultiEventsExample:
                  $ref: '#/components/examples/AllEventsExample'
        '400':
          description: "\"{start}\" and \"{end}\" are unix time, and \"{end}\" should be greater than \"{start}\""
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items: 
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example' 
  /event/age/{age}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: age
      in: path
      required: true
      schema:
        type: integer
      description: "Age in nanoseconds since origin timestamp for a given event"
    delete:
      summary: "Remove all old events (and associated readings) based on delimiting age"
      responses:
        '202':
          description: "Delete request accepted"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              examples:
                202Example:
                  $ref: '#/components/examples/202Example'
        '400':
          description: "\"{age}\" must be a parsable unix timestamp"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/all:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Given the entire range of readings sorted by origin descending, returns a portion of that range according to the offset and limit parameters. Readings returned will all inherit from BaseReading but their concrete types will be either SimpleReading or BinaryReading, potentially interleaved."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/AllReadingsExample'
        '400':
          description: "Request is in an invalid state"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example' 
  /reading/count:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    get:
      summary: "Return a count of all of readings currently stored in the database."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResponse'
              examples:
                CountExample:
                  $ref: '#/components/examples/CountExample'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/count/device/name/{name}:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - name: name
        in: path
        required: true
        schema:
          type: string
        description: "Uniquely identifies a given device"
    get:
      summary: "Return a count of all of readings currently stored in the database, sourced from the specified device."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CountResponse'
              examples:
                CountExample:
                  $ref: '#/components/examples/CountExample'
        '404':
          description: "The requested resource does not exist"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                404Example:
                  $ref: '#/components/examples/404Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/device/name/{name}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: name
      in: path
      required: true
      schema:
        type: string
      description: "Uniquely identifies a given device"
    - $ref: '#/components/parameters/offsetParam'
    - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Given a range of readings from the specified device sorted by origin descending, returns a portion of that range according to the device name, offset and limit parameters."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/AllReadingsExample'
        '400':
          description: "Request is in an invalid state"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/resourceName/{resourceName}:
    parameters:
    - $ref: '#/components/parameters/correlatedRequestHeader'
    - name: resourceName
      in: path
      required: true
      schema:
        type: string
      description: The device resource name of readings.
    - $ref: '#/components/parameters/offsetParam'
    - $ref: '#/components/parameters/limitParam'
    get:
      summary: Returns a paginated list of readings whose resource name is of the specified one.
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/AllReadingsExample'
        '400':
          description: "Request is in an invalid state. \"{resourceName}\" could only contain reserved characters as defined in https://tools.ietf.org/html/rfc3986#section-2.3"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/device/name/{deviceName}/resourceName/{resourceName}:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - name: deviceName
        in: path
        required: true
        schema:
          type: string
        description: "The device name name of readings"
      - name: resourceName
        in: path
        required: true
        schema:
          type: string
        description: The device resource name of readings.
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Returns a paginated range of readings by deviceName and resourceName"
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/AllReadingsExample'
        '400':
          description: "Request is in an invalid state."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/start/{start}/end/{end}:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - name: start
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the start of a date/time range"
      - name: end
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Return a paginated range of readings with a create date inside the specified start/end values."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/AllReadingsExample'
        '400':
          description: "\"{start}\" and \"{end}\" are unix time, and \"{end}\" should be greater than \"{start}\""
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/resourceName/{resourceName}/start/{start}/end/{end}:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - name: resourceName
        in: path
        required: true
        schema:
          type: string
        description: "The device resource name of readings"
      - name: start
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the start of a date/time range"
      - name: end
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Return a paginated range of readings by resourceName and specified time range."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/ReadingsByResourceNameAndTimeRangeExample'
        '400':
          description: "\"{start}\" and \"{end}\" are unix time, and \"{end}\" should be greater than \"{start}\""
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/device/name/{deviceName}/resourceName/{resourceName}/start/{start}/end/{end}:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - name: deviceName
        in: path
        required: true
        schema:
          type: string
        description: "The device name name of readings"
      - name: resourceName
        in: path
        required: true
        schema:
          type: string
        description: "The device resource name of readings"
      - name: start
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the start of a date/time range"
      - name: end
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Return a paginated range of readings by deviceName, resourceName and specified time range."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/ReadingsByResourceNameAndTimeRangeExample'
        '400':
          description: "Request is in an invalid state."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /reading/device/name/{deviceName}/start/{start}/end/{end}:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
      - name: deviceName
        in: path
        required: true
        schema:
          type: string
        description: "The device name name of readings"
      - name: start
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the start of a date/time range"
      - name: end
        in: path
        required: true
        schema:
          type: integer
        description: "Unix timestamp (nanoseconds) indicating the end of a date/time range"
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
    get:
      summary: "Return a paginated range of readings by deviceName and specified time range while also allowing multiple resource names specified in the request body as query criteria.  If resource names or request body is empty, return all the readings that meet deviceName and specified time range."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiReadingsResponse'
              examples:
                MultiReadingsExample:
                  $ref: '#/components/examples/ReadingsByResourceNameAndTimeRangeExample'
        '400':
          description: "Request is in an invalid state."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '416':
          description: "Request range is not satisfiable"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                416Example:
                  $ref: '#/components/examples/416Example'
        '500':
          description: "An unexpected error occurred on the server"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /config:
    get:
      summary: "Returns the current configuration of the service."
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigResponse'
              example:
                apiVersion: "v3"
                serviceName: "core-data"                    
                config:
                  Writeable:
                    PersistData: true
                    LogLevel: "INFO"
                  MessageBus:
                    Host: "localhost"
                    Port: 6379
                    Protocol: "redis"
                    Type: "redis"
                    Topics:
                      PublishTopicPrefix: "edgex/events/core"
                      SubscribeTopic: "edgex/events/device/#"
                    Optional:
                      AutoReconnect: "true"
                      ClientId: "core-data"
                      ConnectTimeout: "5"
                      KeepAlive: "10"
                      Password: ""
                      Qos: "0"
                      Retained: "false"
                      SkipCertVerify: "false"
                      Username: ""
                  Clients:
                    Logging:
                      Host: "localhost"
                      Port: 48061
                      Protocol: "http"
                    Metadata:
                      Host: "edgex-core-metadata"
                      Port: 59881
                      Protocol: "http"
                  Database:
                    Username: "core"
                    Password: "password"
                    Type: "redisdb"
                    Timeout: "5s"
                    Host: "edgex-redis"
                    Port: 6379
                    Name: "coredata"
                  Logging:
                    EnableRemote: false
                    File: ""
                  Registry:
                    Host: "edgex-core-keeper"
                    Port: 59890
                    Type: "keeper"
                  Service:
                    BootTimeout: 30000
                    CheckInterval: "10s"
                    Host: "edgex-core-data"
                    Port: 59880
                    SeverBindAddr: ""
                    Protocol: "http"
                    StartupMsg: "This is the Core Data Microservice"
                    MaxResultCount: 50000
                    Timeout: "5s"
                  SecretStore:
                    Host: "edgex-secret-store"
                    Port: 8200
                    Path: "v1/secret/edgex/core-data/"
                    Protocol: "http"
                    Namespace: ""
                    RootCaCertPath: ""
                    ServerName: "edgex-secret-store"
                    Authentication:
                      AuthType: "X-Vault-Token"  
                      AuthToken: ""  
                    TokenFile: "/tmp/edgex/secrets/core-data/secrets-token.json"
                  Startup:
                    Duration: 30
                    Interval: 1
        '500':
          description: "Interval Server Error"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example' 
  /ping:
    get:
      summary: "A simple 'ping' endpoint that can be used as a service healthcheck"
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
              example:
                apiVersion: "v3"
                timestamp: "Mon, 02 Jan 2006 15:04:05 MST"
                serviceName: "core-data"                    
        '500':
          description: "Interval Server Error"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /version:
    get:
      summary: "A simple 'version' endpoint that will return the current version of the service"
      responses:
        '200':
          description: "OK"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionResponse'
              example:
                apiVersion: "v3"
                version: 4.0.0
                serviceName: "core-data"               
        '500':
          description: "Interval Server Error"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'
  /secret:
    parameters:
      - $ref: '#/components/parameters/correlatedRequestHeader'
    post:
      summary: Adds EdgeX Service exclusive secret to the Secret Store
      requestBody:
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/SecretRequest'
        required: true
      responses:
        '201':
          description: "Created"
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
              example:
                apiVersion: "v3"
                statusCode: 201
        '400':
          description: "Invalid request."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                400Example:
                  $ref: '#/components/examples/400Example'
        '500':
          description: "An unexpected error happened on the server."
          headers:
            X-Correlation-ID:
              $ref: '#/components/headers/correlatedResponseHeader'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                500Example:
                  $ref: '#/components/examples/500Example'