Trust Schema Module

The Trust Schema Module enables individual Drupal sites to declare and expose trust metadata on selected content nodes. This metadata helps establish the credibility and context of content when it's syndicated across different sites.

Features

• Trust metadata fields for content nodes:

  • Trust Role (e.g., primary source, secondary source)
  • Trust Scope (e.g., department level, university level)
  • Trust Contact (email for verification)
  • Trust Topics (taxonomy terms categorizing the content)
  • Trust Syndication Enabled (toggle for syndication)

• JSON:API integration for exposing trust metadata

• Custom form for managing trust metadata on nodes

• Trust Topics taxonomy vocabulary for categorizing content

Installation

1. Place the module in your Drupal installation's modules/custom directory
2. Enable the module using Drush or the Drupal admin interface:

   drush en ucb_trust_schema

3. The module will automatically create the necessary database table and taxonomy vocabulary

Usage

Managing Trust Metadata

1. Navigate to any content node
2. Click the "Trust Syndication" tab
3. Fill in the trust metadata fields:
   • Select a Trust Role
   • Choose a Trust Scope
   • Enter a Trust Contact email
   • Select one or more Trust Topics
   • Enable/disable syndication as needed
4. Save the changes

Accessing Trust Metadata via JSON:API

Trust metadata is exposed through the JSON:API endpoints.

Basic Syndicated Nodes Endpoint

Here is the easiest way to just view all syndicated nodes:

/api/trust-schema/syndicated-nodes

The response will include trust metadata in this format:

{
  "data": [{
    "id": "3",
    "type": "basic_page",
    "attributes": {
      "title": "Example Page",
      "trust_role": "primary_source",
      "trust_scope": "department_level",
      "trust_contact": "example@berkeley.edu",
      "trust_topics": ["Science", "Mathematics"],
      "trust_syndication_enabled": true
    }
  }]
}

Advanced JSON:API Endpoint

For more detailed access to trust metadata with related node and taxonomy information, use the following JSON:API endpoint:

/jsonapi/trust_metadata/trust_metadata?fields[trust_metadata--trust_metadata]=trust_role,trust_scope,trust_contact,trust_topics,node_id&fields[taxonomy_term--trust_topic]=name&fields[node--article]=title,body,path,created,changed&include=trust_topics,node_id

This endpoint returns:

• Trust metadata fields (trust_role, trust_scope, trust_contact, trust_topics)
• Related node information (title, body, path, created, changed)
• Trust topic names
• All relationships between these entities

Example response:

{
  "data": [
    {
      "type": "trust_metadata--trust_metadata",
      "id": "1",
      "attributes": {
        "trust_role": "primary_source",
        "trust_scope": "campus_wide",
        "trust_contact": "contact@example.com",
        "trust_topics": ["Science", "Research"],
        "node_id": "123"
      },
      "relationships": {
        "trust_topics": {
          "data": [
            { "type": "taxonomy_term--trust_topic", "id": "1" },
            { "type": "taxonomy_term--trust_topic", "id": "2" }
          ]
        },
        "node_id": {
          "data": { "type": "node--article", "id": "123" }
        }
      }
    }
  ],
  "included": [
    {
      "type": "taxonomy_term--trust_topic",
      "id": "1",
      "attributes": {
        "name": "Science"
      }
    },
    {
      "type": "taxonomy_term--trust_topic",
      "id": "2",
      "attributes": {
        "name": "Research"
      }
    },
    {
      "type": "node--article",
      "id": "123",
      "attributes": {
        "title": "Article Title",
        "body": { "value": "Article content..." },
        "path": { "alias": "/article/article-title" },
        "created": "2024-03-20T10:00:00+00:00",
        "changed": "2024-03-20T10:00:00+00:00"
      }
    }
  ]
}

You can customize the response by:

• Adding or removing node fields in fields[node--article]
• Adding or removing trust metadata fields in fields[trust_metadata--trust_metadata]
• Adding or removing included relationships in the include parameter

Note:

• Replace {node-id} with the actual node ID
• Replace your-site.com with your actual domain
• All endpoints require appropriate permissions to access

Trust Topics

The module creates a "Trust Topics" taxonomy vocabulary with default terms:

• Mathematics
• Science
• Arts

Additional terms can be added through the Drupal taxonomy interface.

Permissions

The module provides two permissions:

• "Manage trust metadata" - Allows users to assign or modify trust metadata fields
• "View trust metadata" - Allows users to view trust metadata fields

Dependencies

• Drupal Core (10.x or 11.x)
• JSON:API module

Technical Details

For detailed technical documentation, see TECHNICAL.md.