DSNPI - 1320 / Update specialist comment endpoint to new schema

[madz-lw]

Description of change

This PR updates the specialist comment endpoint to use the new schema.

The response now returns a pagination, and a data object. Within the data object, the specialist summary, and also an array of specialists who have responded and have had their comments redacted, and within each specialist is their details, related constraint information (if applicable) and an array of all their comments which includes details such as their sentiment, any files and redacted comments.

Example payload:

{
  "pagination": {
    "resultsPerPage": 10,
    "currentPage": 1,
    "totalPages": 1,
    "totalResults": 10,
    "totalAvailableItems": 10
  },
  "data": {
    "summary": {
      "totalConsulted": 38,
      "totalComments": 6,
      "sentiment": {
        "approved": 5,
        "amendmentsNeeded": 1,
        "objected": 0
      }
    },
    "comments": [
      {
        "id": "2",
        "reason": "Constraint",
        "constraints": [
          [
            {
              "value": "designated_conservationarea",
              "category": "heritage_and_conservation",
              "description": "Conservation area",
              "intersects": true
            }
          ]
        ],
        "firstConsultedAt": "2025-07-14T12:05:58Z",
        "comments": [
          {
            "id": "45",
            "sentiment": "approved",
            "commentRedacted": "Now approved.",
            "files": [
              {
                "name": "test-file.pdf",
                "referencesInDocument": [],
                "url": "http://southwark.bops.localhost:3000/files/6i1b56qcwcs5q23bgwuqy19mvaje",
                "type": [],
                "createdAt": "2025-07-21T09:34:22.114+01:00",
                "applicantDescription": null,
                "metadata": {
                  "byteSize": 10345,
                  "contentType": "application/pdf"
                }
              }
            ],
            "metadata": {
              "submittedAt": "2025-07-21T08:34:22Z",
              "publishedAt": "2025-07-21T08:34:22Z"
            }
          },
          {
            "id": "44",
            "sentiment": "amendmentsNeeded",
            "commentRedacted": "Needs amendments",
            "files": [
              {
                "name": "test-file.pdf",
                "referencesInDocument": [],
                "url": "http://southwark.bops.localhost:3000/files/2sdq1454m8515ctuzzj6aitxxv8c",
                "type": [],
                "createdAt": "2025-07-18T16:37:17.829+01:00",
                "applicantDescription": null,
                "metadata": {
                  "byteSize": 10345,
                  "contentType": "application/pdf"
                }
              }
            ],
            "metadata": {
              "submittedAt": "2025-07-18T15:37:17Z",
              "publishedAt": "2025-07-18T15:37:17Z"
            }
          }
        ]
      },
      {
        "id": "33",
        "reason": "Other",
        "firstConsultedAt": "2025-07-11T11:53:13Z",
        "comments": [
          {
            "id": "12",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:13Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          }
        ]
      },
      {
        "id": "18",
        "reason": "Other",
        "firstConsultedAt": "2025-07-11T11:53:13Z",
        "comments": [
          {
            "id": "10",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:13Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          }
        ]
      },
      {
        "id": "8",
        "reason": "Other",
        "firstConsultedAt": "2025-07-11T11:53:13Z",
        "comments": [
          {
            "id": "9",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:13Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          },
          {
            "id": "7",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:13Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          }
        ]
      },
      {
        "id": "6",
        "reason": "Other",
        "firstConsultedAt": "2025-07-11T11:53:13Z",
        "comments": [
          {
            "id": "6",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:13Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          },
          {
            "id": "5",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:12Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          },
          {
            "id": "4",
            "sentiment": "approved",
            "commentRedacted": "I like it *****",
            "metadata": {
              "submittedAt": "2025-07-18T11:53:12Z",
              "publishedAt": "2025-07-18T11:53:13Z"
            }
          }
        ]
      },
      {
        "id": "1",
        "reason": "Constraint",
        "constraints": [
          [
            {
              "value": "listed",
              "category": "heritage_and_conservation",
              "description": "Listed building outline",
              "intersects": true
            }
          ]
        ],
        "firstConsultedAt": "2025-07-06T09:05:58Z",
        "comments": [
          {
            "id": "43",
            "sentiment": "amendmentsNeeded",
            "commentRedacted": "Great stuff. Just need more maps",
            "metadata": {
              "submittedAt": "2025-07-18T13:55:31Z",
              "publishedAt": "2025-07-18T13:55:31Z"
            }
          }
        ]
      }
    ]
  }
}

Story Link

DSNPI-1320

Decisions

• The metadata section: there is no validated_at date in the current comment flow. Additionally, there is a redacted_at property but it doesn't seem to get set when a comment is redacted.

Known issues [OPTIONAL]

We have limited this ticket to not handle all of the constraint data we expect for now.