Skip to content

๐Ÿ“š Docs: ํด๋ž˜์Šค API ๋ช…์„ธ์„œย #555

Closed

Description

@si-zero

๐Ÿ› ๏ธ Issue Overview

ํด๋ž˜์Šค ๊ธฐ๋Šฅ ์ „์ฒด API ๋ช…์„ธ์„œ๊ฐ€ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.

๐Ÿ“ Issue Description

์ด์šฉ๊ถŒ๋ถ€ํ„ฐ ๊ฒฐ๊ณผ ๋ฆฌํฌํŠธ, ์–ด๋“œ๋ฏผ ํŽ€๋”ฉ๊นŒ์ง€ ํด๋ž˜์Šค ๊ธฐ๋Šฅ API ๋ฅผ docs/api-specs/class-api.md ํ•˜๋‚˜์— ์ •๋ฆฌํ•ฉ๋‹ˆ๋‹ค. ํ™”๋ฉด๋ณ„ ํ˜ธ์ถœ ํ๋ฆ„, ๊ถŒํ•œ ๊ทœ์น™, ์š”์ฒญยท์‘๋‹ต ํ•„๋“œ, ์ œํ•œ๊ฐ’, ์ƒํ™ฉ๋ณ„ ์—๋Ÿฌ ์ฝ”๋“œ๋ฅผ ๋‹ด์Šต๋‹ˆ๋‹ค.

โœ… To do

  • ๊ณตํ†ต (์‘๋‹ต ํ˜•์‹, enum, ํด๋ž˜์Šค ๊ถŒํ•œ ๊ทœ์น™, ํ™”๋ฉด ํ๋ฆ„)
  • ์ด์šฉ๊ถŒ ์ฝ”๋“œ ํ™•์ธยท๋“ฑ๋กยท๋‚ด ์ด์šฉ๊ถŒ
  • ํด๋ž˜์Šค ์ƒ์„ฑยท๋ชฉ๋กยท์ƒ์„ธยท์ˆ˜์ •ยท์‚ญ์ œ
  • Picke ๋ฐฐํ‹€ ์ถ”์ฒœ
  • ์ปค์Šคํ…€ ๋ฐฐํ‹€ ์ฃผ์ œ ์ดˆ์•ˆยท์ œ์•ˆยท์„ ํƒยท์ˆ˜์ • ๊ฒ€์ฆ
  • ์ฐธ์—ฌ ์ฝ”๋“œ ํ™•์ธยท์ฐธ์—ฌยท๋ช…๋‹จยท์ด๋ฆ„ ๋ณ€๊ฒฝยท๋‚˜๊ฐ€๊ธฐยท๋‚ด๋ณด๋‚ด๊ธฐ
  • ํด๋ž˜์Šค ๋ฐฐํ‹€ ์ง„ํ–‰ (ํˆฌํ‘œยทTTSยท์˜๊ฒฌยท๋Œ“๊ธ€)
  • AI ์ฒ ํ•™์ž ํ† ๋ก 
  • ๊ฒฐ๊ณผยทAI ํ”ผ๋“œ๋ฐฑยท์ธ์‚ฌ์ดํŠธ
  • ์–ด๋“œ๋ฏผ ๋ฐฐํ‹€ ํด๋ž˜์Šค ์„ค์ •, ํŽ€๋”ฉ ๋ช…๋‹จยท์ด์šฉ๊ถŒ ๋ฐœ๊ธ‰ยท์ „๋‹ฌยท์žฌ๋ฐœ๊ธ‰ยทํ™˜๋ถˆ
  • ์—๋Ÿฌ ์ฝ”๋“œ ๋ชจ์Œ

Activity

  1. self-assigned this
    on Oct 21, 2026
  2. added a commit that references this issue on Oct 21, 2026
  3. changed the title [-]๐Ÿ“š Docs: ํด๋ž˜์Šค ์ปค์Šคํ…€ ๋ฐฐํ‹€ยท์ถ”์ฒœยท์ฐธ์—ฌ ์ฝ”๋“œ ํ™•์ธ API ๋ช…์„ธ์„œ[/-] [+]๐Ÿ“š Docs: ํด๋ž˜์Šค API ๋ช…์„ธ์„œ[/+] on Oct 21, 2026
  4. added a commit that references this issue on Oct 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

๐Ÿ“š Docs (๋ฌธ์„œ ์ˆ˜์ •)๋ฌธ์„œ๋ฅผ ์ˆ˜์ •ํ•  ๋•Œ ์‚ฌ์šฉํ•ฉ๋‹ˆ๋‹ค.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions