Documentation
get
/public/practices/for-space/{spaceName}
Gets all the practices of a space
Parameters
Path
spaceName*
string
The name of the space you whish to query the practices from
Header
promyze-api-key*
string
Your promyze API key
Responses
200: OK
Contains an array of all the practices for the space
401: Unauthorized
You are not authorized to access this resource. Check your api key, more so if you are in mutliple organisations. You'll have one api key per organisation.
post
/api/plugin/ide/suggestion/regex/negative
Get best practices identified as negative patterns (Regex and Semgrep)
Parameters
Header
promyze-api-key*
string
Your promyze API key
Body
Example
Schema
{
"path": "SuggestionService.java,",
"extension": ".java",
"content": "import module;\nprivate const int = 4;\n"
}
Responses
200: OK
Contains an array of all the suggested best practices
401: Unauthorized
You are not authorised to access this resource. Check your api key, more so if you are in mutliple organisations. You'll have one api key per organisation.
422: Unprocessable Entity
File path or extension are missing
post
/api/plugin/cli/suggestion/batch/negative
Get best practices identified as negative patterns (Regex and Semgrep) from a list of files
Parameters
Header
promyze-api-key*
string
Your promyze API key
Body
Example
Schema
{
"files": [
{
"fileId": "src/main/java/SuggestionService.java",
"data": {
"path": "SuggestionService.java,",
"extension": ".java",
"content": "import module;\nprivate const int = 4;\n"
}
}
]
}
Responses
200: OK
Contains an array of all the suggested best practices
401: Unauthorized
You are not authorized to access this resource. Check your api key, more so if you are in mutliple organisations. You'll have one api key per organisation.
422: Unprocessable Entity
File path or extension are missing
Last modified 3mo ago