From c323f6b2f419db6dc73bac9d4ce9dd9906ed74ba Mon Sep 17 00:00:00 2001 From: Nate Otto Date: Wed, 27 Sep 2023 21:47:17 -0700 Subject: [PATCH] Update documentation and CTIDs --- LearningProgram/1/LearningProgram-1-graph.json | 3 +-- LearningProgram/1/LearningProgram-1.json | 2 +- LearningProgram/index.md | 11 +++++++++++ index.md | 5 +++++ 4 files changed, 18 insertions(+), 3 deletions(-) diff --git a/LearningProgram/1/LearningProgram-1-graph.json b/LearningProgram/1/LearningProgram-1-graph.json index 1265d04..4c955d8 100644 --- a/LearningProgram/1/LearningProgram-1-graph.json +++ b/LearningProgram/1/LearningProgram-1-graph.json @@ -1,11 +1,10 @@ { "@context": "https://credreg.net/ctdl/schema/context/json", - "@id": "https://credentialengine.github.io/credential-registry-ingest-examples/LearningProgram/1/LearningProgram-1-graph.json", "@graph": [ { "@id": "https://credentialengine.github.io/credential-registry-ingest-examples/LearningProgram/1/LearningProgram-1.json", "@type": "ceterms:LearningProgram", - "ceterms:ctid": "ce-bada0d68-f026-441d-80c1-cdabace4e525", + "ceterms:ctid": "ce-23b0e606-545c-4383-8630-f97ec3b190fa", "ceterms:name": { "en-US": "Lifelong Learning Accelerator" }, "ceterms:hasPart": [ "https://credentialengine.github.io/credential-registry-ingest-examples/LearningProgram/1/Course-1a.json", diff --git a/LearningProgram/1/LearningProgram-1.json b/LearningProgram/1/LearningProgram-1.json index 74a303f..11838e4 100644 --- a/LearningProgram/1/LearningProgram-1.json +++ b/LearningProgram/1/LearningProgram-1.json @@ -2,7 +2,7 @@ "@context": "https://credreg.net/ctdl/schema/context/json", "@id": "https://credentialengine.github.io/credential-registry-ingest-examples/LearningProgram/1/LearningProgram-1.json", "@type": "ceterms:LearningProgram", - "ceterms:ctid": "ce-bada0d68-f026-441d-80c1-cdabace4e525", + "ceterms:ctid": "ce-23b0e606-545c-4383-8630-f97ec3b190fa", "ceterms:name": { "en-US": "Lifelong Learning Accelerator" }, "ceterms:hasPart": [ "https://credentialengine.github.io/credential-registry-ingest-examples/LearningProgram/1/Course-1a.json", diff --git a/LearningProgram/index.md b/LearningProgram/index.md index 0f5610c..5cc2d7e 100644 --- a/LearningProgram/index.md +++ b/LearningProgram/index.md @@ -7,6 +7,17 @@ JSON-LD metadata about a `LearningProgram` so that it can be easily ingested into the Credential Registry with the Credential Registry Publish Action tool on GitHub Actions. +### Publish Graphs in CTDL format for LearningPrograms + +The Credential Registry Publish Action tool supports the ingestion of a +`LearningProgram` (a subclass of `LearningOpportunity`) published as a JSON-LD +`@graph`. This enables the incorporation of a variety of entities into a single +file rather than requiring URI IDs for a number of dependent objects, each of +which must be fetched independently. With a graph format, the data can be +closest to the Credential Registry API input format, which expects string IDs +for certain relationship values, even if those are "blank node identifiers". For +example if an organization wanted to describe that their Credential + ## Learning Program Identifiers The recommended practice for identifying a `LearningProgram` is to use the URL diff --git a/index.md b/index.md index fccbc0f..a73f4e5 100644 --- a/index.md +++ b/index.md @@ -144,6 +144,11 @@ jobs: this case, the value is a single URL, but multiple URLs may be specified, separated by commas. The Credential Registry Publish Action will download the data from these URLs and publish it to the Registry. +- URLs are comma-separated. A comma `,` is a valid character in the path + component of a URL, but if any URLs including commas are desired to be used in + the `URLS` environment variable, they must be percent-encoded as `%2C`. For + example, the URL `https://example.com/path,with,commas` would be written as + `https://example.com/path%2Cwith%2Ccommas` in the `URLS` environment variable. - Within the Publish step, there are several "inputs" configured. The `organization-ctid` input specifies the CTID of the organization publishing the data. This is required because the organization must be published to the