chore(oas): general fixes to OAS (#9413)

General fixes to OAS
This commit is contained in:
Shahed Nasser
2024-10-02 18:21:40 +03:00
committed by GitHub
parent 34eebb61eb
commit 5fb9c1f82e
9 changed files with 51 additions and 17 deletions

View File

@@ -37,6 +37,46 @@ class SchemaFactory {
BigNumberValue: {
type: "number",
},
expand: {
type: "string",
title: "expand",
description:
"Comma-separated relations that should be expanded in the returned data.",
},
fields: {
type: "string",
title: "fields",
description:
"Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.",
externalDocs: {
url: "#select-fields-and-relations",
},
},
offset: {
type: "number",
title: "offset",
description: "The number of items to skip when retrieving a list.",
externalDocs: {
url: "#pagination",
},
},
limit: {
type: "number",
title: "limit",
description: "Limit the number of items returned in the list.",
externalDocs: {
url: "#pagination",
},
},
order: {
type: "string",
title: "order",
description:
"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.",
externalDocs: {
url: "#pagination",
},
},
File: {
type: "object",
description: "A File to upload.",