Profile: has-notes

Profile Schema

The has-notes profile indicates a document that contains notes. It requires the document to contain an array called notes which must have in it at least one asset-link type link. The href is expected to point to a note asset within the assets array (See the publishable profile documentation).

Structure

Name	Type	Required?	Explanation
notes	array	Yes	That notes array - as mentioned above - is meant to be populated by one or more asset-link objects that point to unique note assets. For each asset linked it is expected the rels array contains a string. See the below section on rels for acceptable enums for the rels array

Rels

The has-notes acceptable rels values are only one - editorial - but the design of this profile is that the CDS community can add more as necessary for other note type use-cases:

• editorial - Designates a note that is an Editor’s Note. One that by definition that clarifies, reframes, or otherwise comments on the reporting in a story.

Example JSON

{
    "id": "g-s1-test-story-with-notes",
    "title": "Test story with notes!",
    "teaser": "A lightweight JSON document showcasing the new has-notes profile",
    "profiles": [
        {
            "href": "/v1/profiles/story",
            "rels": ["type"]
        },
        {
            "href": "/v1/profiles/publishable",
            "rels": ["interface"]
        },
        {
            "href": "/v1/profiles/document"
        },
        {
            "href": "/v1/profiles/has-notes"
        }
    ],
    "authorizedOrgServiceIds": ["s1"],
    "owners": [
        {
            "href": "https://organization.api.npr.org/v4/services/s1"
        }
    ],
    "brandings": [
        {
            "href": "https://organization.api.npr.org/v4/services/s1"
        }
    ],
    "publishDateTime": "2025-01-01T00:59:00-05:00",
    "notes": [
        {
            "href": "#/assets/g-s1-test-story-with-notes-note-001",
            "rels": ["editorial"]
        }
    ],
    "assets": {
        "g-s1-test-story-with-notes-note-001": {
            "profiles": [
                {
                    "href": "/v1/profiles/document"
                },
                {
                    "href": "/v1/profiles/note",
                    "rels": ["type"]
                }
            ],
            "id": "g-s1-test-story-with-notes-note-001",
            "title": "From the Editors Desk",
            "text": "A note on this story, from the Editor",
            "dateTime": "2025-01-01T00:59:00-05:00"
        }
    }
}