clone/nocodb
1
0
Fork 0
mirror of https://github.com/nocodb/nocodb.git synced 2026-04-25 02:35:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

address feedback

Browse Source
This commit is contained in:
Fendy Heryanto
2025-11-26 10:27:16 +00:00
parent 3603ab34b0
commit 4fa97b6bbb
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/nocodb/src/services/api-docs/swaggerV3/templates/params.ts
View File

@@ -19,7 +19,7 @@ export const fieldsParam = {
in: 'query',
name: 'fields',
description:
'Specify fields to include in the API response. A string representing array of field names or field ids. \n\nExample: fields=`["field1"]` or fields=`["field1","field2"]` will include only field1 (with field2 on 2nd example) in the response.',
'Specify fields to include in the API response. String representing stringified JSON array of field names or field ids. \n\nExample: fields=`["field1"]` or fields=`["field1","field2"]` will include only field1 (with field2 on 2nd example) in the response.',
};
export const sortParam = {
schema: {
@@ -28,7 +28,7 @@ export const sortParam = {
in: 'query',
name: 'sort',
description:
'Allows you to specify the fields by which you want to sort the records in your API response. A string representing array of JSON objects. Each object must have a \'field\' property specifying the field name and an optional \'direction\' property with value \'asc\' or \'desc\'. If **viewId** query parameter is also included, the sort included here will take precedence over any sorting configuration defined in the view. \n\nExample: sort=`[{"direction":"asc", "field":"field1"}]` will sort records in ascending order based on field1.',
'Allows you to specify the fields by which you want to sort the records in your API response. A string representing stringified JSON array of objects. Each object must have a \'field\' property specifying the field name and an optional \'direction\' property with value \'asc\' or \'desc\'. If **viewId** query parameter is also included, the sort included here will take precedence over any sorting configuration defined in the view. \n\nExample: sort=`[{"direction":"asc", "field":"field1"}]` will sort records in ascending order based on field1.',
examples: {
oneField: {
value: '[{ "direction": "asc", "field": "field1" }]',