From 565498a5fca622de8087e6181b542de28c619ff0 Mon Sep 17 00:00:00 2001 From: paranarimasu <33796518+paranarimasu@users.noreply.github.com> Date: Sun, 17 Jul 2022 11:49:04 -0500 Subject: [PATCH] feat: adding relation between audio and video (#42) --- docs/audio/README.md | 2 +- docs/audio/index/README.md | 1 + docs/audio/show/README.md | 9 ++++++--- docs/video/README.md | 1 + docs/video/store/README.md | 1 + docs/video/update/README.md | 1 + 6 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/audio/README.md b/docs/audio/README.md index a1d9583..0f7922e 100644 --- a/docs/audio/README.md +++ b/docs/audio/README.md @@ -27,7 +27,7 @@ For example, the audio Bakemonogatari-OP1.ogg represents the audio track of the ### Allowed Include Paths -None +* videos ### Endpoints diff --git a/docs/audio/index/README.md b/docs/audio/index/README.md index 3548c13..775473f 100644 --- a/docs/audio/index/README.md +++ b/docs/audio/index/README.md @@ -24,6 +24,7 @@ None | :----------: | :------: | :---------------------------------------------------------------------------- | | fields | No | Sparse fieldsets for resource types | | filter | No | Filters for anime resources & constraining the inclusion of related resources | +| include | No | Inclusion of related resources | | page[number] | No | The page of anime resources to display | | page[size] | No | The number of anime resources to display for the current page | | sort | No | The list of fields to sort the resources | diff --git a/docs/audio/show/README.md b/docs/audio/show/README.md index 629995d..8327b53 100644 --- a/docs/audio/show/README.md +++ b/docs/audio/show/README.md @@ -22,9 +22,12 @@ None ## Parameters -| Name | Required | Description | -| :-----: | :------: | :---------------------------------- | -| fields | No | Sparse fieldsets for resource types | +| Name | Required | Description | +| :-----: | :------: | :------------------------------------------------------ | +| fields | No | Sparse fieldsets for resource types | +| filter | No | Filters to constrain the inclusion of related resources | +| include | No | Inclusion of related resources | +| sort | No | Sort related resources | ## Response diff --git a/docs/video/README.md b/docs/video/README.md index 31af47b..f1049c4 100644 --- a/docs/video/README.md +++ b/docs/video/README.md @@ -38,6 +38,7 @@ For example, the video Bakemonogatari-OP1.webm represents the WebM of the Bakemo * animethemeentries * animethemeentries.animetheme * animethemeentries.animetheme.anime +* audio ### Endpoints diff --git a/docs/video/store/README.md b/docs/video/store/README.md index aa786d4..2b6a614 100644 --- a/docs/video/store/README.md +++ b/docs/video/store/README.md @@ -38,6 +38,7 @@ POST /video | uncen | No | boolean | | overlap | No | EnumValue {None, Trans, Over} | | source | No | EnumValue {Web, RAW, BD, DVD, VHS, LD} | +| audio_id | No | integer, Audio ID exists | ## Response diff --git a/docs/video/update/README.md b/docs/video/update/README.md index f31fe32..335efb0 100644 --- a/docs/video/update/README.md +++ b/docs/video/update/README.md @@ -33,6 +33,7 @@ PUT|PATCH /video/{basename} | uncen | No | boolean | | overlap | No | EnumValue {None, Trans, Over} | | source | No | EnumValue {Web, RAW, BD, DVD, VHS, LD} | +| audio_id | No | integer, Audio ID exists | ## Response