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

Server Version Information Endpoint

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 11.5, 2021.1
    • Component/s: Configuration, Rest API
    • Release Notes Description:
      Hide

      The endpoint GET /api/v1/capabilities has been added to Nuxeo in order to retrieve the server capabilities, see below its response format:

      {
        "entity-type": "capabilities",
        "server": {
          "distributionName": "server",
          "distributionVersion": "11.4",
          "distributionServer": "tomcat",
          "hotfixVersion": 1
        },
        "cluster": {
          "enabled": true,
          "nodeId": "foobar"
        }
      }
      

      This endpoint leverages the new CapabilitiesService which exposes the APIs below:

      • void registerCapabilities(String name, Map<String, Object> map)
        register a static server capability and expose it under name in the JSON response
      • void registerCapabilities(String name, Supplier<Map<String, Object>> supplier)
        register a dynamic server capability and expose it under name in the JSON response
      • Capabilities getCapabilities()
        compute the server capabilities and return them as an immutable object

      Registering capabilities might be done during the Component start step.

      By default, two capabilities are registered into the application:

      • the server capability registered by the CapabilitiesService
      • the cluster capability registered by the ClusterService
      Show
      The endpoint GET /api/v1/capabilities has been added to Nuxeo in order to retrieve the server capabilities, see below its response format: { "entity-type" : "capabilities" , "server" : { "distributionName" : "server" , "distributionVersion" : "11.4" , "distributionServer" : "tomcat" , "hotfixVersion" : 1 }, "cluster" : { "enabled" : true , "nodeId" : "foobar" } } This endpoint leverages the new CapabilitiesService which exposes the APIs below: void registerCapabilities(String name, Map<String, Object> map) register a static server capability and expose it under name in the JSON response void registerCapabilities(String name, Supplier<Map<String, Object>> supplier) register a dynamic server capability and expose it under name in the JSON response Capabilities getCapabilities() compute the server capabilities and return them as an immutable object Registering capabilities might be done during the Component start step. By default, two capabilities are registered into the application: the server capability registered by the CapabilitiesService the cluster capability registered by the ClusterService
    • Tags:
    • Team:
      PLATFORM
    • Sprint:
      nxplatform #22, nxplatform #23
    • Story Points:
      3

      Description

      We want to add a new REST endpoint which returns Server Version information.

      The endpoint could be accessible with a GET request on /api/v1, /api/v1/server or /api/v1/configuration (TBD).

      The endpoint will return the following:

      • the server version
      • the server distribution name ("server" or "lts", to make the distinction while comparing versions)
      • the latest HF installed (for >= LTS 2020 with the ZIP Tomcat install)

        Attachments

          Issue Links

            Activity

              People

              • Votes:
                1 Vote for this issue
                Watchers:
                2 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 - 5 hours, 20 minutes
                  5h 20m

                    PagerDuty

                    Error rendering 'com.pagerduty.jira-server-plugin:PagerDuty'. Please contact your Jira administrators.