action flat_get_score_comments {
  label: "List comments"
  description: "This method lists the different comments added on a music score (documents and inline) sorted by their post dates."
  provider: flat
  method: GET
  path: "/scores/{score}/comments"
  encoding: json
  input: {
    type: "object"
    properties: {
      direction: {
        type: "string"
        enum: ["asc", "desc"]
      }
      sort: {
        type: "string"
        enum: ["date"]
      }
      type: {
        type: "string"
        enum: ["document", "inline"]
      }
    }
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      description: "Comment added on a sheet music"
      properties: {
        comment: {
          type: "string"
          description: "The comment text that can includes mentions using the following\nformat: `@[id:username]`.\n"
        }
        context: {
          type: "object"
          description: "The context of the comment (for inline/contextualized comments). A context will include all the information related to the location of the comment (i.e. score parts, range of measure, time position).\n"
          required: ["measureUuids", "partUuid", "startDpq", "startTimePos", "stopDpq", "stopTimePos"]
          properties: {
            measureUuids: {
              type: "array"
              description: "The list of measure UUIds"
              items: {
                type: "string"
              }
            }
            partUuid: {
              type: "string"
              description: "The unique identifier (UUID) of the score part"
            }
            staffIdx: {
              type: "number"
              description: "(Deprecated, use `staffUuid`) The identififer of the staff"
            }
            staffUuid: {
              type: "string"
              description: "The unique identififer (UUID) of the staff"
            }
            startDpq: {
              type: "number"
            }
            startTimePos: {
              type: "number"
            }
            stopDpq: {
              type: "number"
            }
            stopTimePos: {
              type: "number"
            }
          }
        }
        date: {
          type: "string"
          format: "date-time"
          description: "The date when the comment was posted"
        }
        id: {
          type: "string"
          description: "The comment unique identifier"
        }
        mentions: {
          type: "array"
          description: "The list of user identifier mentioned on the score"
          items: {
            type: "string"
          }
        }
        modificationDate: {
          type: "string"
          format: "date-time"
          description: "The date of the last comment modification"
        }
        rawComment: {
          type: "string"
          description: "A raw version of the comment, that can be displayed without parsing\nthe mentions.\n"
        }
        replyTo: {
          type: "string"
          description: "When the comment is a reply to another comment, the unique identifier of the parent comment\n"
        }
        resolved: {
          type: "boolean"
          description: "For inline comments, the comment can be marked as resolved and will be hidden in the future responses\n"
        }
        resolvedBy: {
          type: "string"
          description: "If the user is marked as resolved, this will contain the unique identifier of the User who marked this comment as resolved\n"
        }
        revision: {
          type: "string"
          description: "The unique identifier of revision the comment was posted"
        }
        score: {
          type: "string"
          description: "The unique identifier of the score where the comment was posted"
        }
        spam: {
          type: "boolean"
          description: "`true  if the message has been detected as spam and hidden from other users\n"
        }
        type: {
          type: "string"
          description: "The type of the comment"
          enum: ["document", "inline"]
        }
        user: {
          type: "string"
          description: "The author unique identifier"
        }
      }
    }
  }
}