docs(docs): add PATCH /api/artists/{id}

[arpitgupta1214]

Summary

• Add Update Artist reference page.
• Document PATCH /api/artists/{id} in releases OpenAPI.
• Add Update Artist entry to Artists navigation.

Notes

• Completes the docs slice for the update capability migration stack.

Summary by CodeRabbit

• New Features

  • Added an API endpoint to update artist profiles, allowing changes to profile info, images, instructions, labels, knowledge entries, social links, and pinned status.

• Documentation

  • Published API reference documentation for the artist update endpoint and added it to the Artists navigation in the docs.

[coderabbitai]

📝 Walkthrough

Walkthrough

Added a new API reference page and registered it in navigation, plus extended the OpenAPI spec with a PATCH /api/artists/{id} operation and related request/response/error schemas for updating artist profiles.

Changes

Cohort / File(s)	Summary
Documentation page & navigation api-reference/artists/update.mdx, docs.json	Added a new MDX page for "Update Artist" and inserted it into the Artists group in docs.json.
OpenAPI specification api-reference/openapi/releases.json	Added PATCH /api/artists/{id} operation, uuid path param, required JSON body referencing UpdateArtistRequest, success schema UpdateArtistResponse (wrapping UpdatedArtist), error schemas for 400/403/404 (UpdateArtistErrorResponse), and component schemas: UpdateArtistRequest, UpdateArtistProfileUrls, ArtistKnowledge, UpdatedArtist, UpdateArtistResponse, UpdateArtistErrorResponse.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

• docs: add artist detail endpoint reference #116 — Adds GET artist detail docs/schemas for /api/artists/{id}, closely related to the same resource’s API surface.
• docs: add artist delete endpoint reference #124 — Adds DELETE /api/artists/{id} docs and OpenAPI entries; modifies the same files and resource group.

Suggested reviewers

• sweetmantech

Poem

🐰 A patch for the artist, neat and spry,
I hop through schemas beneath the sky,
Names, images, knowledges tied with care,
Docs updated — I nibble a pear! 🍐
CodeRabbit cheers with a floppy-eared flair.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The title 'docs(docs): add PATCH /api/artists/{id}' clearly and specifically identifies the main change: adding documentation for the PATCH endpoint to update artists.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/artist-update-endpoints

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[cubic-dev-ai]

1 issue found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="api-reference/openapi/releases.json">

<violation number="1" location="api-reference/openapi/releases.json:3403">
P2: The `missing_fields` description says "Path to the first invalid field" (singular) but the type is an `array` of strings. Align with the existing `CreateArtistError` schema which uses "List of missing or invalid field names", or clarify that the array represents path segments.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.}

[sweetmantech]

KISS principle. Don't mention auth in the initial API description. Keep it simple for devs and LLMs to answer the question: Why would I use this endpoint?.

[sweetmantech]

Suggested change

	description: 'Update manual artist settings for an artist accessible to the authenticated account.'
	description: 'Update the settings for an artist.'

[sweetmantech]

Same KISS feedback. Auth is always implied in Recoup API. No need to redundantly state it on each specific endpoint.

Suggested change

	"description": "Update manual artist settings for an artist accessible to the authenticated account. This updates profile fields, artist account info, and any provided socials, then returns the merged artist payload.",
	"description": "Update an artist's settings. This updates profile fields, artist account info, and any provided socials, then returns the merged artist payload.",

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@api-reference/openapi/releases.json`:
- Around line 3570-3576: The schema for missing_fields currently declares an
array but the description says "Path to the first invalid field," causing
ambiguity; update the description of missing_fields (the array with "items":
{"type":"string"}) to accurately describe that it contains one or more field
path strings (e.g., "Paths to missing or invalid fields, each as a dot-separated
string") so clients/docs understand it's an array of field path strings, or
alternatively change the type to "string" if you intend a single path—adjust
only the description or the type accordingly on the missing_fields schema.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d3c4bdee-ad49-4a7d-9b6d-f49f4491039e

📥 Commits

Reviewing files that changed from the base of the PR and between 9f3aea6 and b57300f.

📒 Files selected for processing (3)

• api-reference/artists/update.mdx
• api-reference/openapi/releases.json
• docs.json