@financial-times/cp-content-pipeline-schema 2.5.3 → 2.6.0

package/typedefs/teaser.graphql

@@ -1,28 +1,69 @@
 union MetaLink = Concept | ContentPackage
 
 type Teaser {
+  "The unique identifier of the teaser,  a uuid or a url."
+  id: String
+
+  "The url of the content that the teaser refers to."
   url(relative: Boolean): String!
+  
+  "The type of the teaser, eg. 'article' or 'video'."
   type: String
+
+  "The title of the teaser."
   title: String
-  id: String
+
+  "The image to be used as a thumbnail for the teaser."
   image: Image
+
+  "The date the content of the teaser was published."
   publishedDate: String
+
+  "The date the content of the teaser was first published."
   firstPublishedDate: String
+
+  "An object containing the metadata details of the teaser, eg. id, url, prefLabel."
   metaLink: MetaLink
+
+  "An object containing the metadata details of the teaser, eg. id, url, prefLabel."
   metaAltLink: MetaLink
+
+  "The text to be displayed before the metadata of the teaser."
   metaPrefixText: String
+
+  "The text to be displayed after the metadata of the teaser."
   metaSuffixText: String
+
+  "An object containing a map of indicator items to boolean values, eg. accessLevel, isOpinion."
   indicators: Indicators
+
+  "The theme to use for the teaser, eg. 'opinion' or 'news'."
   theme: String
+
+  "The introductory text of the teaser."
   standfirst: String
 }
 
+"Indicators are used to determine teaser styling."
 type Indicators {
+  "The access level of the teaser, eg. 'free' or 'premium'."
   accessLevel: AccessLevel
+
+  "Whether the teaser is an opinion piece."
   isOpinion: Boolean
+  
+  "Whether the teaser is a column, ie. has one author."
   isColumn: Boolean
+
+  "Whether the teaser is a podcast."
   isPodcast: Boolean
+
+  "Whether the teaser is an editor's choice."
   isEditorsChoice: Boolean
+
+  "Whether the teaser is exclusive."
   isExclusive: Boolean
+
+  "Whether the teaser is a scoop."
   isScoop: Boolean
 }

package/typedefs/topper.graphql

@@ -1,154 +1,366 @@
-interface Topper {
+interface Topper {   
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
   genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
 }
 
 interface TopperWithImages {
+  "An array of images to be displayed on the topper."
   images: [Image!]!
+
+  "A fallback image to be used if the 'images' are not available."
   fallbackImage: Image
 }
 
 interface TopperWithTheme {
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
 }
 
 interface TopperWithHeadshot {
+  "The url of the headshot image, eg. for columns with one key author."
   headshot(width: Int, dpr: Int): String
 }
 
 interface TopperWithBrand {
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
   genreConcept: Concept
 }
 
 interface TopperWithPackage {
+  "The design of the topper, eg. 'standard'."
   design: String
 }
 
 type BasicTopper implements Topper {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
   genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
 }
 
 type SplitTextTopper implements Topper & TopperWithImages & TopperWithTheme & TopperWithBrand & TopperWithPackage {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
+  genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "An array of images to be displayed on the topper."
   images: [Image!]!
+
+  "A fallback image to be used if the 'images' are not availableimages: [Image!]!."
   fallbackImage: Image
+  
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
-  genreConcept: Concept
+
+  "The design of the topper, eg. 'standard'."
   design: String
 }
 
 type FullBleedTopper implements Topper & TopperWithImages & TopperWithTheme & TopperWithBrand {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
+  genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "An array of images to be displayed on the topper."
   images: [Image!]!
+
+  "A fallback image to be used if the 'images' are not availableimages: [Image!]!."
   fallbackImage: Image
+
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
-  genreConcept: Concept
 }
 
 type PodcastTopper implements Topper & TopperWithTheme & TopperWithHeadshot & TopperWithBrand {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
+  genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+  
+  "The url of the headshot image, eg. for columns with one key author."
   headshot(width: Int, dpr: Int): String
+
+  "The concept object describing details of the column author."
   columnist: Concept
+
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
-  genreConcept: Concept
 }
 
 type OpinionTopper implements Topper & TopperWithTheme & TopperWithHeadshot {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
   genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+  
+  "The url of the headshot image, eg. for columns with one key author."
   headshot(width: Int, dpr: Int): String
+
+  "The concept object describing details of the column author."
   columnist: Concept
 }
 
 type BrandedTopper implements Topper & TopperWithTheme & TopperWithBrand {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
+  genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+  
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
-  genreConcept: Concept
 }
 
 type DeepPortraitTopper implements Topper & TopperWithImages & TopperWithTheme & TopperWithBrand {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
+  genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "An array of images to be displayed on the topper."
   images: [Image!]!
+
+  "A fallback image to be used if the 'images' are not availableimages: [Image!]!."
   fallbackImage: Image
+
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
-  genreConcept: Concept
 }
 
 type DeepLandscapeTopper implements Topper & TopperWithImages & TopperWithTheme & TopperWithBrand {
+  "The headline text of the topper."
   headline: String!
+
+  "An abstract syntax tree of the introduction text."
   intro: RichText
+
+  "The background colour of the topper."
   backgroundColour: TopperBackgroundColour
+
+  "Whether the topper should have a background box."
   backgroundBox: Boolean
+
+  "Whether the topper should have a text shadow."
   textShadow: Boolean
+
+  "The concept object to be displayed, eg. {'type': 'TOPIC', 'prefLabel': 'Non-dom tax status', ...}."
   displayConcept: Concept
+
+  "The concept object of the genre, eg. {'type': 'GENRE', 'prefLabel': 'Opinion', ...}."
+  genreConcept: Concept
+
+  "The variant of the follow button to be displayed on the topper."
   followButtonVariant: FollowButtonVariant
+
+  "An array of images to be displayed on the topper."
   images: [Image!]!
+
+  "A fallback image to be used if the 'images' are not availableimages: [Image!]!."
   fallbackImage: Image
+
+  "Whether the headline should be large."
   isLargeHeadline: Boolean
+  
+  "The layout of the topper, eg. 'split-text-left'."
   layout: String
+  
+  "The concept object of the brand, eg. {'type': 'BRAND', 'prefLabel': 'FT Magazine', ...}."
   brandConcept: Concept
-  genreConcept: Concept
 }