openapi: 3.1.0

info:
  title: DAS Reports REST API
  summary: REST API for DAS reports
  description: This API allows clients to retrieve reports.
  termsOfService: https://map.dasintel.io/file/das_terms_of_service.pdf
  contact:
    name: Customer Support
    url: https://info.digitalagricultureservices.com/en-au/contact-us
    email: support@dasintel.io
  license:
    name: Apache 2.0
    identifier: Apache-2.0
  version: 0.0.0

jsonSchemaDialect: https://spec.openapis.org/oas/3.1/dialect/base

servers:
  - url: https://api.dasintel.io
    description: Production server

paths:
  /reports/{id}:
    get:
      summary: Get report
      description: >-
        This resource represents a user created report. Each report is identified by
        a unique ID. The report is represented as a JSON object.
      operationId: get-report
      parameters:
        - in: header
          name: X-Api-Version
          description: The version of the API as a date in YYYY-MM-DD format
          required: true
          schema:
            type: string
            format: date
            enum:
              - '2026-03-01'
        - in: header
          name: Accept
          description: The media type that the request will accept
          schema:
            type: string
            enum:
              - application/json
          required: true
        - in: path
          name: id
          description: The unique identifier of the report
          required: true
          schema:
            type: string
            format: uuid
            examples:
              - 0712cb4a-ec84-4565-bc9b-04b011d5ca9a
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: https://schema.dasintel.io/report/valuation-report-rest-0.0.0.json
        '401':
          description: API key is missing or invalid
          headers:
            WWW-Authenticate:
              schema:
                type: string
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error

components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        The API key is used to authenticate requests to the DAS Reports API.
        It should be included in the header of each request.

security:
  - apiKeyAuth: [ ]

externalDocs:
  description: More information on the DAS Developers' Hub
  url: https://developers.dasintel.io/docs/api
