project-standalo-sonic-cloud/.workflow/versions/v001/contexts/api_upload_song.yml

242 lines
5.4 KiB
YAML

task_id: task_create_api_upload_song
entity_id: api_upload_song
generated_at: '2025-12-18T15:16:50.244501'
workflow_version: v001
target:
type: api
definition:
id: api_upload_song
method: POST
path: /api/songs/upload
description: Upload new song (musicians only)
request_body:
file: binary
title: string
album_id: uuid
genre_ids: array[uuid]
release_date: string
track_number: integer
responses:
- status: 201
description: Song uploaded successfully
schema:
id: uuid
title: string
file_url: string
duration: integer
- status: 400
description: Invalid file format or size
schema:
error: string
- status: 403
description: User is not a musician
schema:
error: string
auth:
required: true
roles:
- musician
depends_on_models:
- model_song
- model_artist
related:
models:
- id: model_artist
definition: &id001
id: model_artist
name: Artist
table_name: artists
description: Extended profile for musicians
fields:
- name: id
type: uuid
constraints:
- primary_key
- name: user_id
type: uuid
constraints:
- not_null
- foreign_key
references: users.id
- name: stage_name
type: string
constraints:
- not_null
- name: bio
type: text
constraints:
- nullable
- name: cover_image_url
type: string
constraints:
- nullable
- name: social_links
type: jsonb
description: JSON object with {twitter, instagram, facebook, website}
constraints:
- nullable
- name: verified
type: boolean
default: false
- name: created_at
type: timestamp
constraints:
- not_null
- name: updated_at
type: timestamp
constraints:
- not_null
relations:
- type: belongs_to
to: model_user
foreign_key: user_id
- type: has_many
to: model_song
foreign_key: artist_id
- type: has_many
to: model_album
foreign_key: artist_id
- type: belongs_to
to: model_label
foreign_key: label_id
optional: true
indexes:
- fields:
- user_id
unique: true
- fields:
- stage_name
timestamps: true
- id: model_song
definition: &id002
id: model_song
name: Song
table_name: songs
description: Audio track with metadata
fields:
- name: id
type: uuid
constraints:
- primary_key
- name: artist_id
type: uuid
constraints:
- not_null
- foreign_key
references: artists.id
- name: album_id
type: uuid
constraints:
- nullable
- foreign_key
references: albums.id
- name: title
type: string
constraints:
- not_null
- name: duration
type: integer
description: Duration in seconds
constraints:
- not_null
- name: file_url
type: string
description: Cloud storage URL for audio file
constraints:
- not_null
- name: file_format
type: enum
values:
- mp3
- wav
constraints:
- not_null
- name: file_size
type: integer
description: File size in bytes
constraints:
- not_null
- name: waveform_data
type: jsonb
description: Waveform visualization data
constraints:
- nullable
- name: cover_art_url
type: string
constraints:
- nullable
- name: release_date
type: date
constraints:
- nullable
- name: play_count
type: integer
default: 0
- name: is_public
type: boolean
default: true
- name: track_number
type: integer
description: Position in album
constraints:
- nullable
- name: created_at
type: timestamp
constraints:
- not_null
- name: updated_at
type: timestamp
constraints:
- not_null
relations:
- type: belongs_to
to: model_artist
foreign_key: artist_id
- type: belongs_to
to: model_album
foreign_key: album_id
optional: true
- type: has_many
to: model_genre
through: song_genres
foreign_key: song_id
- type: has_many
to: model_playlist_song
foreign_key: song_id
indexes:
- fields:
- artist_id
- fields:
- album_id
- fields:
- release_date
- fields:
- play_count
- fields:
- is_public
timestamps: true
apis: []
components: []
dependencies:
entity_ids:
- model_artist
- model_song
definitions:
- id: model_artist
type: model
definition: *id001
- id: model_song
type: model
definition: *id002
files:
to_create:
- app/api/songs/upload/route.ts
reference: []
acceptance:
- criterion: POST /api/songs/upload returns success response
verification: curl -X POST /api/songs/upload
- criterion: Request validation implemented
verification: Test with invalid data
- criterion: Error responses match contract
verification: Test error scenarios