Skip to content

Instantly share code, notes, and snippets.

@edwardchan
Created May 16, 2017 21:02
Show Gist options
  • Save edwardchan/a0219c00d64fd1828177b4e2f6d85a02 to your computer and use it in GitHub Desktop.
Save edwardchan/a0219c00d64fd1828177b4e2f6d85a02 to your computer and use it in GitHub Desktop.
{"swagger":"2.0","schemes":["http"],"info":{"description":"@todo update","title":"Thrillist - API","version":"No API version"},"paths":{"\/node\/{node}":{"get":{"parameters":[{"name":"_format","in":"query","type":"string","enum":["json"],"required":true,"description":"Request format","default":"json"},{"name":"node","in":"path","required":true,"type":"string","description":"The nid,id, of the node."},{"name":"X-CSRF-Token","type":"string","in":"header","required":true}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#\/definitions\/node:article"}},"400":{"description":"Bad request","schema":{"type":"object","properties":{"error":{"type":"string","example":"Bad data"}}}},"500":{"description":"Internal server error.","schema":{"type":"object","properties":{"message":{"type":"string","example":"Internal server error."}}}}},"tags":["node"],"summary":"Get a Content","operationId":"entity:node:GET","schemes":["http"],"security":[]}}},"host":"thrillist.mcdev","basePath":"","securityDefinitions":{"csrf_token":{"type":"apiKey","name":"X-CSRF-Token","in":"header"},"basic_auth":{"type":"basic"}},"tags":[{"name":"node","description":"Entity type: Content","x-entity-type":"node"},{"name":"taxonomy_term","description":"Entity type: Taxonomy term","x-entity-type":"taxonomy_term"}],"definitions":{"node":{"type":"object","title":"node Schema","description":"Describes the payload for \u0027node\u0027 entities.","properties":{"nid":{"type":"array","title":"ID","items":{"type":"object","properties":{"value":{"type":"integer","title":"Integer value"}},"required":["value"]},"maxItems":1},"uuid":{"type":"array","title":"UUID","items":{"type":"object","properties":{"value":{"type":"string","title":"Text value","format":"uuid","maxLength":128}},"required":["value"]},"maxItems":1},"vid":{"type":"array","title":"Revision ID","items":{"type":"object","properties":{"value":{"type":"integer","title":"Integer value"}},"required":["value"]},"maxItems":1},"langcode":{"type":"array","title":"Language","items":{"type":"object","properties":{"value":{"type":"string","title":"Language code"}},"required":["value"]},"maxItems":1},"type":{"type":"array","title":"Content type","items":{"type":"object","properties":{"target_id":{"type":"string","title":"Content type ID"}},"required":["target_id"]},"minItems":1,"maxItems":1},"status":{"type":"array","title":"Publishing status","description":"A boolean indicating the published state.","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"default":[{"value":true}],"maxItems":1},"title":{"type":"array","title":"Title","items":{"type":"object","properties":{"value":{"type":"string","title":"Text value","maxLength":255}},"required":["value"]},"minItems":1,"maxItems":1},"uid":{"type":"array","title":"Authored by","description":"The username of the content author.","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"User ID"}},"required":["target_id"],"title":"User","description":"The referenced entity"},"maxItems":1},"created":{"type":"array","title":"Authored on","description":"The time that the node was created.","items":{"type":"object","properties":{"value":{"type":"number","title":"Timestamp value","format":"utc-millisec"}},"required":["value"]},"maxItems":1},"changed":{"type":"array","title":"Changed","description":"The time that the node was last edited.","items":{"type":"object","properties":{"value":{"type":"number","title":"Timestamp value","format":"utc-millisec"}},"required":["value"]},"maxItems":1},"promote":{"type":"array","title":"Promoted to front page","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"default":[{"value":true}],"maxItems":1},"sticky":{"type":"array","title":"Sticky at top of lists","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"default":[{"value":false}],"maxItems":1},"revision_timestamp":{"type":"array","title":"Revision timestamp","description":"The time that the current revision was created.","items":{"type":"object","properties":{"value":{"type":"number","title":"Timestamp value","format":"utc-millisec"}},"required":["value"]},"maxItems":1},"revision_uid":{"type":"array","title":"Revision user ID","description":"The user ID of the author of the current revision.","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"User ID"}},"required":["target_id"],"title":"User","description":"The referenced entity"},"maxItems":1},"revision_log":{"type":"array","title":"Revision log message","description":"Briefly describe the changes you have made.","items":{"type":"object","properties":{"value":{"type":"string","title":"Text value"}},"required":["value"]},"default":[{"value":""}],"maxItems":1},"revision_translation_affected":{"type":"array","title":"Revision translation affected","description":"Indicates if the last edit of a translation belongs to current revision.","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"maxItems":1},"default_langcode":{"type":"array","title":"Default translation","description":"A flag indicating whether this is the default translation.","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"default":[{"value":true}],"maxItems":1},"path":{"type":"array","title":"URL alias","items":{"type":"object","properties":{"alias":{"type":"string","title":"Path alias"},"pid":{"type":"integer","title":"Path id"},"pathauto":{"type":"integer","title":"Pathauto state","description":"Whether an automated alias should be created or not."}}},"maxItems":1},"published_at":{"type":"array","title":"Published on","description":"Keep the publication timestamp for each node.","items":{"type":"object","properties":{"value":{"type":"number","title":"Timestamp value","format":"utc-millisec"},"published_at_or_now":{"type":"number","title":"Published at or now","format":"utc-millisec"}},"required":["value"]},"maxItems":1},"menu_link":{"type":"array","title":"Menu link","description":"Computed menu link for the node (only available during node saving).","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Custom menu link ID"}},"required":["target_id"],"title":"Custom menu link","description":"The referenced entity"},"maxItems":1}},"required":["type","title"],"discriminator":"type"},"node:article":{"allOf":[{"$ref":"#\/definitions\/node"},{"type":"object","title":"node:article Schema","description":"Use \u003Cem\u003Earticles\u003C\/em\u003E for time-sensitive content like news, press releases or blog posts.","properties":{"status":{"type":"array","title":"Publishing status","description":"A boolean indicating whether the node is published.","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"default":[{"value":false}],"maxItems":1},"promote":{"type":"array","title":"Promoted to front page","items":{"type":"object","properties":{"value":{"type":"boolean","title":"Boolean value"}},"required":["value"]},"default":[{"value":false}],"maxItems":1},"comment":{"type":"array","title":"Comments","items":{"type":"object","properties":{"status":{"type":"integer","title":"Comment status"},"cid":{"type":"integer","title":"Last comment ID"},"last_comment_timestamp":{"type":"integer","title":"Last comment timestamp","description":"The time that the last comment was created."},"last_comment_name":{"type":"string","title":"Last comment name","description":"The name of the user posting the last comment."},"last_comment_uid":{"type":"integer","title":"Last comment user ID"},"comment_count":{"type":"integer","title":"Number of comments","description":"The number of comments."}},"required":["status"]},"minItems":1,"default":[{"status":2,"cid":0,"last_comment_name":"","last_comment_timestamp":0,"last_comment_uid":0,"comment_count":0}],"maxItems":1},"field_ad_tags":{"type":"array","title":"Ad Tags","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_author":{"type":"array","title":"Author","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_brand":{"type":"array","title":"Brand","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"},"maxItems":1},"field_cover_image":{"type":"array","title":"Cover Image","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Media ID"}},"required":["target_id"],"title":"Media","description":"The referenced entity"}},"field_destination":{"type":"array","title":"Destination","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_edition":{"type":"array","title":"Edition","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"},"maxItems":1},"field_edit_revised":{"type":"array","title":"Edit Revised","description":"Timestamp automatically generated via the \u0022Save and Update\u0022 button.","items":{"type":"object","properties":{"value":{"type":"string","title":"Text value","maxLength":10}},"required":["value"]},"maxItems":1},"field_elements":{"type":"array","title":"Page Elements","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Paragraph ID"},"target_revision_id":{"type":"integer","title":"Paragraph revision ID"}},"required":["target_id","target_revision_id"]}},"field_feature":{"type":"array","title":"Feature","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_flags":{"type":"array","title":"Flags","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_franchise":{"type":"array","title":"Franchise","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_highlight":{"type":"array","title":"Highlight","items":{"type":"object","properties":{"url":{"type":"string","title":"URL","description":"URL path"},"weight":{"type":"integer","title":"Weight","description":"Weight"}}},"maxItems":1},"field_json":{"type":"array","title":"JSON","description":"Allows storing of JSON data for computed values such as data from Kyoto. ","items":{"type":"object","properties":{"value":{"type":"string","title":"Text value"}},"required":["value"]},"maxItems":1},"field_layout":{"type":"array","title":"Layout","description":"Specifies type of Pinnacle template to use.","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"},"maxItems":1},"field_metatags":{"type":"array","title":"Metatags","items":{"type":"object","properties":{"value":{"type":"metatag","title":"Metatag"}},"required":["value"]},"default":[{"value":"a:0:{}"}],"maxItems":1},"field_navigation":{"type":"array","title":"Custom Navigation","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"},"maxItems":1},"field_original_published_at":{"type":"array","title":"Original Published On","description":"The original published timestamp.","items":{"type":"object","properties":{"value":{"type":"string","title":"Date value","format":"date"}},"required":["value"]},"maxItems":1},"field_path":{"type":"array","title":"Path","items":{"type":"object","properties":{"value":{"type":"string","title":"Text value","maxLength":255}},"required":["value"]},"maxItems":1},"field_platform":{"type":"array","title":"Platform Compatibility","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_primary_vertical":{"type":"array","title":"Primary Vertical","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"},"maxItems":1},"field_region":{"type":"array","title":"Region","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_related_articles":{"type":"array","title":"Related Articles","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Content ID"}},"required":["target_id"],"title":"Content","description":"The referenced entity"}},"field_related_content":{"type":"array","title":"Related Content","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Content ID"}},"required":["target_id"],"title":"Content","description":"The referenced entity"}},"field_related_venues":{"type":"array","title":"Related Venues","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Content ID"}},"required":["target_id"],"title":"Content","description":"The referenced entity"}},"field_relevance":{"type":"array","title":"Relevance","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_reporting":{"type":"array","title":"Reporting","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_spirits":{"type":"array","title":"Spirits","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_sponsor":{"type":"array","title":"Sponsor","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_tags":{"type":"array","title":"Tags","description":"Enter a comma-separated list. For example: Amsterdam, Mexico City, \u0022Cleveland, Ohio\u0022","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"field_vertical":{"type":"array","title":"Vertical","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Taxonomy term ID"}},"required":["target_id"],"title":"Taxonomy term","description":"The referenced entity"}},"promote_on":{"type":"array","title":"Promote on","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Scheduled update ID"}},"required":["target_id"],"title":"Scheduled update","description":"The referenced entity"},"maxItems":1},"publish_on":{"type":"array","title":"Publish on","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Scheduled update ID"}},"required":["target_id"],"title":"Scheduled update","description":"The referenced entity"},"maxItems":1},"unpromote_on":{"type":"array","title":"Unpromote on","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Scheduled update ID"}},"required":["target_id"],"title":"Scheduled update","description":"The referenced entity"},"maxItems":1},"unpublish_on":{"type":"array","title":"Unpublish on","items":{"type":"object","properties":{"target_id":{"type":"integer","title":"Scheduled update ID"}},"required":["target_id"],"title":"Scheduled update","description":"The referenced entity"},"maxItems":1}},"required":["type","title","comment"]}]}}}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment