docs(artists): reconcile /api/artists + /socials schemas with the live API#257
Conversation
…e API Surfaced verifying recoupable/api#734 + #735 (recoupable/chat#1833): - Artist: add `id` (= account_id, forgiving alias for /artists/{id}/* sub-resources), `instruction`, `knowledges`, `label`; rename `socials` -> `account_socials` (the field the API actually returns). - SocialProfile: drop `id` — api#735 removed the dead `account_socials.id` from /api/artists/{id}/socials (only `social_id` is returned now). Docs ↔ API now agree field-for-field (verified against the live #734/#735 previews). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 19 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Verified against the live prod API — schemas match field-for-fieldCompared this PR's schemas (
|
| fields | |
|---|---|
| docs (this PR) | account_id, account_socials, id, image, instruction, knowledges, label, name, pinned |
| live prod | account_id, account_socials, id, image, instruction, knowledges, label, name, pinned |
| in docs but not live / in live but not docs | ∅ / ∅ |
Also confirmed live: id === account_id (ebae4bb9…) — the documented alias semantics are real — and the embedded socials field is account_socials (6 entries), matching the rename in this PR.
SocialProfile (GET /api/artists/{id}/socials item) — exact match
| fields | |
|---|---|
| docs (this PR) | avatar, bio, follower_count, following_count, profile_url, region, social_id, updated_at, username |
| live prod | avatar, bio, follower_count, following_count, profile_url, region, social_id, updated_at, username |
| in docs but not live / in live but not docs | ∅ / ∅ |
No id in the live response (api#735 dropped it), and this PR's schema no longer documents it — reconciled.
Before this PR (for contrast)
The old schemas were wrong in both directions: Artist was missing id/instruction/knowledges/label and named the socials field socials; SocialProfile documented an id the API no longer returns. This PR closes all of it.
Docs ↔ API ↔ live prod now tell the same story. (HTTP 200 on both endpoints; auth via a prod bearer token; no secrets echoed.)
Small docs-reconciliation follow-up tracked in recoupable/chat#1833 — surfaced while verifying api#734 (
/api/artistsid) and api#735 (/socialsid) against their previews.Changes (
api-reference/openapi/releases.json)Artistschema:id(=account_id) — api#734 keeps it as a forgiving alias so.id(or.account_id) both resolve for/api/artists/{id}/*sub-resources.instruction,knowledges,label— returned by the API, previously undocumented.socials→account_socials— the field name the API actually returns.SocialProfileschema:id— api#735 removed the deadaccount_socials.idfrom/api/artists/{id}/socials; onlysocial_idis returned now (it's the id that scrape/sub-resources accept).Verified
Both schemas now match the live responses field-for-field (checked against the #734 and #735 preview deployments, Apache fixture):
/api/artistsitem keys:id, account_id, name, image, instruction, knowledges, label, pinned, account_socials/api/artists/{id}/socialsitem keys:social_id, username, profile_url, avatar, bio, follower_count, following_count, region, updated_at(noid)Minimal additive diff (+29/−7); JSON re-validated.
🤖 Generated with Claude Code
Summary by cubic
Aligns the OpenAPI docs for
/api/artistsand/api/artists/{id}/socialswith the live API to remove drift and ensure field-for-field parity.id(alias ofaccount_id),instruction,knowledges,label.socialstoaccount_socialsto match the payload.id; onlysocial_idis returned.Written for commit ba95229. Summary will update on new commits.