natty
/
calckey
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs: 📝 descriptions for notes/children+conversation endpoints

This commit is contained in:
ThatOneCalculator 2023-07-14 23:16:50 -07:00
parent 4dc3d090dd
commit e3b8c05e47
No known key found for this signature in database
GPG Key ID: 8703CACD01000000
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/backend/src/server/api/endpoints/notes/children.ts
View File

@ -10,6 +10,7 @@ export const meta = {
requireCredential: false, requireCredential: false,
requireCredentialPrivateMode: true, requireCredentialPrivateMode: true,
description: "Get threaded/chained replies to a note",
res: { res: {
type: "array", type: "array",

3
packages/backend/src/server/api/endpoints/notes/conversation.ts
View File

@ -9,6 +9,7 @@ export const meta = {
requireCredential: false, requireCredential: false,
requireCredentialPrivateMode: true, requireCredentialPrivateMode: true,
description: "Get conversation of a note thread/chain by a reply",
res: { res: {
type: "array", type: "array",
@ -34,7 +35,7 @@ export const meta = {
export const paramDef = { export const paramDef = {
type: "object", type: "object",
properties: { properties: {
noteId: { type: "string", format: "misskey:id" }, noteId: { type: "string", format: "misskey:id", description: "Should be a reply" },
limit: { type: "integer", minimum: 1, maximum: 100, default: 10 }, limit: { type: "integer", minimum: 1, maximum: 100, default: 10 },
offset: { type: "integer", default: 0 }, offset: { type: "integer", default: 0 },
}, },