Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Quick Start: credential-schema DID substitution leaves invalid JSON

オープン 初心者向け
  • 何か問題がありますか？
#291 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
85/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
json, markdown
領域
documentation

調査の方向性

documentation/develop/quick-start.md の143～206行を読み、スキーマ作成の例にある author フィールドを、issue にリンクされた対応する CredentialSchemaInput モデルと照合してください。修正した置換を JSON パーサーで検証し、author が文字列であることを確認してください。完了の定義は受け入れ基準に従います。

索引モデルが issue の本文から書いたものです。

説明

bug documentation ready-for-agent

User impact

New developers following the first credential-schema example can produce invalid JSON by performing the DID substitution exactly as described, blocking schema creation before credential issuance.

Affected documentation and ownership

Observed versus expected

The guide says to replace [[publishedPrismDID]] with the previous step's did value, but the request contains:

"author": [[publishedPrismDID]],

Replacing only that placeholder with a DID value leaves a bare did:prism:… token, not a JSON string. The text does not tell readers to add JSON string delimiters.

Expected: the documented substitution yields valid JSON with a string-valued author. Readers who infer and add quotes themselves can work around the problem.

Evidence and reproduction

Python 3.13.15, static JSON parsing on 2026-10-28; no Agent request executed:

  1. Copy only the JSON body of the linked schema-creation example into schema-example.json.
  2. Run the following local syntax check (the synthetic DID is not a real identity):
import json
from pathlib import Path

body = Path("schema-example.json").read_text()
did = "did:prism:" + "a" * 64
json.loads(body.replace("[[publishedPrismDID]]", did))

Observed: JSONDecodeError: Expecting value: line 6 column 13 (char 186).

As a control, replacing with json.dumps(did) instead parses successfully and produces a string-valued author. This proves the quoting problem only; it does not claim the synthetic DID is accepted by an Agent or that the full tutorial was run. Deployment revision is not exposed; source/deployed text was compared directly.

Existing work checked

Searched open/closed issues and PRs, including discussion, across docs, cloud-agent and sdk-ts by publishedPrismDID, schema/author, invalid JSON and Quick Start/path; fully paginated inventories were also checked. docs PR #60, #145 and #223 do not correct this author field. cloud-agent PR #1817 repairs different comma/key errors in the imported credential-offer tutorial, not this portal-local schema example. No existing repair for this omission was found.

Acceptance criteria

  • Replacing the placeholder as instructed yields syntactically valid JSON with a string-valued author.
  • Verify the corrected example with a JSON parser and against the matching Agent version's schema-input contract.
主要言語
TypeScript
スター
15
フォーク
8
平均マージ
3日 14時間
マージ済み PR（30日）
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

hyperledger-identus/docs のほかの issue

hyperledger-identus/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。