openapi: 3.2.0
info:
  title: Sheffield Solar Pvlive Eu API
  version: 0.1.0
  description: PV_Live EU API endpoints.
tags:
- name: pvlive_eu
  description: PV_Live EU API endpoints.
paths:
  /pvlive_eu/api/v5/nuts_list:
    get:
      tags:
      - pvlive_eu
      summary: PV_Live_EU NUTS List
      description: List all NUTS region codes and names.
      operationId: pvlive_eu_nuts_list_pvlive_eu_api_v5_nuts_list_get
      parameters:
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /pvlive_eu/api/v5/nuts/{nuts_code}:
    get:
      tags:
      - pvlive_eu
      summary: PV_Live_EU NUTS
      description: Return PVLive EU generation data for the given NUTS region code.
      operationId: pvlive_eu_nuts_pvlive_eu_api_v5_nuts__nuts_code__get
      parameters:
      - name: nuts_code
        in: path
        required: true
        schema:
          type: string
          title: Nuts Code
      - name: start
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: YYYY-mm-ddTHH:MM
          - type: 'null'
          title: Start
        description: 'Optional start time. Format: YYYY-mm-ddTHH:MM'
      - name: end
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: YYYY-mm-ddTHH:MM
          - type: 'null'
          title: End
        description: 'Optional end time. Format: YYYY-mm-ddTHH:MM'
      - name: data_format
        in: query
        required: false
        schema:
          enum:
          - csv
          - json
          type: string
          default: json
          title: Data Format
      - name: extra_field
        in: query
        required: false
        schema:
          type: array
          items:
            enum:
            - bias_error
            - capacity_mwp
            - installedcapacity_mwp
            - lcl_mw
            - site_count
            - stats_error
            - ucl_mw
            - uncertainty_mw
            - updated_gmt
            type: string
          description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
          default: []
          title: Extra Field
        description: 'A repeated query parameter. Example: ?extra_field=capacity_mwp&extra_field=installedcapacity_mwp'
      - name: extra_fields
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Extra Fields
          description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
          deprecated: true
        description: 'Deprecated: Use extra_field instead. A comma-separated list of extra fields to include in the response.'
        deprecated: true
      - name: updated_gmt_from
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated Gmt From
      - name: updated_gmt_to
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated Gmt To
      - name: period
        in: query
        required: false
        schema:
          anyOf:
          - const: '30'
            type: string
          - type: 'null'
          description: 'Deprecated: The 5 minute interval is no longer available. The 30 minute interval is the default.'
          deprecated: true
          title: Period
        description: 'Deprecated: The 5 minute interval is no longer available. The 30 minute interval is the default.'
        deprecated: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /auth/jwt/login
    APIKeyCookie:
      type: apiKey
      in: cookie
      name: ssapi_session
    HTTPBasic:
      type: http
      scheme: basic