Mireye Sites API

The Sites API from Mireye — 2 operation(s) for sites.

OpenAPI Specification

mireye-sites-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Mireye Earth Ask Sites API
  description: Provenance-tagged geospatial data for US coordinates. POST /v1/fetch for deterministic field values; POST /v1/ask for natural-language Q&A; GET /v1/meta/fields for the catalog.
  version: 0.14.0
tags:
- name: Sites
paths:
  /v1/sites:
    post:
      summary: Register Site
      description: 'Register/bootstrap a site: validate the polygon, kick the dossier build

        ONCE (the slow sieve + fetch), persist it. Idempotent — same polygon →

        same site_id. Questions then go to POST /v1/ask-site with the site_id.'
      operationId: register_site_v1_sites_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SiteRegisterRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sites
  /v1/sites/{site_id}:
    get:
      summary: Get Site
      operationId: get_site_v1_sites__site_id__get
      parameters:
      - name: site_id
        in: path
        required: true
        schema:
          type: string
          title: Site Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Sites
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SiteRegisterRequest:
      properties:
        site:
          additionalProperties: true
          type: object
          title: Site
      type: object
      required:
      - site
      title: SiteRegisterRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError