Section

Section is attached to a story to categorise the story under a particular group, this grouping might be called differently in other systems, like categories, taxonomy etc.

Format

If the section is parent only

{
  "name": "Business",
  "display-name": "Business",
  "external-id": "Business",
  "slug" : "business",
  "seo-metadata" : {
    "title": "Equity",
    "description": "Equity Section",
    "page-title": "Equity",
    "keywords": ["Market","Equity"]
  },
  "collection-metadata":{
    "key": "value"
  }
}

If the section has a sub-section

{
  "name": "Equity",
  "display-name": "Equity",
  "external-id": "Markets/Equity",
  "slug" : "equity",
  "seo-metadata" : {
    "title": "Equity",
    "description": "Equity Section",
    "page-title": "Equity",
    "keywords": ["Market","Equity"]
  },
  "collection-metadata":{
    "key": "value"
  },
  "parent": {
    "external-id": "Markets",
    "display-name": "Markets",
    "name": "Markets",
    "slug" : "equity" ,
    "seo-metadata" : {
      "title": "Market",
      "description": "Market Section",
      "page-title": "Market",
      "keywords": ["Market"]
    },
     "collection-metadata":{
       "key": "value"
      }
  }
}

Schema

Key	Type
name *	String
display-name *	String
external-id *	String
slug *^[2]	String
seo-metadata	Object
collection-metadata	Object
parent	Section

seo-metadata

Key	Type
title	String
description	String
page-title	String
keywords	Array of Strings

collection-metadata

Key	Type
key	String
value	Any

Notes

[1] All mandatory fields are marked with an *

[2] Slug should be alphanumeric string with hyphen as a delimiter of words. String should not begin or end with a hyphen. Characters should be in lowercase. Other special characters and consecutive hyphens are invalid.

Example

Slug	Validity
testslug01	✓
test1-01-slug	✓
test-Slug	✗
slug!test	✗
-slug-test-	✗