Comment

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/regulations-gov/main/json-schema/comment.json",
  "title": "Comment",
  "description": "A public comment submitted on a federal regulatory document via the Regulations.gov API.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The JSON:API resource ID (documentId of the comment)"
    },
    "type": {
      "type": "string",
      "enum": ["comments"],
      "description": "The JSON:API resource type"
    },
    "attributes": {
      "type": "object",
      "properties": {
        "agencyId": {
          "type": "string",
          "description": "The acronym used to abbreviate the name of the agency associated with the document."
        },
        "documentType": {
          "type": "string",
          "enum": ["Notice", "Rule", "Proposed Rule", "Supporting & Related Material", "Other"],
          "description": "The type of regulatory document."
        },
        "highlightedContent": {
          "type": ["string", "null"],
          "description": "Content highlighted by search engine for the searchTerm."
        },
        "lastModifiedDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date comment was last modified in the system."
        },
        "objectId": {
          "type": "string",
          "description": "The internal ID of the comment in our system."
        },
        "postedDate": {
          "type": "string",
          "description": "The date that the comment was posted by the agency to the system."
        },
        "title": {
          "type": "string",
          "description": "The formal title of the document."
        },
        "withdrawn": {
          "type": "boolean",
          "description": "Conveys if the comment is withdrawn."
        },
        "comment": {
          "type": "string",
          "description": "The comment text associated with the comment submission."
        },
        "commentOnDocumentId": {
          "type": "string",
          "description": "documentId of the parent document."
        },
        "docketId": {
          "type": "string",
          "description": "The ID of the docket to which the document corresponds."
        },
        "duplicateComments": {
          "type": "integer",
          "description": "Number of duplicate comments."
        },
        "firstName": {
          "type": ["string", "null"],
          "description": "The submitter's first name."
        },
        "lastName": {
          "type": ["string", "null"],
          "description": "The submitter's last name."
        },
        "organization": {
          "type": ["string", "null"],
          "description": "The organization that the submitter represents."
        },
        "submitterType": {
          "type": "string",
          "enum": ["Anonymous", "Individual", "Organization"],
          "description": "The submitter type."
        },
        "postedDate": {
          "type": "string",
          "description": "The date that the comment was posted."
        },
        "receiveDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date that the comment was received by the agency."
        }
      },
      "required": ["agencyId", "title"]
    }
  },
  "required": ["id", "type", "attributes"]
}