Skip to content

Commit 6005160

Browse files
committed
- Fixed doc type for fields, sorts, includes and appends
1 parent 3629ea3 commit 6005160

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

src/Concerns/ApiDocHelpers.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -205,10 +205,10 @@ public static function apiFieldsDescription(): string
205205
public static function apiDocGenerateFieldsMetadata(array $fields): array
206206
{
207207
return [
208-
'type' => 'string',
208+
'type' => 'string[]',
209209
'description' => static::apiFieldsDescription(),
210210
'enumValues' => $fields,
211-
'example' => implode(',', $fields),
211+
'example' => $fields,
212212
];
213213
}
214214

@@ -227,11 +227,11 @@ public static function apiSortsDescription(): string
227227
public static function apiDocGenerateSortsMetadata(array $sorts, string $default_sort = ''): array
228228
{
229229
return [
230-
'type' => 'string',
230+
'type' => 'string[]',
231231
'description' => static::apiSortsDescription() .
232232
'<br>**Default sort:** ' . ($default_sort ? '`' . $default_sort . '`' : 'None'),
233233
'enumValues' => $sorts,
234-
'example' => $default_sort,
234+
'example' => [$default_sort],
235235
];
236236
}
237237

@@ -251,10 +251,10 @@ public static function apiAppendsDescription(): string
251251
public static function apiDocGenerateAppendsMetadata(array $appends): array
252252
{
253253
return [
254-
'type' => 'string',
254+
'type' => 'string[]',
255255
'description' => static::apiAppendsDescription(),
256256
'enumValues' => $appends,
257-
'example' => implode(',', $appends),
257+
'example' => $appends,
258258
];
259259
}
260260

@@ -274,10 +274,10 @@ public static function apiIncludesDescription(): string
274274
public static function apiDocGenerateIncludesMetadata(array $includes): array
275275
{
276276
return [
277-
'type' => 'string',
277+
'type' => 'string[]',
278278
'description' => static::apiIncludesDescription(),
279279
'enumValues' => $includes,
280-
'example' => implode(',', $includes),
280+
'example' => $includes,
281281
];
282282
}
283283

@@ -337,19 +337,19 @@ public static function apiDocDefaultQueryParameters(
337337
$params = [];
338338

339339
if ($fields) {
340-
$params['fields'] = static::apiDocGenerateFieldsMetadata($fields);
340+
$params['fields[]'] = static::apiDocGenerateFieldsMetadata($fields);
341341
}
342342

343343
if ($sorts) {
344-
$params['sort'] = static::apiDocGenerateSortsMetadata($sorts, $default_sort);
344+
$params['sort[]'] = static::apiDocGenerateSortsMetadata($sorts, $default_sort);
345345
}
346346

347347
if ($appends) {
348-
$params['append'] = static::apiDocGenerateAppendsMetadata($appends);
348+
$params['append[]'] = static::apiDocGenerateAppendsMetadata($appends);
349349
}
350350

351351
if ($includes) {
352-
$params['include'] = static::apiDocGenerateIncludesMetadata($includes);
352+
$params['include[]'] = static::apiDocGenerateIncludesMetadata($includes);
353353
}
354354

355355
if ($include_pagination) {

0 commit comments

Comments
 (0)