ArticleIndex

Representation of an article or post returned in a list

Developer CommunityArticlesBloggingSocialContentOpen Source

Properties

Name	Type	Description
type_of	string
id	integer
title	string
description	string
cover_image	string
readable_publish_date	string
social_image	string
tag_list	array
tags	string
slug	string
path	string
url	string
canonical_url	string
positive_reactions_count	integer
public_reactions_count	integer
created_at	string
edited_at	string
crossposted_at	string
published_at	string
last_comment_at	string
published_timestamp	string	Crossposting or published date time
reading_time_minutes	integer	Reading time, in minutes
user	object
flare_tag	object
organization	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ArticleIndex",
  "description": "Representation of an article or post returned in a list",
  "type": "object",
  "properties": {
    "type_of": {
      "type": "string"
    },
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "cover_image": {
      "type": "string",
      "format": "url",
      "nullable": true
    },
    "readable_publish_date": {
      "type": "string"
    },
    "social_image": {
      "type": "string",
      "format": "url"
    },
    "tag_list": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "string"
    },
    "slug": {
      "type": "string"
    },
    "path": {
      "type": "string",
      "format": "path"
    },
    "url": {
      "type": "string",
      "format": "url"
    },
    "canonical_url": {
      "type": "string",
      "format": "url"
    },
    "positive_reactions_count": {
      "type": "integer",
      "format": "int32"
    },
    "public_reactions_count": {
      "type": "integer",
      "format": "int32"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "edited_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "crossposted_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "published_at": {
      "type": "string",
      "format": "date-time"
    },
    "last_comment_at": {
      "type": "string",
      "format": "date-time"
    },
    "published_timestamp": {
      "description": "Crossposting or published date time",
      "type": "string",
      "format": "date-time"
    },
    "reading_time_minutes": {
      "description": "Reading time, in minutes",
      "type": "integer",
      "format": "int32"
    },
    "user": {
      "$ref": "#/components/schemas/SharedUser"
    },
    "flare_tag": {
      "$ref": "#/components/schemas/ArticleFlareTag"
    },
    "organization": {
      "$ref": "#/components/schemas/SharedOrganization"
    }
  },
  "required": [
    "type_of",
    "id",
    "title",
    "description",
    "cover_image",
    "readable_publish_date",
    "social_image",
    "tag_list",
    "tags",
    "slug",
    "path",
    "url",
    "canonical_url",
    "comments_count",
    "positive_reactions_count",
    "public_reactions_count",
    "created_at",
    "edited_at",
    "crossposted_at",
    "published_at",
    "last_comment_at",
    "published_timestamp",
    "user",
    "reading_time_minutes"
  ]
}