Fill Example JSON placeholders for every block and sub-block - #34
Open
mpfl wants to merge 1 commit into
Open
Conversation
Replaces 23 empty **Example JSON** markers with valid JSON snippets, and removes the 4 markers that sat on single-value properties, where the existing **Example** already does the job (alternateIdentifier.id, alternateIdentifier.type, alternateUrl.url, access.statement.text). Snippets show the block or sub-block with its enclosing property name, and repeating blocks as the arrays they actually are, so a reader can see the occurrence rules in the example itself. Content is drawn from three fictional projects: a marine ecology field project (most blocks), a health data linkage project under embargo (the access block, which needs a non-open access type to be meaningful), and a creative arts project (relatedObject). Identifiers are real where they are structural and verifiable, and illustrative where they would otherwise point at real people or real works: - Organisation identifiers are real RORs, confirmed against the ROR API. - Vocabulary, COAR and ISO 639 URIs are the live values, matching the corrections in the preceding commit. - ANZSRC Fields of Research codes are real, confirmed against linked.data.gov.au. - Contributor identifiers use ORCID's fictional demo personas. Josiah Carberry (0000-0002-1825-0097) exists in the production registry for exactly this purpose. Sofia Maria Hernandez Garcia's identifier is unassigned in the production registry, so it names no real person. - RAiD names use an illustrative 10.99999 prefix in the production shape, and object DOIs use the 10.5555 test prefix, so nothing resolves to a real record. The convention note in index.rst is updated to describe what Example JSON now covers, and to state plainly which identifiers in the examples are real and which will not resolve. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces the 23 empty
**Example JSON**markers with valid JSON snippets, and removes the 4 markers that sat on single-value properties where the existing**Example**already does the job (alternateIdentifier.id,alternateIdentifier.type,alternateUrl.url,access.statement.text).Builds on the accuracy sweep in #32, so every vocabulary URI in the snippets is a corrected one.
What the snippets show
Each snippet includes the enclosing property name, and shows repeating blocks as the arrays they actually are, so the occurrence rules are visible in the example itself rather than only in the prose above it.
Structures were modelled on real production payloads, so field nesting matches what the API returns —
dateas an object,titleas an array,metadatatimestamps as epoch seconds, and so on.Where the content comes from
Three fictional projects, chosen so each block is illustrated by something plausible:
accessblock, which needs a non-open access type to be meaningfulrelatedObjectIdentifiers are real where they are structural and verifiable, and illustrative where a real value would point at a real person or a real work:
10.99999prefix, not registered in the Handle system10.5555DOI test prefixOn contributor identifiers specifically: Josiah Carberry (
0000-0002-1825-0097) exists in the production ORCID registry precisely as a demo persona. Sofía María Hernández Garcia's identifier is unassigned in the production registry, so it names no real person, and the ORCID Sandbox schema is deliberately avoided sincecontributor.schemaUriwarns against it for production records.Worth noting separately: two ORCIDs currently used as examples elsewhere in the RAiD codebase belong to real people —
0000-0002-0448-8774inInMemoryStubTestData.javaand0000-0002-4582-7728indoc/reference/schema-org-json-ld-mapping.md. Neither appears in this documentation, but the latter is in a public document.Convention note
index.rstnow describes what**Example JSON**covers, and states plainly which identifiers in the examples are real and which will not resolve, so nobody copies an illustrative RAiD name into a record expecting it to work.Verification
Sphinx builds clean with zero warnings. All 23 snippets were generated from validated structures and re-parsed as JSON after insertion; none is malformed.
🤖 Generated with Claude Code