Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Quick Start: credential-schema DID substitution leaves invalid JSON

Open Beginner friendly
  • Is something wrong?
#291 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
json, markdown
Domain
documentation

Research direction

Read documentation/develop/quick-start.md, lines 143–206, and check the schema creation example's author field against the matching CredentialSchemaInput model linked in the issue. Verify the corrected substitution with a JSON parser and confirm the author is a string; the acceptance criteria define done.

Written by the indexing model from the issue text.

Description

documentation

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.
Dominant language
TypeScript
Stars
15
Forks
8
Avg merge
3d 14h
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hyperledger-identus/docs

All issues in hyperledger-identus/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.