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

Move Swagger Rest API and Automation doc to an optional marketplace

    XMLWordPrintable

    Details

    • Type: Clean up
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2021.x, 2025.x, 2023.18
    • Component/s: Rest API
    • Release Notes Summary:
      Rest Swagger doc available under /nuxeo/api/v1/doc endpoint and Automation doc available under /nuxeo/api/v1/automation/doc endpoint are no longer part of the default distribution
    • Tags:
    • Upgrade notes:
      Hide

      If you need the old swagger documentation or the automation documentation, please install the nuxeo-rest-api-documentation marketplace from connect.

      Doc source is now located at https://github.com/nuxeo/nuxeo-rest-api-swagger-doc.

      Show
      If you need the old swagger documentation or the automation documentation, please install the nuxeo-rest-api-documentation marketplace from connect. Doc source is now located at https://github.com/nuxeo/nuxeo-rest-api-swagger-doc .
    • Team:
      PLATFORM
    • Sprint:
      nxplatform #120
    • Story Points:
      5

      Description

      The Swagger Rest API doc available at https://nightly-2021.nuxeocloud.com/nuxeo/api/v1/doc and located in https://github.com/nuxeo/nuxeo-lts/tree/2023/modules/platform/rest-api/nuxeo-rest-api-server/src/main/resources/skin is old, unmaintained and relies on obsolete javascript libraries of which some have reported CVEs:

      This embedded doc site is only useful for dev purposes. We will move all these resources to an optional marketplace that developers can install.

      Moreover, once the swagger doc is removed from the server, we fall back on an even older automation doc normally located at https://nightly-2021.nuxeocloud.com/nuxeo/api/v1/automation/doc also unmaintained. We will remove this documentation as well.

        Attachments

          Issue Links

          causes

          Bug - A problem which impairs or prevents the functions of the product. NXP-32883 NUXEO Automation & API Documentation page is not working

          • Major - Major loss of function.
          • Resolved
          is related to

          Task - A task that needs to be done. NXBT-3820 Release Nuxeo Rest Api Swagger Documentation marketplace for LTS 2021 and 2023

          • Major - Major loss of function.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. NXP-32822 Upgrade handlebars.js

          • Major - Major loss of function.
          • Resolved

          Bug - A problem which impairs or prevents the functions of the product. NXP-32835 Upgrade underscore-min.js

          • Major - Major loss of function.
          • Resolved

            Activity

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: