-
Notifications
You must be signed in to change notification settings - Fork 4
docs: repoint /api/fans to /api/artists/{id}/fans #143
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.
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
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4f27912
docs: repoint /api/fans to /api/artists/{id}/fans
arpitgupta1214 486e1f4
docs(fans): add security, 401, 500 to OpenAPI spec
arpitgupta1214 68324be
docs(fans): repoint mdx frontmatter; drop unused ArtistFansErrorRespo…
arpitgupta1214 2e04a2b
Merge remote-tracking branch 'origin/main' into chore/docs-artist-fan…
arpitgupta1214 052c0c9
docs: drop dead /api/segment/fans path from releases spec
arpitgupta1214 fc378d3
docs(fans): document 401 and 500 response codes
arpitgupta1214 0dedbc5
docs(fans): drop api.recoupable.com override, inherit recoup-api.verc…
arpitgupta1214 dedaf38
docs(fans): rename followerCount/followingCount to snake_case to matc…
arpitgupta1214 7568409
docs(nav): move Fans group from Releases tab to Artists tab
sweetmantech File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| --- | ||
| title: Get Artist Fans | ||
| openapi: "/api-reference/openapi/releases.json GET /api/fans" | ||
| openapi: "/api-reference/openapi/releases.json GET /api/artists/{id}/fans" | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -682,18 +682,13 @@ | |
| } | ||
| } | ||
| }, | ||
| "/api/fans": { | ||
| "/api/artists/{id}/fans": { | ||
| "get": { | ||
| "servers": [ | ||
| { | ||
| "url": "https://api.recoupable.com" | ||
| } | ||
| ], | ||
| "description": "Retrieve all social profiles from fans of an artist across all platforms. This endpoint aggregates fan data from all connected social media platforms. Supports pagination for large fan lists.", | ||
| "parameters": [ | ||
| { | ||
| "name": "artist_account_id", | ||
| "in": "query", | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "The unique identifier of the artist account to fetch fans for", | ||
| "required": true, | ||
| "schema": { | ||
|
|
@@ -743,6 +738,26 @@ | |
| } | ||
| } | ||
| } | ||
| }, | ||
| "401": { | ||
| "description": "Unauthorized - missing or invalid credentials", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ArtistFansErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "500": { | ||
| "description": "Internal server error", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/ArtistFansErrorResponse" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -1436,11 +1451,11 @@ | |
| "type": "string", | ||
| "description": "Fan's biography or profile description" | ||
| }, | ||
| "followerCount": { | ||
| "follower_count": { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: This renames response fields in Prompt for AI agents |
||
| "type": "integer", | ||
| "description": "Number of followers the fan has" | ||
| }, | ||
| "followingCount": { | ||
| "following_count": { | ||
| "type": "integer", | ||
| "description": "Number of accounts the fan is following" | ||
| }, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.