Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
136 changes: 65 additions & 71 deletions api/swagger/swagger-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6815,7 +6815,8 @@ components:
access:
$ref: '#/components/schemas/track_access_info'
ai_attribution_user_id:
type: integer
type: string
example: "x5pJ3Az"
allowed_api_keys:
type: array
items:
Expand Down Expand Up @@ -6964,7 +6965,8 @@ components:
type: object
properties:
parent_track_id:
type: integer
type: string
example: "x5pJ3Az"
album_backlink:
required:
- permalink
Expand Down Expand Up @@ -7876,6 +7878,7 @@ components:
properties:
tip_user_id:
type: integer
example: 1234
description: Must tip the given user ID to unlock
follow_gate:
required:
Expand All @@ -7884,6 +7887,7 @@ components:
properties:
follow_user_id:
type: integer
example: 1234
description: Must follow the given user ID to unlock
token_gate:
required:
Expand Down Expand Up @@ -7939,6 +7943,7 @@ components:
properties:
user_id:
type: integer
example: 1234
percentage:
type: number
eth_wallet:
Expand Down Expand Up @@ -8154,7 +8159,8 @@ components:
category:
$ref: '#/components/schemas/stem_category'
parent_track_id:
type: integer
type: string
example: "x5pJ3Az"
undisbursed_challenges:
type: object
properties:
Expand Down Expand Up @@ -9802,9 +9808,9 @@ components:
- track_cid
properties:
track_id:
type: integer
type: string
description: Optional track ID (will be generated if not provided)
minimum: 1
example: "x5pJ3Az"
title:
type: string
description: Track title
Expand Down Expand Up @@ -10003,9 +10009,9 @@ components:
- playlist_name
properties:
playlist_id:
type: integer
type: string
description: Optional playlist ID (will be generated if not provided)
minimum: 1
example: "x5pJ3Az"
playlist_name:
type: string
description: Playlist or album name
Expand Down Expand Up @@ -10100,9 +10106,9 @@ components:
- wallet
properties:
user_id:
type: integer
description: Optional user ID (will be generated if not provided)
minimum: 1
type: string
description: Optional user hash ID (will be generated if not provided)
example: "p9Km2Lx"
handle:
type: string
description: User handle (unique username)
Expand Down Expand Up @@ -10162,19 +10168,7 @@ components:
type: string
description: Solana USDC payout wallet address
playlist_library:
type: object
description: User's playlist library with support for folders and playlists
required:
- contents
properties:
contents:
type: array
description: Array of folders and playlist identifiers
items:
oneOf:
- $ref: '#/components/schemas/playlist_library_folder'
- $ref: '#/components/schemas/playlist_library_playlist_identifier'
- $ref: '#/components/schemas/playlist_library_explore_playlist_identifier'
$ref: '#/components/schemas/user_playlist_library'
events:
type: object
description: User events for tracking referrals and mobile users
Expand Down Expand Up @@ -10237,9 +10231,9 @@ components:
type: boolean
description: Whether the user is deactivated
artist_pick_track_id:
type: integer
description: Track ID to feature as artist pick
minimum: 1
type: string
description: Track hash ID to feature as artist pick
example: "x5pJ3Az"
allow_ai_attribution:
type: boolean
description: Whether to allow AI attribution
Expand All @@ -10250,25 +10244,15 @@ components:
type: string
description: Coin flair mint address
playlist_library:
type: object
description: User's playlist library with support for folders and playlists
properties:
contents:
type: array
description: Array of folders and playlist identifiers
items:
oneOf:
- $ref: '#/components/schemas/playlist_library_folder'
- $ref: '#/components/schemas/playlist_library_playlist_identifier'
- $ref: '#/components/schemas/playlist_library_explore_playlist_identifier'
$ref: '#/components/schemas/user_playlist_library'
events:
type: object
description: User events for tracking referrals and mobile users
properties:
referrer:
type: integer
description: User ID of the referrer
minimum: 1
type: string
description: Hash ID of the user who referred this user
example: "k9Xm5Pz"
is_mobile_user:
type: boolean
description: Whether the user is on mobile
Expand All @@ -10284,21 +10268,20 @@ components:
- $ref: '#/components/schemas/comment_entity_type'
example: "Track"
entityId:
type: integer
description: ID of the entity being commented on
minimum: 1
example: 12345
type: string
description: Hash ID of the entity being commented on
example: "x5pJ3Az"
body:
type: string
description: The updated comment text
maxLength: 500
mentions:
type: array
description: Array of user IDs mentioned in the comment (max 10)
description: Array of user hash IDs mentioned in the comment (max 10)
maxItems: 10
items:
type: integer
minimum: 1
type: string
example: "k9Xm5Pz"
create_comment_request_body:
type: object
required:
Expand All @@ -10311,34 +10294,33 @@ components:
- $ref: '#/components/schemas/comment_entity_type'
example: "Track"
entityId:
type: integer
description: ID of the entity being commented on
minimum: 1
example: 12345
type: string
description: Hash ID of the entity being commented on
example: "x5pJ3Az"
body:
type: string
description: Comment text
maxLength: 500
example: "Great track!"
commentId:
type: integer
description: Optional comment ID (will be generated if not provided)
minimum: 1
type: string
description: Optional hash ID for the comment (will be generated if not provided)
example: "Bm7aK9x"
parentId:
type: integer
description: Parent comment ID if this is a reply
minimum: 1
type: string
description: Parent comment hash ID if this is a reply
example: "8nWq2Lp"
trackTimestampS:
type: integer
description: Timestamp in the track where the comment was made (in seconds)
minimum: 0
mentions:
type: array
description: Array of user IDs mentioned in the comment (max 10)
description: Array of user hash IDs mentioned in the comment (max 10)
maxItems: 10
items:
type: integer
minimum: 1
type: string
example: "k9Xm5Pz"
react_comment_request_body:
type: object
required:
Expand All @@ -10350,10 +10332,9 @@ components:
- $ref: '#/components/schemas/comment_entity_type'
example: "Track"
entityId:
type: integer
description: ID of the entity (track or playlist) being commented on
minimum: 1
example: 12345
type: string
description: Hash ID of the entity (track) being commented on
example: "x5pJ3Az"
pin_comment_request_body:
type: object
required:
Expand All @@ -10365,10 +10346,9 @@ components:
- $ref: '#/components/schemas/comment_entity_type'
example: "Track"
entityId:
type: integer
description: ID of the entity (track or playlist) the comment is on
minimum: 1
example: 12345
type: string
description: Hash ID of the entity (track) the comment is on
example: "x5pJ3Az"
create_developer_app_request_body:
type: object
required:
Expand Down Expand Up @@ -10477,6 +10457,20 @@ components:
success:
type: boolean
description: Whether the deactivation was successful
user_playlist_library:
type: object
description: User's playlist library with support for folders and playlists
required:
- contents
properties:
contents:
type: array
description: Array of folders and playlist identifiers
items:
oneOf:
- $ref: '#/components/schemas/playlist_library_folder'
- $ref: '#/components/schemas/playlist_library_playlist_identifier'
- $ref: '#/components/schemas/playlist_library_explore_playlist_identifier'
playlist_library_folder:
type: object
description: Folder containing nested playlists and folders
Expand Down Expand Up @@ -10514,9 +10508,9 @@ components:
type: string
enum: [playlist]
playlist_id:
type: integer
description: Playlist ID
minimum: 1
type: string
description: Playlist hash ID
example: "n7Qx4Mp"
playlist_library_explore_playlist_identifier:
type: object
description: Reference to an explore playlist
Expand Down
Loading