Skip to content

docs(provider): align dashboard data status contracts#26

Open
dkfhddla wants to merge 5 commits into
codex/read-only-provider-docsfrom
codex/provider-dashboard-docs-alignment
Open

docs(provider): align dashboard data status contracts#26
dkfhddla wants to merge 5 commits into
codex/read-only-provider-docsfrom
codex/provider-dashboard-docs-alignment

Conversation

@dkfhddla

@dkfhddla dkfhddla commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • Dashboard Schema v1에 후속 provider 메타데이터 요구사항과 fresh/stale/error/unauthorized/unsupported 데이터 상태 기준을 정리했습니다.
  • Widget Registry와 UI 문서에 provider명, 데이터 출처, 마지막 갱신 시각, 데이터 상태 표시 기준을 반영하되 현재 MVP 필수 컬럼/스키마 계약과 분리했습니다.
  • README, 아키텍처 개요, ADR, 백엔드 아키텍처 슬라이스의 브로커/주문 중심 후속 확장 표현을 read-only provider 경계에 맞게 정리했습니다.

Scope

  • 문서만 수정했습니다.
  • 선행 PR #25의 read-only provider 사양을 반복하지 않고, Dashboard Schema / Widget Registry / UI 표시 계약과 아키텍처 표현 정합성만 보강했습니다.
  • docs/specs/mvp-foundation.md는 이미 외부 API와 주문을 비목표로 명확히 두고 있어 변경하지 않았습니다.

Documentation impact

  • docs/dashboard-schema-v1.md가 provider 데이터 메타데이터 요구사항과 데이터 상태 후보를 후속 provider 확장 계약으로 설명합니다.
  • docs/widget-registry.md가 provider 데이터 상태 표시와 민감 정보 비노출 기준을 설명하되, MVP 수동/모의 데이터와 현재 validator 계약을 분리합니다.
  • docs/ui/* 문서가 대시보드 화면에서 출처/갱신/상태 정보를 어디에 드러낼지 보강하되, provider 메타데이터는 확장 전용 표시로 분리합니다.
  • 아키텍처 문서의 후속 확장 표현이 주문/자동매매가 아니라 읽기 전용 provider adapter 중심으로 정리됩니다.

Verification

  • git diff --stat로 문서 변경 범위를 확인했습니다.
  • rg실시간 시세, 증권사, 브로커, 주문, dry-run, 자동매매, provider 상태 관련 표현을 점검했습니다.
  • 최신 리뷰 반영 후 metadata_fields, provider 표시 컬럼, unsupported 상태 관련 문구를 재점검했습니다.
  • 코드 변경이 없어 빌드/테스트는 실행하지 않았습니다.

Residual risks

  • docs/specs/stock-signal-view-data-model.md에는 향후 입력 소스 예시로 BROKER_API 등이 남아 있습니다. 데이터 모델 소스 enum 정리는 별도 후속 문서 작업으로 다루는 편이 좋습니다.

@dkfhddla dkfhddla marked this pull request as ready for review July 2, 2026 13:24
@dkfhddla dkfhddla self-assigned this Jul 2, 2026
@dkfhddla

dkfhddla commented Jul 2, 2026

Copy link
Copy Markdown
Owner Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b1629409e1

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/dashboard-schema-v1.md Outdated
Comment thread docs/widget-registry.md Outdated
@dkfhddla

dkfhddla commented Jul 3, 2026

Copy link
Copy Markdown
Owner Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 5c3a2c4a4f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/ui/screens.md Outdated
Comment thread docs/widget-registry.md Outdated
Comment thread docs/dashboard-schema-v1.md Outdated
@dkfhddla

dkfhddla commented Jul 3, 2026

Copy link
Copy Markdown
Owner Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ebb324f22b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/widget-registry.md Outdated
Comment thread docs/dashboard-schema-v1.md Outdated
Comment thread docs/ui/screens.md Outdated
Comment thread docs/arch/backend-architecture-slices.md Outdated
@dkfhddla

dkfhddla commented Jul 5, 2026

Copy link
Copy Markdown
Owner Author

@codex

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 15b3ffc79d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +89 to +90
- `authentication_failed`: provider 인증 실패로 데이터를 가져오지 못한 상태. 사용자는 재인증이 필요하다.
- `permission_denied`: provider 권한 부족으로 데이터를 가져오지 못한 상태. 사용자는 필요한 조회 권한을 부여해야 한다.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep authorization status tokens aligned

The provider spec's frontend verification still expects Dashboard Schema/Widget Registry extensions to display a single unauthorized state (docs/specs/read-only-market-data-provider.md), but this new canonical data_status list only defines authentication_failed and permission_denied. When the read-only provider extension is implemented, serializers and frontend tests following the two docs will use different tokens for the same authorization failure path, so please either retain unauthorized here or update the provider spec/verification wording to the split names in the same change.

Useful? React with 👍 / 👎.

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