lscalese/iris-config-api

A library to ease IRIS configuration.

iris-config-api's Issues

Add documentation to swagger file.

Add ZPM Call

Following community comments on this article :
Adding a feature to call ZPM client command on loading configuration document.

Ex :

{
    "ZPM" : {
        "IRISAPP" : [{
            "install" : "module-name"
        }]
    }
}

It's subject to changes or removes depending on the community feedback.

Replace %Library.ResultSet by %SQL.Statement

Replace %Library.Resultset usage by %SQL.Statement :

• Api.Config.Services.Security.SQLPrivileges
• Api.Config.Services.Security.SQLAdminPrivilegeSet
• Api.Config.Services.Library.SQLConnection
• Api.Config.Services.MapShadows
• Api.Config.Services.MapRoutines
• Api.Config.Services.MapPackages
• Api.Config.Services.MapMirrors
• Api.Config.Services.MapGlobals

Create a template to use config-api with ZPM

Create a template from objectscript-docker-template to use config-api.

NLS Locales Install

Add a section to install locales, ex :

Do ##class(Config.NLS.Locales).Install("fraw")

Install /api/config web application script

Add utils class method to init install of web application /api/config.

Expose export configuration in REST

REST Expose for new Config.Api.Security classes

Complete swagger.json file to generate REST services for :

• Api.Config.Services.Security.Users
• Api.Config.Services.Security.Roles
• Api.Config.Services.Security.Resources
• Api.Config.Services.Security.SSLConfigs
• Api.Config.Services.Security.SQLPrivileges
• Api.Config.Services.Security.SQLAdminPrivilegeSet
• Api.Config.Services.Library.SQLConnection

Add Security.System class support

Add Securty.System support to load configuration via a JSON file :

example :

{
    "Security.System": {
        "SSLSuperServer":"1"
    }
}

Expose config load in REST

Enable Ensemble

Add an Ensemble property in Namespaces section to enable automatically interoperability, ex :

"Namespaces":{                  /* Service class name related to Api.Config.Services.Namespaces. */
       "MYAPP": {                  /* Create a Namespace MYAPP. */
           "Globals":"MYAPPDATA",  /* Set default database for globals. */
           "Routines":"MYAPPCODE",  /* Set default database for routines. */
           "Ensemble": true 
       }
}

Execute automatically Do ##class(%Library.EnsembleMgr).EnableNamespace("MYAPP")

Create Unit Tests

Naming convention

Refactor following the naming convention.

Classes should be renamed to dc.config instead api.config.

Add database to mirror

Currently, databases can be added to the mirror only on mirror set creation.

It should be interesting to provide a section to add databases in the mirror on an already existing mirror set.

Split rest api by package

Split the REST API by package :

• config
• security
• SYS

Create a main REST class to forward route /config, /security, /SYS to the rest REST class.

Expose SYS.Services in REST

Add helper for SQL privileges

Add helper to wrap the existing api to set SQL privileges.
The existing API is not convenient, for example, it's not easy to use to set privileges to a schema.

%SOAP.WebserviceInfo AND %SOAP.WebServiceInvoke

Add properties in Security.Applications to allow access to the catalog and test pages

"Security.Applications": {                     
       "/csp/zrestapp": {                         
           "DispatchClass" : "my.dispatch.class", 
           "Namespace" : "MYAPP",
           "Enabled" : "1",
           "AuthEnabled": "64",
           "CookiePath" : "/csp/zrestapp/",
           "WebServiceInfo" : "1",
           "WebServiceInvoke" : "1"
       }
   }

Execute :

set ^SYS("Security","CSP","AllowClass","/csp/zrestapp","%SOAP.WebServiceInfo")=1
set ^SYS("Security","CSP","AllowClass","/csp/zrestapp","%SOAP.WebServiceInvoke")=1