Module Management Interface Definition
Download OpenAPI specification:Download
Provides functions such as adding, modifying, and deleting modules
Query module list
Used to query the registered module information of supOS system
query Parameters
moduleCodes | Array of strings <= 10 items [ items <= 500 characters ] Example: moduleCodes=desktop,flow Multiple module codes are separated by ',', if not passed, a list of all modules will be returned by default |
header Parameters
Accept-Language | string <= 8 characters Example: zh-cn Internationalized language (depending on the language, the system code value returns content in different languages), the default is the server operating system language. English is en-us, Chinese is zh-cn. |
Responses
Response samples
- 200
- 500
[- {
- "moduleId": "auth",
- "moduleCode": "auth",
- "moduleName": "User Management"
}
]
Register, modify module module
Register the basic information of the module and the internationalization information data of the module.
Register the module by uploading the yaml file, which supports the configuration of internationalization information.
**Related parameters For the format requirements, please refer to the detailed description of the corresponding parameters in the YAML
file. **
Increase the version number, and judge whether to modify it according to the version number. The format of the version number adopts [SemVer 2](https://semver. org/) specification.
YAML file format is as follows:
Request Body schema: application/octet-stream
Responses
Response samples
- 400
- 500
{- "code": 100114002,
- "message": "Module already exists!"
}
Unregister Module
moduleCodes
Multiple module codes are separated by ',', system built-in modules are not allowed to be deleted
path Parameters
moduleCodes required | Array of strings <= 10 items [ items <= 500 characters ] Example: desktop,flow Multiple module codes are separated by ',' |
Responses
Response samples
- 400
- 500
{- "code": 100114004,
- "message": "The number of module inputs is too many, there should not be more than 10!"
}