openapi.yml

openapi: 3.0.0

info:
  title: Dataverse app
  description: App to query a dataverse instance
  version: 0.0.1
  x-products:
    - name: Single product
  x-api-version: 0.4.0
servers:
  - url: https://dataverse.materials-data.space

paths:
  /heartbeat:
    get:
      description: Check if the application is active
      operationId: heartbeat
      responses:
        '200':
          description: Success
        '401':
          $ref: '#/components/responses/UnauthorizedError'

  /dataset:
    get:
      description: Fetches list of datasets
      operationId: listDatasets
      responses:
        '200':
          description: Success
        '404':
          description: Not found
        '401':
          $ref: '#/components/responses/UnauthorizedError'

  /dataset/{datasetId}:
    get:
      description: Fetches a particular Dataset
      operationId: getDataset
      parameters:
        - in: path
          name: datasetId
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Success
          content:
            "*/*":
              schema:
                type: object
        '404':
          description: Not found
        '401':
          $ref: '#/components/responses/UnauthorizedError'

  /metadata/{datasetId}:
    head:
      description: fetch information about certain sets of data
      operationId: getDatasetMetadata
      parameters:
        - in: path
          name: datasetId
          schema:
            type: string
          required: true
      responses:
        '200':
          description: Success
          content:
            "*/*":
              schema:
                type: object
        '404':
          description: Not found
        '401':
          $ref: '#/components/responses/UnauthorizedError'

  /globalSearch:
    get:
      summary: GlobalSearch
      description: globalSearch
      operationId: globalSearch
      parameters:
        - in: query
          name: q
          schema:
            type: string
          required: true
      responses:
        "200":
          description: Successful Response
        '401':
          $ref: '#/components/responses/UnauthorizedError'

components:
  responses:
    UnauthorizedError:
      description: Access token is missing or invalid