Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Quick Start: credential-schema DID substitution leaves invalid JSON

Aperta Adatta ai principianti
  • Qualcosa non va?
#291 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
json, markdown
Ambito
documentation

Direzione di ricerca

Leggi documentation/develop/quick-start.md, righe 143–206, e confronta il campo author dell’esempio di creazione dello schema con il modello CredentialSchemaInput corrispondente collegato nell’issue. Verifica la sostituzione corretta con un parser JSON e conferma che author è una stringa; i criteri di accettazione definiscono quando il lavoro è completato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
TypeScript
Stelle
15
Fork
8
Merge medio
3g 14h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hyperledger-identus/docs

Tutte le issue di hyperledger-identus/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.