Skip to content

docs: tighten research endpoint schemas to match handler enforcement #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sweetmantech merged 1 commit into from
Apr 15, 2026
Merged

docs: tighten research endpoint schemas to match handler enforcement #134

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 58 additions & 8 deletions api-reference/openapi/research.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1047,7 +1047,8 @@
"required": true,
"description": "Chart platform: spotify, applemusic, tiktok, youtube, itunes, shazam, etc.",
"schema": {
"type": "string"
"type": "string",
"pattern": "^[a-z]+$"
}
},
{
Expand Down Expand Up @@ -1305,7 +1306,9 @@
"required": false,
"description": "ISO country code (e.g., US, BR, GB).",
"schema": {
"type": "string"
"type": "string",
"minLength": 2,
"maxLength": 2
}
},
{
Expand Down Expand Up @@ -1348,7 +1351,9 @@
"required": false,
"schema": {
"type": "integer",
"default": 20
"default": 20,
"minimum": 1,
"maximum": 100
}
}
],
Expand Down Expand Up @@ -2008,6 +2013,46 @@
"type": "integer",
"default": 20
}
},
{
"name": "indie",
"in": "query",
"description": "Include indie playlists.",
"schema": {
"type": "boolean"
}
},
{
"name": "majorCurator",
"in": "query",
"description": "Include major-curator playlists.",
"schema": {
"type": "boolean"
}
},
{
"name": "popularIndie",
"in": "query",
"description": "Include popular indie playlists.",
"schema": {
"type": "boolean"
}
},
{
"name": "personalized",
"in": "query",
"description": "Include personalized playlists.",
"schema": {
"type": "boolean"
}
},
{
"name": "chart",
"in": "query",
"description": "Include chart playlists.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
Expand Down Expand Up @@ -2201,7 +2246,8 @@
"high",
"medium",
"low"
]
],
"default": "medium"
}
},
{
Expand All @@ -2215,7 +2261,8 @@
"high",
"medium",
"low"
]
],
"default": "medium"
}
},
{
Expand All @@ -2229,7 +2276,8 @@
"high",
"medium",
"low"
]
],
"default": "medium"
}
},
{
Expand All @@ -2243,7 +2291,8 @@
"high",
"medium",
"low"
]
],
"default": "medium"
}
},
{
Expand Down Expand Up @@ -3974,7 +4023,8 @@
"format": "uri"
},
"maxItems": 10,
"description": "URLs to extract content from (max 10)."
"description": "URLs to extract content from (max 10).",
"minItems": 1
},
"objective": {
"type": "string",
Expand Down