openapi: 3.2.0
info:
  title: OpenAgri Farm Calendar Observations API
  version: 1.0.0
  description: API for farm assets and other farm related things.
tags:
- name: Observations
paths:
  /api/v1/Observations/:
    get:
      operationId: api_v1_Observations_list
      description: API endpoint that allows Observation to be viewed or edited.
      parameters:
      - in: query
        name: activity_type
        schema:
          type: string
          format: uuid
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - jsonld
      - in: query
        name: fromDate
        schema:
          type: string
          format: date-time
      - in: query
        name: parcel
        schema:
          type: string
          format: uuid
      - in: query
        name: title
        schema:
          type: string
      - in: query
        name: toDate
        schema:
          type: string
          format: date-time
      tags:
      - Observations
      security:
      - cookieAuth: []
      responses:
        '200':
          content:
            application/ld+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Observation'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Observation'
          description: ''
      summary: Api v1 observations list
      x-summary-source: derived
    post:
      operationId: api_v1_Observations_create
      description: API endpoint that allows Observation to be viewed or edited.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - jsonld
      tags:
      - Observations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Observation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Observation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Observation'
        required: true
      security:
      - cookieAuth: []
      responses:
        '201':
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Observation'
            application/json:
              schema:
                $ref: '#/components/schemas/Observation'
          description: ''
      summary: Api v1 observations create
      x-summary-source: derived
  /api/v1/Observations/{id}/:
    get:
      operationId: api_v1_Observations_retrieve
      description: API endpoint that allows Observation to be viewed or edited.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - jsonld
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Observation.
        required: true
      tags:
      - Observations
      security:
      - cookieAuth: []
      responses:
        '200':
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Observation'
            application/json:
              schema:
                $ref: '#/components/schemas/Observation'
          description: ''
      summary: Api v1 observations retrieve
      x-summary-source: derived
    put:
      operationId: api_v1_Observations_update
      description: API endpoint that allows Observation to be viewed or edited.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - jsonld
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Observation.
        required: true
      tags:
      - Observations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Observation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Observation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Observation'
        required: true
      security:
      - cookieAuth: []
      responses:
        '200':
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Observation'
            application/json:
              schema:
                $ref: '#/components/schemas/Observation'
          description: ''
      summary: Api v1 observations update
      x-summary-source: derived
    patch:
      operationId: api_v1_Observations_partial_update
      description: API endpoint that allows Observation to be viewed or edited.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - jsonld
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Observation.
        required: true
      tags:
      - Observations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedObservation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedObservation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedObservation'
      security:
      - cookieAuth: []
      responses:
        '200':
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/Observation'
            application/json:
              schema:
                $ref: '#/components/schemas/Observation'
          description: ''
      summary: Api v1 observations partial update
      x-summary-source: derived
    delete:
      operationId: api_v1_Observations_destroy
      description: API endpoint that allows Observation to be viewed or edited.
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - jsonld
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this Observation.
        required: true
      tags:
      - Observations
      security:
      - cookieAuth: []
      responses:
        '204':
          description: No response body
      summary: Api v1 observations destroy
      x-summary-source: derived
components:
  schemas:
    GenericQuantityValueField:
      type: object
      properties:
        unit:
          type:
          - string
          - 'null'
        hasValue:
          type: string
      required:
      - hasValue
    Observation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        activityType:
          type: string
          format: uuid
        title:
          type: string
          maxLength: 200
        details:
          type:
          - string
          - 'null'
        phenomenonTime:
          type: string
          format: date-time
        hasEndDatetime:
          type:
          - string
          - 'null'
          format: date-time
        hasAgriParcel:
          type: string
          format: uuid
        madeBySensor:
          allOf:
          - $ref: '#/components/schemas/MadeBySensorField'
        hasResult:
          $ref: '#/components/schemas/GenericQuantityValueField'
        observedProperty:
          type: string
      required:
      - activityType
      - hasAgriParcel
      - hasResult
      - id
      - observedProperty
      - phenomenonTime
    PatchedObservation:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        activityType:
          type: string
          format: uuid
        title:
          type: string
          maxLength: 200
        details:
          type:
          - string
          - 'null'
        phenomenonTime:
          type: string
          format: date-time
        hasEndDatetime:
          type:
          - string
          - 'null'
          format: date-time
        hasAgriParcel:
          type: string
          format: uuid
        madeBySensor:
          allOf:
          - $ref: '#/components/schemas/MadeBySensorField'
        hasResult:
          $ref: '#/components/schemas/GenericQuantityValueField'
        observedProperty:
          type: string
    MadeBySensorField:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
      required:
      - name
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid