mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-06-18 08:14:24 +00:00
59 lines
1.3 KiB
YAML
59 lines
1.3 KiB
YAML
---
|
|
openapi: "3.0.0"
|
|
info:
|
|
version: "1.0.0"
|
|
title: "Chill api"
|
|
description: "Api documentation for chill. Currently, work in progress"
|
|
servers:
|
|
- url: "/api"
|
|
description: "Your current dev server"
|
|
|
|
components:
|
|
schemas:
|
|
Center:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
|
|
paths:
|
|
/1.0/search.json:
|
|
get:
|
|
summary: perform a search across multiple entities
|
|
tags:
|
|
- search
|
|
- person
|
|
- thirdparty
|
|
description: >
|
|
**Warning**: This is currently a stub (not really implemented
|
|
|
|
The search is performed across multiple entities. The entities must be listed into
|
|
`type` parameters.
|
|
|
|
The results are ordered by relevance, from the most to the lowest relevant.
|
|
|
|
parameters:
|
|
- name: q
|
|
in: query
|
|
required: true
|
|
description: the pattern to search
|
|
schema:
|
|
type: string
|
|
- name: type[]
|
|
in: query
|
|
required: true
|
|
description: the type entities amongst the search is performed
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- person
|
|
- thirdparty
|
|
responses:
|
|
200:
|
|
description: "OK"
|
|
|