8
0

- Add comments

This commit is contained in:
Aleksandr Garin 2023-03-27 15:15:51 +03:00
parent c7873191f8
commit 8d3453f16f

View File

@ -1,24 +1,30 @@
_id: spc_2b420b2bed1d4d868807303a581fb8c1 _id: spc_2b420b2bed1d4d868807303a581fb8c1
type: ApiSpec type: ApiSpec
parentId: wrk_cd1160cf39f5497fa4711fe4fd6567de parentId: wrk_cd1160cf39f5497fa4711fe4fd6567de
modified: 1679919032183 modified: 1679919342812
created: 1679916396495 created: 1679916396495
fileName: youtubekids.yaml fileName: youtubekids.yaml
contents: >+ contents: >+
openapi: 3.0.3 openapi: 3.0.3
info: info:
title: YouTube Kids Public API title: YouTube Kids Public API
description: For generate API REST clients for Feelter UGC description: For generate API REST clients for Feelter UGC
contact: contact:
email: garin1221@yandex.ru email: garin1221@yandex.ru
version: 1.0.0 version: 1.0.0
servers: servers:
- url: https://www.youtubekids.com/youtubei/v1 - url: https://www.youtubekids.com/youtubei/v1
tags: tags:
- name: browse - name: browse
description: Browse resource content description: Browse resource content
paths: paths:
# Получение контента определенного ресурса, {browseId}
/browse: /browse:
post: post:
tags: tags:
@ -34,8 +40,15 @@ contents: >+
responses: responses:
'200': '200':
description: Successful operation description: Successful operation
# Компоненты
components: components:
# Схемы данных
schemas: schemas:
# Параметры контента
KidsAppContentSettings: KidsAppContentSettings:
type: object type: object
properties: properties:
@ -45,6 +58,8 @@ contents: >+
kidsNoSearchMode: kidsNoSearchMode:
type: string type: string
example: YT_KIDS_NO_SEARCH_MODE_OFF example: YT_KIDS_NO_SEARCH_MODE_OFF
# Конфигурация категорий
KidsAppCategorySettings: KidsAppCategorySettings:
type: object type: object
properties: 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"] 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: items:
type: string type: string
# Параметры приложения
KidsAppInfo: KidsAppInfo:
type: object type: object
description: Kids application configuration description: Kids application configuration
@ -61,6 +78,8 @@ contents: >+
$ref: '#/components/schemas/KidsAppContentSettings' $ref: '#/components/schemas/KidsAppContentSettings'
categorySettings: categorySettings:
$ref: '#/components/schemas/KidsAppCategorySettings' $ref: '#/components/schemas/KidsAppCategorySettings'
# Информация о клиенте в запросе
RequestClient: RequestClient:
type: object type: object
description: Client information description: Client information
@ -99,12 +118,16 @@ contents: >+
example: DESKTOP example: DESKTOP
kidsAppInfo: kidsAppInfo:
$ref: '#/components/schemas/KidsAppInfo' $ref: '#/components/schemas/KidsAppInfo'
# Контекст запроса
RequestContext: RequestContext:
type: object type: object
description: Request context description: Request context
properties: properties:
client: client:
$ref: '#/components/schemas/RequestClient' $ref: '#/components/schemas/RequestClient'
# Данные для запроса на получение контента определенного ресурса
BrowseRequestPayload: BrowseRequestPayload:
type: object type: object
properties: properties: