Skip to content

docs: add artist delete endpoint reference#124

Merged
arpitgupta1214 merged 2 commits intorecoupable:mainfrom
arpitgupta1214:codex/artist-delete-endpoint-docs
Apr 10, 2026
Merged

docs: add artist delete endpoint reference#124
arpitgupta1214 merged 2 commits intorecoupable:mainfrom
arpitgupta1214:codex/artist-delete-endpoint-docs

Conversation

@arpitgupta1214
Copy link
Copy Markdown
Collaborator

@arpitgupta1214 arpitgupta1214 commented Apr 9, 2026

Summary

  • document DELETE /api/artists/{id} in the releases OpenAPI spec
  • add the generated Mintlify page for the delete endpoint
  • add the delete page to the Artists navigation group

Testing

  • jq empty docs.json
  • jq empty api-reference/openapi/releases.json

Summary by cubic

Documented the artist delete endpoint and added a Mintlify page so the API reference includes DELETE /api/artists/{id} and it’s visible in the Artists nav.

  • New Features
    • OpenAPI: Added DELETE /api/artists/{id} with path param, 200/401/403/404 responses, and DeleteArtistResponse/DeleteArtistErrorResponse schemas.
    • Docs: Created api-reference/artists/delete.mdx with title and description, and added it to the Artists navigation group.

Written for commit 92cd563. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive API documentation for the Delete Artist endpoint, including endpoint specifications, authentication requirements, and error response documentation for various scenarios (unauthorized, forbidden, not found).

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

📝 Walkthrough

Walkthrough

Added documentation and OpenAPI specification for a new DELETE /api/artists/{id} endpoint. Changes include the endpoint definition with request/response schemas, a new MDX documentation page, and updated navigation configuration to expose the endpoint in the API reference.

Changes

Cohort / File(s) Summary
OpenAPI Specification
api-reference/openapi/releases.json
Added DELETE /api/artists/{id} endpoint with UUID path parameter, HTTP status codes (200, 401, 403, 404), and two new schemas: DeleteArtistResponse (contains success boolean and artistId) and DeleteArtistErrorResponse (contains error enum and error message).
Documentation & Navigation
api-reference/artists/delete.mdx, docs.json
Created new MDX documentation page with frontmatter metadata mapping to the OpenAPI DELETE operation, and registered the new route in the Artists section of the navigation configuration.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

  • sweetmantech

Poem

🐰 A delete endpoint hops into view,
With schemas so clean and responses so true,
The artists may vanish, their records set free,
Yet documented perfectly—hooray! 🎉✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add artist delete endpoint reference' directly and concisely describes the main change: adding documentation for the artist delete endpoint to the API reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/artists/delete.mdx`:
- Around line 1-4: The frontmatter in the MDX file for the Delete Artist page
(the YAML block containing title: 'Delete Artist' and openapi:
"/api-reference/openapi/releases.json DELETE /api/artists/{id}") is missing a
description field; add a description: "Short summary of the Delete Artist
endpoint" (or an appropriate concise summary) to that frontmatter block so the
page metadata matches other docs and follows the MDX frontmatter guideline.
🪄 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: 08ccaf49-d108-429a-b244-8d811e1e1e25

📥 Commits

Reviewing files that changed from the base of the PR and between 9b30de2 and 44deb8c.

📒 Files selected for processing (3)
  • api-reference/artists/delete.mdx
  • api-reference/openapi/releases.json
  • docs.json

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

@arpitgupta1214 arpitgupta1214 merged commit d3db7d6 into recoupable:main Apr 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants