@financial-times/cp-content-pipeline-schema 2.5.2 → 2.5.4

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
 }