ADHDEvaluations Sources API

openapi: 3.2.0
info:
  title: ADHDEvaluations Sources API
  version: '1'
  description: The read API is free, needs no key and reads only. The admin routes under /admin/ need an admin session. Every read response carries `meta.attribution` and `meta.sources`.
servers:
- url: https://adhdevaluations.fyi/api/v1
tags:
- name: Sources
paths:
  /sources:
    get:
      summary: List the data sources with license and refresh
      operationId: getSources
      parameters: []
      responses:
        '200':
          description: Success.
          headers:
            RateLimit-Limit:
              description: Requests allowed per window. 300.
              schema:
                type: string
            RateLimit-Policy:
              description: The policy as `limit;w=seconds`. `300;w=60`.
              schema:
                type: string
            Access-Control-Allow-Origin:
              description: '`*`. Any origin may read.'
              schema:
                type: string
            ETag:
              description: A weak validator. Send it back as `If-None-Match`.
              schema:
                type: string
            Cache-Control:
              description: '`public, max-age=60, s-maxage=300, stale-while-revalidate=600`.'
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                - data
                - meta
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Source'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '304':
          description: The `If-None-Match` validator still matches. No body.
          headers:
            RateLimit-Limit:
              description: Requests allowed per window. 300.
              schema:
                type: string
            RateLimit-Policy:
              description: The policy as `limit;w=seconds`. `300;w=60`.
              schema:
                type: string
            Access-Control-Allow-Origin:
              description: '`*`. Any origin may read.'
              schema:
                type: string
            ETag:
              description: A weak validator. Send it back as `If-None-Match`.
              schema:
                type: string
            Cache-Control:
              description: '`public, max-age=60, s-maxage=300, stale-while-revalidate=600`.'
              schema:
                type: string
        '400':
          description: A parameter is unknown, repeated, empty or invalid. `code` is `invalid_parameter` or `invalid_cursor`.
          headers:
            RateLimit-Limit:
              description: Requests allowed per window. 300.
              schema:
                type: string
            RateLimit-Policy:
              description: The policy as `limit;w=seconds`. `300;w=60`.
              schema:
                type: string
            Access-Control-Allow-Origin:
              description: '`*`. Any origin may read.'
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Over the limit of 300 requests per 60 seconds. `code` is `rate_limited`.
          headers:
            RateLimit-Limit:
              description: Requests allowed per window. 300.
              schema:
                type: string
            RateLimit-Policy:
              description: The policy as `limit;w=seconds`. `300;w=60`.
              schema:
                type: string
            Access-Control-Allow-Origin:
              description: '`*`. Any origin may read.'
              schema:
                type: string
            Retry-After:
              description: Seconds to wait. 60.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: An error on the server. `code` is `internal_error`.
          headers:
            RateLimit-Limit:
              description: Requests allowed per window. 300.
              schema:
                type: string
            RateLimit-Policy:
              description: The policy as `limit;w=seconds`. `300;w=60`.
              schema:
                type: string
            Access-Control-Allow-Origin:
              description: '`*`. Any origin may read.'
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The database is briefly overloaded. `code` is `unavailable`.
          headers:
            RateLimit-Limit:
              description: Requests allowed per window. 300.
              schema:
                type: string
            RateLimit-Policy:
              description: The policy as `limit;w=seconds`. `300;w=60`.
              schema:
                type: string
            Access-Control-Allow-Origin:
              description: '`*`. Any origin may read.'
              schema:
                type: string
            Retry-After:
              description: Seconds to wait. 5.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Sources
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: A sentence for a person.
        code:
          type: string
          enum:
          - invalid_parameter
          - invalid_cursor
          - not_found
          - method_not_allowed
          - rate_limited
          - internal_error
          - unavailable
          description: Stable. Branch on this, not on `error`.
        details:
          description: One entry per bad parameter, on `invalid_parameter`.
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
            required:
            - field
            - message
            additionalProperties: false
      required:
      - error
      - code
      additionalProperties: false
    Source:
      type: object
      properties:
        key:
          type: string
        name:
          type: string
        url:
          type: string
        license:
          type: string
          description: The license of the data taken from this source.
        refresh:
          type: string
          description: How often the source is re-imported.
        notes:
          type:
          - string
          - 'null'
      required:
      - key
      - name
      - url
      - license
      - refresh
      - notes
      additionalProperties: false
    Meta:
      type: object
      properties:
        attribution:
          type: object
          properties:
            name:
              type: string
            url:
              type: string
            text:
              type: string
              description: Credit line to show next to the data.
          required:
          - name
          - url
          - text
          additionalProperties: false
        sources:
          type: array
          items:
            $ref: '#/components/schemas/Source'
          description: Where the data comes from, with the license of each source.
      required:
      - attribution
      - sources
      additionalProperties: false