UCLouvain

UCLouvain Search API

The Search API from UCLouvain — 2 operation(s) for search.

GitHub OpenAPI

Documentation

📖
Documentation
https://guides.dataverse.org/en/latest/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/openapi/uclouvain-search-api-openapi.yml

Other Resources

🔗
x-json-schema
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/json-schema/uclouvain-dataset-schema.json
🔗
x-json-structure
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/json-structure/uclouvain-dataset-structure.json
🔗
x-example
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/examples/uclouvain-search-example.json
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/rules/uclouvain-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/vocabulary/uclouvain-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/uclouvain/refs/heads/main/json-ld/uclouvain-context.jsonld

OpenAPI Specification

uclouvain-search-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Dataverse Access Search API
  description: Open source research data repository software.
  version: '6.8'
servers:
- url: https://dataverse.uclouvain.be/api
  description: Open Data @ UCLouvain Dataverse instance (v6.8)
tags:
- name: Search
paths:
  /search:
    get:
      operationId: Search_search
      parameters:
      - name: fq
        in: query
        schema:
          type: array
          items:
            type: string
      - name: geo_point
        in: query
        schema:
          type: string
      - name: geo_radius
        in: query
        schema:
          type: string
      - name: metadata_fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: order
        in: query
        schema:
          type: string
      - name: per_page
        in: query
        schema:
          format: int32
          type: integer
      - name: q
        in: query
        schema:
          type: string
      - name: query_entities
        in: query
        schema:
          default: true
          type: boolean
      - name: search_service
        in: query
        schema:
          type: string
      - name: show_api_urls
        in: query
        schema:
          type: boolean
      - name: show_collections
        in: query
        schema:
          type: boolean
      - name: show_entity_ids
        in: query
        schema:
          type: boolean
      - name: show_facets
        in: query
        schema:
          type: boolean
      - name: show_relevance
        in: query
        schema:
          type: boolean
      - name: show_type_counts
        in: query
        schema:
          type: boolean
      - name: sort
        in: query
        schema:
          type: string
      - name: start
        in: query
        schema:
          format: int32
          type: integer
      - name: subtree
        in: query
        schema:
          type: array
          items:
            type: string
      - name: type
        in: query
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
      tags:
      - Search
  /search/services:
    get:
      operationId: Search_getSearchEngines
      responses:
        '200':
          description: OK
      tags:
      - Search