openapi: 3.0.3
info:
  title: OneAtlas WorldDEM Access SPOT and Pleiades ordering API
  version: 1.0.1
  contact:
    email: dl-geo-webservices@airbus.com
  description: The OneAtlas WorldDEM API is a tool that provides access to high-resolution global elevation data. This data, collected by satellites and processed using advanced technologies, offers a detailed and accurate representation of the Earth's surface. By integrating the WorldDEM API into their applications, users can benefit from precise terrain information for a wide range of use cases, such as urban planning, disaster response, agriculture, and infrastructure development. This API allows developers to easily incorporate elevation data into their projects, enabling them to create more accurate and effective solutions.
servers:
- url: https://sar.api.oneatlas.airbus.com/v1
  description: OneAtlas - Elevation
security:
- basicAuth: []
tags:
- name: SPOT and Pleiades ordering
paths:
  /api/v1/orders:
    get:
      description: Get all orders
      summary: Get All Orders
      tags:
      - SPOT and Pleiades ordering
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/itemsPerPage'
      - description: Filter orders by status
        in: query
        name: status
        schema:
          type: string
      - description: Filter orders by kind
        in: query
        name: kind
        schema:
          type: string
      - description: Filter orders by tags, comma-separated values
        in: query
        name: tags
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $schema: http://json-schema.org/draft-06/schema#
                  description: Orders api
                  id: http://local/schemas/public/orders.json
                  oneOf:
                  - properties:
                      kind:
                        pattern: ^order.product$
                      products:
                        oneOf:
                        - required:
                          - sourceId
                          - aoi
                          - productType
                          - radiometricProcessing
                          - imageFormat
                          - crsCode
                        - required:
                          - id
                          - aoi
                          - productType
                          - radiometricProcessing
                          - imageFormat
                          - crsCode
                        properties:
                          aoi:
                            $schema: http://json-schema.org/draft-06/schema#
                            definitions:
                              multiPolygonAoi:
                                properties:
                                  coordinates:
                                    items:
                                      items:
                                        items:
                                          items:
                                            type: number
                                          maxItems: 2
                                          minItems: 2
                                          type: array
                                        minItems: 4
                                        type: array
                                      minItems: 1
                                      type: array
                                    minItems: 1
                                    type: array
                                  type:
                                    enum:
                                    - MultiPolygon
                                type: object
                              polygonAoi:
                                properties:
                                  coordinates:
                                    items:
                                      items:
                                        items:
                                          type: number
                                        maxItems: 2
                                        minItems: 2
                                        type: array
                                      minItems: 4
                                      type: array
                                    minItems: 1
                                    type: array
                                  type:
                                    enum:
                                    - Polygon
                                type: object
                            description: aoi definition
                            id: http://local/schemas/public/aoi.json#
                            properties:
                              coordinates:
                                items:
                                  items:
                                    items:
                                      items:
                                        type: number
                                      maxItems: 2
                                      minItems: 2
                                      type: array
                                    minItems: 4
                                    type: array
                                  minItems: 1
                                  type: array
                                minItems: 1
                                type: array
                              type:
                                enum:
                                - MultiPolygon
                            title: aoi
                            type: object
                          crsCode:
                            const: urn:ogc:def:crs:EPSG::4326
                            description: The spatial reference system of the output image.
                            title: The output srs
                            type: string
                          id:
                            type: string
                          imageFormat:
                            const: image/jp2
                            type: string
                          productType:
                            description: ''
                            enum:
                            - bundle
                            title: Product type
                            type: string
                          radiometricProcessing:
                            default: REFLECTANCE
                            description: 'Reflectance: image radiometry is corrected from atmospheric effects.'
                            enum:
                            - REFLECTANCE
                            title: Radiometric Processing
                            type: string
                          sourceId:
                            type: string
                        type: object
                      tags:
                        items:
                          pattern: ^[a-zA-Z]+$
                          type: string
                        type: array
                    required:
                    - products
                    - kind
                    type: object
                  - properties:
                      kind:
                        pattern: ^order.subscription.streaming$
                      subscription:
                        additionalProperties: false
                        properties:
                          duration:
                            minimum: 1
                            type: integer
                          geofence:
                            $schema: http://json-schema.org/draft-06/schema#
                            definitions:
                              multiPolygonAoi:
                                properties:
                                  coordinates:
                                    items:
                                      items:
                                        items:
                                          items:
                                            type: number
                                          maxItems: 2
                                          minItems: 2
                                          type: array
                                        minItems: 4
                                        type: array
                                      minItems: 1
                                      type: array
                                    minItems: 1
                                    type: array
                                  type:
                                    enum:
                                    - MultiPolygon
                                type: object
                              polygonAoi:
                                properties:
                                  coordinates:
                                    items:
                                      items:
                                        items:
                                          type: number
                                        maxItems: 2
                                        minItems: 2
                                        type: array
                                      minItems: 4
                                      type: array
                                    minItems: 1
                                    type: array
                                  type:
                                    enum:
                                    - Polygon
                                type: object
                            description: aoi definition
                            id: http://local/schemas/public/aoi.json#
                            oneOf:
                            - properties:
                                coordinates:
                                  items:
                                    items:
                                      items:
                                        type: number
                                      maxItems: 2
                                      minItems: 2
                                      type: array
                                    minItems: 4
                                    type: array
                                  minItems: 1
                                  type: array
                                type:
                                  enum:
                                  - Polygon
                              type: object
                            - properties:
                                coordinates:
                                  items:
                                    items:
                                      items:
                                        items:
                                          type: number
                                        maxItems: 2
                                        minItems: 2
                                        type: array
                                      minItems: 4
                                      type: array
                                    minItems: 1
                                    type: array
                                  minItems: 1
                                  type: array
                                type:
                                  enum:
                                  - MultiPolygon
                              type: object
                            title: aoi
                            type: object
                          monthlyPrice:
                            type: number
                          paymentModality:
                            enum:
                            - monthly
                            - full
                          startedAt:
                            description: ISO 8061 Notation
                            pattern: \s*[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])\s*
                            type: string
                          streamingPlan:
                            pattern: ^custom$
                          tileAmount:
                            type: integer
                          title:
                            type: string
                          type:
                            pattern: ^view$
                        required:
                        - type
                        - duration
                        - paymentModality
                        - tileAmount
                        - monthlyPrice
                        - streamingPlan
                        type: object
                      tags:
                        items:
                          pattern: ^[a-zA-Z]+$
                          type: string
                        type: array
                    required:
                    - subscription
                    - kind
                    type: object
                  - properties:
                      kind:
                        pattern: ^order.subscription.change-detection$
                      subscription:
                        additionalProperties: false
                        properties:
                          aoi:
                            properties:
                              coordinates:
                                items:
                                  items:
                                    items:
                                      type: number
                                    maxItems: 2
                                    minItems: 2
                                    type: array
                                  minItems: 4
                                  type: array
                                minItems: 1
                                type: array
                              type:
                                enum:
                                - Polygon
                            type: object
                          duration:
                            enum:
                            - 3
                            - 6
                            - 12
                          frequency:
                            enum:
                            - monthly
                          resolution:
                            enum:
                            - 0.5
                            - 1.5
                          startedAt:
                            description: ISO 8061 Notation
                            pattern: \s*[0-9]{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])\s*
                            type: string
                          title:
                            type: string
                          type:
                            pattern: ^change-detection$
                        required:
                        - aoi
                        - type
                        - resolution
                        - duration
                        type: object
                      tags:
                        items:
                          pattern: ^[a-zA-Z]+$
                          type: string
                        type: array
                    required:
                    - subscription
                    - kind
                    type: object
                  title: Orders
                type: array
          description: List of all orders
components:
  parameters:
    itemsPerPage:
      description: Amount of items per page, defaults to '10'
      in: query
      name: itemsPerPage
      schema:
        minimum: 1
        type: number
    page:
      description: Page number, defaults to '1'
      in: query
      name: page
      schema:
        minimum: 1
        type: number
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic