Jira | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Open Issues
Issue | Decision | |
---|---|---|
1 | Should the response be a string or described using a schema? | yes, we will describe the request and response using a schema |
2 | What approach is best for getting the data from the DB?
| I propose to use option 1 to improve performance and readability. We no longer need to make a decision on this as we do not need revision (see no.3) |
3 | Is revision necessary for this use case? | No, we agreed moduleName is only needed for now. |
API details
Description | URI | Sample Request Body | Sample Response Body |
---|---|---|---|
Get all cm handles that support all modules in a given list of modules | POST {ncmpRoot}/ncmp/v1/ch/searches | { }, { } ] | { { |
Implementation details
- The above API will be implemented in NCMP open API
- moduleName is mandatory
- revision is optional
The request body will be described using the schema below
Code Block language yml Conditions: type: object properties: conditions: type: object properties: hasAllModules: type: array items: type: object properties: moduleName: type: string required: true revision: type: string
The response body will return the JSON example above as a string