From 8d3453f16f2a6d129da013e3abd4deafab336062 Mon Sep 17 00:00:00 2001 From: Alexander Garin Date: Mon, 27 Mar 2023 15:15:51 +0300 Subject: [PATCH] - Add comments --- .../spc_2b420b2bed1d4d868807303a581fb8c1.yml | 25 ++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/.insomnia/ApiSpec/spc_2b420b2bed1d4d868807303a581fb8c1.yml b/.insomnia/ApiSpec/spc_2b420b2bed1d4d868807303a581fb8c1.yml index f75f817..c5aab4b 100755 --- a/.insomnia/ApiSpec/spc_2b420b2bed1d4d868807303a581fb8c1.yml +++ b/.insomnia/ApiSpec/spc_2b420b2bed1d4d868807303a581fb8c1.yml @@ -1,24 +1,30 @@ _id: spc_2b420b2bed1d4d868807303a581fb8c1 type: ApiSpec parentId: wrk_cd1160cf39f5497fa4711fe4fd6567de -modified: 1679919032183 +modified: 1679919342812 created: 1679916396495 fileName: youtubekids.yaml contents: >+ openapi: 3.0.3 + info: title: YouTube Kids Public API description: For generate API REST clients for Feelter UGC contact: email: garin1221@yandex.ru version: 1.0.0 + servers: - url: https://www.youtubekids.com/youtubei/v1 + tags: - name: browse description: Browse resource content + paths: + + # Получение контента определенного ресурса, {browseId} /browse: post: tags: @@ -34,8 +40,15 @@ contents: >+ responses: '200': description: Successful operation + + + # Компоненты + components: + # Схемы данных schemas: + + # Параметры контента KidsAppContentSettings: type: object properties: @@ -45,6 +58,8 @@ contents: >+ kidsNoSearchMode: type: string example: YT_KIDS_NO_SEARCH_MODE_OFF + + # Конфигурация категорий KidsAppCategorySettings: type: object properties: @@ -53,6 +68,8 @@ contents: >+ example: ["approved_for_you", "black_joy", "camp", "collections", "earth", "explore", "favorites", "gaming", "halloween", "hero", "learning", "making", "move", "music", "reading", "shared_by_parents", "shows", "soccer", "sports", "spotlight", "winter"] items: type: string + + # Параметры приложения KidsAppInfo: type: object description: Kids application configuration @@ -61,6 +78,8 @@ contents: >+ $ref: '#/components/schemas/KidsAppContentSettings' categorySettings: $ref: '#/components/schemas/KidsAppCategorySettings' + + # Информация о клиенте в запросе RequestClient: type: object description: Client information @@ -99,12 +118,16 @@ contents: >+ example: DESKTOP kidsAppInfo: $ref: '#/components/schemas/KidsAppInfo' + + # Контекст запроса RequestContext: type: object description: Request context properties: client: $ref: '#/components/schemas/RequestClient' + + # Данные для запроса на получение контента определенного ресурса BrowseRequestPayload: type: object properties: