MS-1141: Update docs for List Model Catalog search, filters, paginati… - #1214
Conversation
| example: '"text-to-text"' | ||
| type: string | ||
| type: object | ||
| apiModelCatalogSortBy: |
There was a problem hiding this comment.
This enum schema is incomplete - it only has default and description
Please add type: string, the full enum list, and an example, matching apiSortDirection / apiModelEvaluationRunSortField
available_sort_by refs this schema, so without the enum docs won't get the allowed values
There was a problem hiding this comment.
got it. added type, enum list, example and extended description
| default: MODEL_CATALOG_SORT_BY_CREATED_AT | ||
| description: |- | ||
| Field on which to sort model catalog results. | ||
| apiModelCatalogUseCase: |
There was a problem hiding this comment.
Same issue as apiModelCatalogSortBy
There was a problem hiding this comment.
added type, enum, example and extended description
| items: | ||
| type: string | ||
| type: array | ||
| - default: MODEL_CATALOG_SORT_BY_CREATED_AT |
There was a problem hiding this comment.
default is on the parameter object, but OpenAPI 3 expects it under schema
There was a problem hiding this comment.
moved default under schema
| name: per_page | ||
| schema: | ||
| type: integer | ||
| - default: SORT_DIRECTION_UNSPECIFIED |
There was a problem hiding this comment.
Same fix needed for sort_direction and use_case [line91]. See genai_list_model_evaluation_runs.yml for the pattern.
There was a problem hiding this comment.
moved default under schema
| schema: | ||
| type: integer | ||
| - description: Partial, case-insensitive match on the model's display name. | ||
| example: '"example string"' |
There was a problem hiding this comment.
prefer a real value like llama (and similarly for sort_by / sort_direction / use_case)
| curl -X GET \ | ||
| -H "Content-Type: application/json" \ | ||
| "https://api.digitalocean.com/v2/gen-ai/models/catalog" | ||
| "https://api.digitalocean.com/v2/gen-ai/models/catalog?page=1&per_page=20&search=llama&model_type=chat&sort_by=MODEL_CATALOG_SORT_BY_NAME&sort_direction=SORT_DIRECTION_ASC" |
There was a problem hiding this comment.
missing Authorization header. Please add it for consistency
There was a problem hiding this comment.
added Authorization Bearer header
2 participants
Summary
Document the List Model Catalog API (
GET /v2/gen-ai/models/catalog) so the public OpenAPI spec matches the live GenAI API. This unblocks docs.digitalocean.com and downstream pydo regeneration for search, filtering, pagination, sorting, and badges.Changes
search,model_type,provider,availability,badges,sort_by,per_page,sort_direction, anduse_casepage; marklimitas deprecated in favor ofper_pageavailable_model_types,available_providers,available_availability,available_badges,available_sort_by, andavailable_sort_directionsapiModelCatalogSortByandapiModelCatalogUseCaseenums to definitionsTest plan
make previewand verify List Model Catalog shows the new params and response fields