Skip to content

docs: add OpenAPI 3.1 specification - #8

Merged
ooosm merged 2 commits into
masterfrom
swagger
Aug 1, 2026
Merged

docs: add OpenAPI 3.1 specification#8
ooosm merged 2 commits into
masterfrom
swagger

Conversation

@ooosm

@ooosm ooosm commented Jul 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • docs/openapi.yaml에 mobius4 oneM2M CSE의 OpenAPI 3.1 명세를 추가합니다.
  • 리소스 타입 7종(acp·ae·cnt·cin·cb·grp·sub) × CRUD를 다루며, 각 오퍼레이션의 지원 여부는
    실제 요청에 대해 관찰된 Response Status Code를 근거로 판정했습니다(코드를 읽고
    추측하지 않았습니다 — 실제로 스위치문만 보면 지원되는 것처럼 보이지만 무응답으로
    멈추는 리소스 타입이 있었습니다).
  • 경로(/{parentPath}, /{resourcePath})는 합성된 것입니다. 실제 HTTP 라우트는
    POST|GET|PUT|DELETE /* 와일드카드 4개뿐이며, 오퍼레이션은 Content-Typety
    파라미터와 쿼리 파라미터로 구분됩니다. 이 사실은 문서의 info.description에도
    명시되어 있습니다.
  • 리소스 본문 스키마는 TS-0004 XSD 코퍼스에서 생성했습니다.

참고

  • 생성 도구는 별도 개발 지원 레포(mobius4-dev-tool)의 tools/openapi이며, 소스 매니페스트는
    라이브 프로브로 채워졌습니다. 이 PR은 생성된 산출물만 담고 있습니다.
  • cin.update·cb.update는 관찰상 OPERATION_NOT_ALLOWED(4005)라 명세에서 제외했습니다.

Test plan

  • docs/openapi.yaml이 OpenAPI 3.1 스키마에 부합하는지 확인
  • Swagger UI/ReDoc 등으로 렌더링해 리소스별 CRUD 설명이 실제 동작과 일치하는지 확인

🤖 Generated with Claude Code

https://claude.ai/code/session_01HS4w2F2tKxyuKeVQ1c1B4d

@ooosm
ooosm merged commit 9942a83 into master Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant