openapi3.yaml

openapi: 3.0.3
info:
  title: Polygon-Parts Manager
  description: CRUD operations to manage polygon-parts
  version: 1.4.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
tags:
  - name: polygon-parts
    description: CRUD operations to manage polygon-parts
paths:
  /aggregation/{polygonPartsEntityName}:
    get:
      tags:
        - aggregation
      summary: Get aggregated polygon-parts data by polygon parts entity name
      description: Get aggregated polygon-parts data by polygon parts entity name
      operationId: getAggregationLayerMetadata
      parameters:
        - in: path
          name: polygonPartsEntityName
          description: polygon-parts entity name
          schema:
            $ref: '#/components/schemas/PolygonPartsEntityName'
          required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregationLayerMetadata'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
  /polygonParts:
    post:
      tags:
        - polygon-parts
      summary: Create new polygon-parts
      description: Create new polygon-parts
      operationId: createPolygonParts
      requestBody:
        description: polygon-parts payload
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolygonPartsPayload'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolygonPartsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
    put:
      tags:
        - polygon-parts
      parameters:
        - in: query
          name: isSwap
          schema:
            type: boolean
            default: false
          description: defines if operation is a swap update
      summary: Update an existing polygon-parts
      description: Update an existing polygon-parts
      operationId: updatePolygonParts
      requestBody:
        description: polygon-parts metadata payload
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolygonPartsPayload'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PolygonPartsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    PolygonPartsEntityName:
      type: string
      description: polygon-parts entity name
      pattern: ^[a-z][a-z0-9_]{0,61}[a-z0-9]$
      example: world_orthophoto
    PolygonPartsPayload:
      $ref: >-
        ./Schema/polygonPartsManager/payload.yaml#/components/schemas/PolygonPartsPayload
    PolygonPartsResponse:
      additionalProperties: false
      type: object
      required:
        - polygonPartsEntityName
      properties:
        polygonPartsEntityName:
          $ref: '#/components/schemas/PolygonPartsEntityName'
    AggregationLayerMetadata:
      additionalProperties: false
      type: object
      properties:
        imagingTimeBeginUTC:
          type: string
          description: Oldest imaging date (UTC)
          format: date-time
        imagingTimeEndUTC:
          type: string
          description: Latest imaging date (UTC)
          format: date-time
        maxResolutionDeg:
          type: number
          minimum: 1.67638e-7
          maximum: 0.703125
          format: double
          description: Maximal resolution of layer in degrees/pixel
        minResolutionDeg:
          type: number
          minimum: 1.67638e-7
          maximum: 0.703125
          format: double
          description: Minimal resolution of layer in degrees/pixel
        maxResolutionMeter:
          type: number
          minimum: 0.0185
          maximum: 78271.52
          format: double
          description: Maximal resolution of layer in meters
        minResolutionMeter:
          type: number
          minimum: 0.0185
          maximum: 78271.52
          format: double
          description: Minimal resolution of layer in meters
        maxHorizontalAccuracyCE90:
          type: number
          minimum: 0.01
          maximum: 4000
          format: double
          description: Maximal horizontal accuracy
        minHorizontalAccuracyCE90:
          type: number
          minimum: 0.01
          maximum: 4000
          format: double
          description: Minimal horizontal accuracy
        productBoundingBox:
          type: string
        sensors:
          type: array
          items:
            type: string
            pattern: ^(?!\s).+(?<!\s)$
          minItems: 1
          description: Layer sensors list
        footprint:
          oneOf:
            - $ref: ./Schema/geojson.yaml#/components/schemas/Polygon
            - $ref: ./Schema/geojson.yaml#/components/schemas/MultiPolygon
      required:
        - imagingTimeBeginUTC
        - imagingTimeEndUTC
        - maxResolutionDeg
        - minResolutionDeg
        - maxResolutionMeter
        - minResolutionMeter
        - maxHorizontalAccuracyCE90
        - minHorizontalAccuracyCE90
        - productBoundingBox
        - sensors
        - footprint
    ErrorMessage:
      type: object
      properties:
        message:
          type: string
        stacktrace:
          type: string
      required:
        - message