Uploaded image for project: 'OpenIDM'
  1. OpenIDM
  2. OPENIDM-7238

API Descriptor support for AbstractScriptedService subclasses

    XMLWordPrintable

    Details

    • Story
    • Status: Closed
    • Major
    • Resolution: Fixed
    • None
    • OpenIDM 5.5.0
    • None

      Description

      API Descriptor support for AbstractScriptedService subclasses will require adding Describable interface to the ScriptedRequestHandler class.

      If the API Descriptor is not provided, the service will continue to function normally. Subclasses can optionally override the following method and inspect the configuration parameter to know which script to build a descriptor for,

      AbstractScriptedService.java
          /**
           * Gets API Description for a distinct script. Subclasses should override this method to provide an API Description
           * for the scripted endpoints.
           *
           * @param configuration Script configuration
           * @return API Description or {@code null} if not defined
           */
          protected ApiDescription getApiDescription(final JsonValue configuration) {
              return null;
          }
      

        Attachments

          Issue Links

            Activity

              People

              travis.haagen Travis Haagen [X] (Inactive)
              travis.haagen Travis Haagen [X] (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: