Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrfeathers committed Jan 19, 2018
1 parent 60c30cd commit 4bcaf08
Show file tree
Hide file tree
Showing 13 changed files with 170 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,21 +142,21 @@ method and parameters you used to call it.

Here's the descriptions of all response models:
- [Artist](doc/Artist.md)
- Date
- MBId
- [Date](doc/Date.md)
- [MBId](doc/MBId.md)
- [Medium](doc/Medium.md)
- Recording
- Release
- ReleaseEvent
- Result
- Submission
- [Recording](doc/Recording.md)
- [Release](doc/Release.md)
- [ReleaseEvent](doc/ReleaseEvent.md)
- [Result](doc/Result.md)
- [Submission](doc/Submission.md)
- [Track](doc/Track.md)

Collection response models:
- MBIdCollection
- ResultCollection
- SubmissionCollection
- TrackCollection
- [MBIdCollection](doc/Collection/MBIdCollection.md)
- [ResultCollection](doc/Collection/ResultCollection.md)
- [SubmissionCollection](doc/Collection/SubmissionCollection.md)
- [TrackCollection](doc/Collection/TrackCollection.md)

>**NB!** Response models has a lot of fields, but some of them can be empty. It's because of scope of meta parameters you send to the method.
Different scope of meta values can return different results. All available meta values you can find in the class `Meta`. It's highly recommended
Expand Down
8 changes: 8 additions & 0 deletions doc/Collection/MBIdCollection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## MBIdCollection

- `status`
- setStatus(string $status): void
- getStatus(): string
- `mbids`
- setMbids(array $mbids): void
- getMbids(): array - array of [MBId](../MBId.md) objects
8 changes: 8 additions & 0 deletions doc/Collection/ResultCollection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## ResultCollection

- `status`
- setStatus(string $status): void
- getStatus(): string
- `results`
- setResults(array $results): void
- getResults(): array - array of [Result](../Result.md) objects
8 changes: 8 additions & 0 deletions doc/Collection/SubmissionCollection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## SubmissionCollection

- `status`
- setStatus(string $status): void
- getStatus(): string
- `submissions`
- setSubmissions(array $submissions): void
- getSubmissions(): array - array of [Submission](../Submission.md) objects
8 changes: 8 additions & 0 deletions doc/Collection/TrackCollection.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## TrackCollection

- `status`
- setStatus(string $status): void
- getStatus(): string
- `tracks`
- setTracks(array $tracks): void
- getTracks(): array - array of [Track](../Track.md) objects
14 changes: 14 additions & 0 deletions doc/Date.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Date

- `day`
- setDay(int $day): void
- getDay(): int
- `month`
- setMonth(int $month): void
- getMonth(): int
- `year`
- setYear(int $year): void
- getYear(): int


- toDateTime(): DateTime - makes DateTime
8 changes: 8 additions & 0 deletions doc/MBId.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## MBId

- `mbid`
- setMBId(string $mbid): void
- getMBId(): string
- `tracks`
- setTracks(array $tracks): void
- getTracks(): array - array of [Track](Track.md) objects
26 changes: 26 additions & 0 deletions doc/Recording.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Recording

- `id`
- setId(string $id): void
- getId(): string
- `score`
- setScore(float $score): void
- getScore(): float
- `sources`
- setSources(int $sources): void
- getSources(): int
- `title`
- setTitle(string $title): void
- getTitle(): string
- `duration`
- setDuration(float $duration): void
- getDuration(): float
- `artists`
- setArtists(array $artists): void
- getArtists(): array - array of [Artist](Artist.md) objects
- `releaseGroups`
- setReleaseGroups(array $releaseGroups): void
- getReleaseGroups(): array - array of [ReleaseGroup](ReleaseGroup.md) objects
- `releases`
- setReleases(array $releases): void
- getReleases(): array - array of [Release](Release.md) objects
26 changes: 26 additions & 0 deletions doc/Release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Release

- `id`
- setId(string $id): void
- getId(): string
- `title`
- setTitle(string $title): void
- getTitle(): string
- `trackCount`
- setTrackCount(int $trackCount): void
- getTrackCount(): int
- `mediumCount`
- setMediumCount(int $mediumCount): void
- getMediumCount(): int
- `releaseEvents`
- setReleaseEvents(array $releaseEvents): void
- getReleaseEvents(): array - array of [ReleaseEvent](ReleaseEvent.md) objects
- `country`
- setCountry(string $country): void
- getCountry(): string
- `date`
- setDate([Date](Date.md) $date): void
- getDate(): [Date](Date.md
- `mediums`
- setMediums(array $mediums): void
- getMediums(): array - array of [Medium](Medium.md) objects
8 changes: 8 additions & 0 deletions doc/ReleaseEvent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## ReleaseEvent

- `country`
- setCountry(string $country): void
- getCountry(): string
- `date`
- setDate([Date](Date.md) $date): void
- getDate(): [Date](Date.md)
20 changes: 20 additions & 0 deletions doc/ReleaseGroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## ReleaseGroup

- `id`
- setId(string $id): void
- getId(): string
- `type`
- setType(string $title): void
- getType(): string
- `artists`
- setArtists(array $artists): void
- getArtists(): array - array of [Artists](Artist.md) objects
- `title`
- setTitle(string $title): void
- getTitle(): string
- `releases`
- setReleases(array $releases): void
- getReleases(): array - array of [Release](Release.md) objects
- `secondaryTypes`
- setSecondaryTypes(array $secondaryTypes): void
- getSecondaryTypes(): array - string array
11 changes: 11 additions & 0 deletions doc/Result.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Result

- `id`
- setId(string $id): void
- getId(): string
- `score`
- setScore(float $score): void
- getScore(): float
- `recordings`
- setRecordings(array $recordings): void
- getRecordings(): array - array of [Recording](Recording.md) objects
14 changes: 14 additions & 0 deletions doc/Submission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Submission

- `id`
- setId(int $id): void
- getId(): int
- `index`
- setIndex(int $index): void
- getIndex(): int
- `status`
- setStatus(string $status): void
- getStatus(): string
- `result`
- setResult(array $result): void
- getResult(): array - has structure like ['id' => string]

0 comments on commit 4bcaf08

Please sign in to comment.