Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-29610

Add an endpoint to get all comments for 50+ annotations

    XMLWordPrintable

    Details

    • Tags:
    • Upgrade notes:
      Hide

      REST API

      The endpoint GET /nuxeo/api/v1/id/DOC_ID/@annotation/comments has been deprecated in favor of POST /nuxeo/api/v1/id/DOC_ID/@annotation/comments.

      The annotationIds are now given in the payload request as a simple json array.

      For instance:

      curl -XPOST http://localhost:8080/nuxeo/api/v1/id/DOC_ID/@annotation/comments -d '[ "ANNOT_ID1", "ANNOT_ID2", ...  ]'

      Java API

      Added:
      CommentManager#getComments(CoreSession session, Collection<String> documentIds)
      AnnotationAdapter#getCommentsFromBody(String payload)

      Deprecated:
      AnnotationAdapter#getComments(@QueryParam("annotationIds") List<String> annotationIds)

      Show
      REST API The endpoint GET /nuxeo/api/v1/id/DOC_ID/@annotation/comments has been deprecated in favor of POST /nuxeo/api/v1/id/DOC_ID/@annotation/comments . The annotationIds are now given in the payload request as a simple json array. For instance: curl -XPOST http: //localhost:8080/nuxeo/api/v1/id/DOC_ID/@annotation/comments -d '[ "ANNOT_ID1" , "ANNOT_ID2" , ... ]' Java API Added: CommentManager#getComments(CoreSession session, Collection<String> documentIds) AnnotationAdapter#getCommentsFromBody(String payload) Deprecated: AnnotationAdapter#getComments(@QueryParam("annotationIds") List<String> annotationIds)
    • Team:
      PLATFORM
    • Sprint:
      nxplatform #16, nxplatform #17
    • Story Points:
      2

      Description

      We want to add a new endpoint to the AnnotationAdapter allowing us to retrieve all comments of given annotations.

      Such endpoint already exists but suffers from the URL length limitation as It is a GET endpoint with annotationIds as query parameters.

      The endpoint to introduce would be a POST one and will take the annotationIds in the request body.

        Attachments

          Issue Links

          causes

          Task - A task that needs to be done. NXDOC-2185 Update annotation endpoint

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          is required by

          Bug - A problem which impairs or prevents the functions of the product. NEV-284 Fix annotation loading on document with 50+ annotations

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. JAVACLIENT-209 Add the POST /comments endpoint to annotation adapter

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          Is referenced in

          [Captain Hook] PR for 10.10: #4313 PR for 10.10: #4313

          [Captain Hook] PR for master: #4305 PR for master: #4305

          [Captain Hook] PR for master: #4597 PR for master: #4597

          [Captain Hook] PR for master: #4752 PR for master: #4752

          [Captain Hook] PR for master: #4769 PR for master: #4769

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day, 4 hours
                  1d 4h