WSC: configlist

[remiges-aniket]

WSC: configlist

This web service provides a list of all configurations for a schema (app, module and version combination).

Request

GET /configlist

This web service will expect appName, moduleName and versionNumber in the query string. All the fields are mandatory.

Example:

GET /configlist?app=FinanceApp&module=PaymentGateway&ver=2

Processing

Upon receiving a GET request to this endpoint, the Rigel service performs the following steps:

• Retrieve Configurations
  • Fetches all named configurations from the etcd store.
  • The keys are expected to be structured as /remiges/rigel/[AppName]/[ModuleName]/[VersionNumber]/[ConfigName]

Response

{
    "configurations": [
        {
            "app": "FinanceApp",
            "module": "PaymentGateway",
            "ver": 2,
            "config": "ProdConfig",
            "description": "Configuration for production environment of the PaymentGateway module in FinanceApp.",
        },
        {
            "app": "FinanceApp",
            "module": "PaymentGateway",
            "ver": 2,
            "config": "TestConfig",
            "description": "Configuration for test environment of the FinanceApp module in TestConfig.",
        },
    ]
}

Errors

• app_not_found: The specified application does not exist.
• module_not_found: The specified module does not exist within the application.
• ver_not_found: The specified version of the module does not exist.