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

Document Nuxeo Drive operations

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 7.10, 7.10-HF39, 8.10, 8.10-HF28, 9.10, 9.10-HF05, 10.1
    • Fix Version/s: 10.3
    • Component/s: Nuxeo Drive
    • Tags:
    • Impact type:
      API change
    • Upgrade notes:
      Hide

      Deprecated the following operations:

      GetRepositoriesOperation
NuxeoDriveAddToLocallyEditedCollection
NuxeoDriveCanMove
NuxeoDriveGenerateConflictedItemName
NuxeoDriveGetClientUpdateInfo
NuxeoDriveWaitForAsyncCompletion

      Deprecated the following operation parameters:

      NuxeoDriveGetChangeSummary#lastSyncActiveRootDefinitions
      Show
      Deprecated the following operations: GetRepositoriesOperation NuxeoDriveAddToLocallyEditedCollection NuxeoDriveCanMove NuxeoDriveGenerateConflictedItemName NuxeoDriveGetClientUpdateInfo NuxeoDriveWaitForAsyncCompletion Deprecated the following operation parameters: NuxeoDriveGetChangeSummary#lastSyncActiveRootDefinitions
    • Sprint:
      nxfit 10.3.8
    • Story Points:
      2

      Description

      Nuxeo Drive operations have

      • no description
      • no explanation about their parameters

      With Studio application definition registries, users will soon be able to add Nuxeo Drive to their dependencies and automatically see all its operations appear for them to use.

      Unfortunately, they won't be able to use them without a proper documentation and are likely to open support tickets instead until this problem is solved.

      TODO

      • Update Drive operations description to explain what every operation does, what kind of values the parameters expect to make them usable by customers in their own business logic.

        Attachments

          Issue Links

          is related to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. NXS-4254 NOS: Application Definition Registries

          • Major - Major loss of function.
          • Resolved
          is required by

          Clean up - NXDRIVE-1402 Clean up usage of lastSyncActiveRootDefinitions parameter deprecated in NuxeoDrive.GetChangeSummary

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

          Clean up - NXDRIVE-1401 Clean up usage of deprecated server-side Automation operations

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

            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, 6 hours
                  1d 6h