From 02e4929a9767d48782da08fb5a3aac06443ea7ac Mon Sep 17 00:00:00 2001
From: syuilo <syuilotan@yahoo.co.jp>
Date: Sun, 24 Feb 2019 19:27:32 +0900
Subject: [PATCH] Improve doc
---
src/server/api/openapi/schemas.ts | 15 +++++++++++----
1 file changed, 11 insertions(+), 4 deletions(-)
diff --git a/src/server/api/openapi/schemas.ts b/src/server/api/openapi/schemas.ts
index a57be81502..a8d684923b 100644
--- a/src/server/api/openapi/schemas.ts
+++ b/src/server/api/openapi/schemas.ts
@@ -33,7 +33,8 @@ export const schemas = {
id: {
type: 'string',
format: 'id',
- description: 'The unique identifier for this User.'
+ description: 'The unique identifier for this User.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
username: {
type: 'string',
@@ -102,7 +103,8 @@ export const schemas = {
id: {
type: 'string',
format: 'id',
- description: 'The unique identifier for this Note.'
+ description: 'The unique identifier for this Note.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
createdAt: {
type: 'string',
@@ -125,10 +127,12 @@ export const schemas = {
replyId: {
type: 'string',
format: 'id',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
renoteId: {
type: 'string',
format: 'id',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
reply: {
$ref: '#/components/schemas/Note'
@@ -152,7 +156,8 @@ export const schemas = {
id: {
type: 'string',
format: 'id',
- description: 'The unique identifier for this notification.'
+ description: 'The unique identifier for this notification.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
createdAt: {
type: 'string',
@@ -174,7 +179,8 @@ export const schemas = {
id: {
type: 'string',
format: 'id',
- description: 'The unique identifier for this Drive file.'
+ description: 'The unique identifier for this Drive file.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
createdAt: {
type: 'string',
@@ -207,6 +213,7 @@ export const schemas = {
format: 'id',
nullable: true,
description: 'The parent folder ID of this Drive file.',
+ example: 'xxxxxxxxxxxxxxxxxxxxxxxx',
},
isSensitive: {
type: 'boolean',