Documentation

Gets all the practices of a space

GET/public/practices/for-space/{spaceName}

Path parameters

spaceName*string

The name of the space you whish to query the practices from

Header parameters

Response

200401

Contains an array of all the practices for the space

Body

application/json

idstring

namestring

descriptionstring

linkstring

categoriesarray of string

Request

JavaScriptCurlPython

const response = await fetch('/public/practices/for-space/{spaceName}', {
    method: 'GET',
    headers: {
      "Packmind-api-key": "text"
    },
});
const data = await response.json();

Response

200401

[
  {
    "id": "text",
    "name": "text",
    "description": "text",
    "link": "text",
    "categories": [
      "text"
    ]
  }
]

Get best practices identified as negative patterns (Regex and Semgrep)

POST/api/plugin/ide/suggestion/regex/negative

Header parameters

Body

application/json

The content of the file, its name and extension

pathstring

Example: "SuggestionService.java,"

extensionstring

Example: ".java"

contentstring

Example: "import module;\nprivate const int = 4;\n"

Response

200401422

Contains an array of all the suggested best practices

Body

application/json

_idstring

Example: "622f638c4e73049622301106"

namestring

Example: "An example of best practice"

spaceobject

linesarray of number

Request

JavaScriptCurlPython

const response = await fetch('/api/plugin/ide/suggestion/regex/negative', {
    method: 'POST',
    headers: {
      "Packmind-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401422

[
  {
    "_id": "622f638c4e73049622301106",
    "name": "An example of best practice",
    "space": {
      "_id": "61fa9e160065d3192de01d52",
      "name": "Back-end space"
    },
    "lines": [
      0,
      4
    ]
  }
]

Get best practices identified as negative patterns (Regex and Semgrep) from a list of files

POST/api/plugin/cli/suggestion/batch/negative

Header parameters

Body

application/json

An array of files with its fileId, the content of the file, its name and extension

filesarray of object

Response

200401422

Contains an array of all the suggested best practices

Body

application/json

fileIdstring

Example: "src/main/java/SuggestionService.java"

dataobject

Request

JavaScriptCurlPython

const response = await fetch('/api/plugin/cli/suggestion/batch/negative', {
    method: 'POST',
    headers: {
      "Packmind-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401422

[
  {
    "fileId": "src/main/java/SuggestionService.java",
    "data": {
      "_id": "622f638c4e73049622301106",
      "name": "An example of best practice",
      "space": {
        "_id": "61fa9e160065d3192de01d52",
        "name": "Back-end space"
      },
      "lines": [
        0,
        4
      ]
    }
  }
]