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

package/typedefs/clip.graphql

@@ -1,27 +1,55 @@
 type ClipSource {
+  "The audio encoding format of the source, eg. mp3."
   audioCodec: String
+
+  "The url of the clip source, eg. 'https://next-media-api.ft.com/renditions/16868569859480/0x0.mp3'."
   binaryUrl: String!
+
+  "The duration of the clip in milliseconds."
   duration: Int
+
+  "The media type eg. video/mp4."
   mediaType: String!
+
+ "The height of the clip in pixels."
   pixelHeight: Int
+
+  "The width of the clip in pixels."
   pixelWidth: Int
+
+  "The video encoding format of the source, eg. h264."
   videoCodec: String
 }
 
 type Clip {
+  "The unique identifier of the clip - a uuid or a url."
   id: String!
+
+  "The type of the clip, eg. 'http://www.ft.com/ontology/content/Clip'."
   type: String
+
+  "The format of the clip, eg. 'standard-inline' or 'mobile'."
   format: ClipFormat
+
+  "An array of data sources - includes 'video/mp4' and 'audio/mp3' sources."
   dataSource: [ClipSource!]!
+
+  "The url of the image to be used as a poster for the clip, eg. 'https://www.ft.com/__origami/service/image...'."
   poster: String
 }
 
 type Caption {
+  "The media type of the caption eg. text/vtt."
   mediaType: String
+
+  "The url of the caption, eg. 'https://next-media-api.ft.com/clips/captions/32065513'."
   url: String
 }
 
 type Accessibility {
+  "An array of captions for the clip."
   captions: [Caption]
+
+  "An abstract syntax tree of the transcript for the clip."
   transcript: RichText
 }

package/typedefs/concept.graphql

@@ -1,11 +1,30 @@
+"A concept is supplemtary information item, like a location, person, organisation or topic. It is used to provide context to an article."
+
 type Concept {
+  "The unique identifier of the concept -  a uuid or a url."
+  id: ID!
+
+  "The url of the media, eg. 'https://next-media-api.ft.com/renditions/16868569859480/0x0.mp3'."
+  url(vanity: Boolean, relative: Boolean): String!
+
+  "The api url of the concept, eg. 'http://api.ft.com/things/a579350c-61ce-4c00-97ca-ddaa2e0cacf6'."
   apiUrl: String
+
+  "The type of the concept, eg. 'http://www.ft.com/ontology/Topic'."
   directType: String
+
+  "Whether the concept is part of a package brand eg. 'ftSeries' or 'ftGuides'."
   isPackageBrand: Boolean
-  id: ID!
+
+  "The relationship between the concept and the article, eg. 'http://www.ft.com/ontology/hasAuthor'."
   predicate: String
+
+  "The preferred label of the concept, eg. 'Work & Careers'."
   prefLabel: String!
+
+  "The type of the concept, eg. 'TOPIC'."
   type: String
+  
+  "An array of types, eg. ['http://www.ft.com/ontology/core/Thing', 'http://www.ft.com/ontology/Topic']."
   types: [String!]
-  url(vanity: Boolean, relative: Boolean): String!
 }