From 7dee5757fbd6c2eb6ac162bcc51f5105ae3bc2e3 Mon Sep 17 00:00:00 2001
From: esikkala <esko.ikkala@aalto.fi>
Date: Mon, 30 Aug 2021 17:30:57 +0300
Subject: [PATCH] OpenAPI spec: add some example values
---
src/server/openapi.yaml | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/src/server/openapi.yaml b/src/server/openapi.yaml
index 3e3d3dc8..3106b614 100644
--- a/src/server/openapi.yaml
+++ b/src/server/openapi.yaml
@@ -94,7 +94,7 @@ paths:
name: resultClass
schema:
type: string
- example: perspective1
+ example: placesMsProduced
required: true
description: The class of the results
requestBody:
@@ -210,12 +210,14 @@ paths:
name: facetClass
schema:
type: string
+ example: perspective1
required: true
description: The class of the facet
- in: path
name: id
schema:
type: string
+ example: language
required: true
description: The id of the facet
requestBody:
@@ -227,8 +229,10 @@ paths:
properties:
sortBy:
type: string
+ example: instanceCount
sortDirection:
type: string
+ example: desc
constraints:
type: array
items:
@@ -273,12 +277,14 @@ paths:
name: resultClass
schema:
type: string
+ example: perspective1
required: true
description: The class of the resource
- in: path
name: uri
schema:
type: string
+ example: http://ldf.fi/mmm/manifestation_singleton/bibale_10003
required: true
description: The URI of the resource
requestBody:
@@ -545,14 +551,15 @@ paths:
application/json:
schema:
type: object
- /void/{perspectiveID}:
+ /void/{resultClass}:
get:
summary: Retrieve a VoID description
parameters:
- in: path
- name: perspectiveID
+ name: resultClass
schema:
type: string
+ example: perspective1KnowledgeGraphMetadata
required: true
responses:
'200':
--
GitLab