Documentation

Gets all the practices of a space

get

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

Path parameters

spaceNamestringrequired

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

Header parameters

Packmind-api-keystringrequired

Your Packmind API key

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/public/practices/for-space/{spaceName}' \
  --header 'Packmind-api-key: text'

200

401

200

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

Contains an array of all the practices for the space

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

post

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

Header parameters

Packmind-api-keystringrequired

Your Packmind API key

Body

pathstring

Example: SuggestionService.java,

extensionstring

Example: .java

contentstring

Example: import module; private const int = 4;

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/plugin/ide/suggestion/regex/negative' \
  --header 'Packmind-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"path":"SuggestionService.java,","extension":".java","content":"import module;\nprivate const int = 4;\n"}'

200

401

422

200

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

Contains an array of all the suggested best practices

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

post

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

Header parameters

Packmind-api-keystringrequired

Your Packmind API key

Body

filesobject[]

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/plugin/cli/suggestion/batch/negative' \
  --header 'Packmind-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"files":[{"fileId":"src/main/java/SuggestionService.java","data":{"path":"SuggestionService.java,","extension":".java","content":"import module;\nprivate const int = 4;\n"}}]}'

200

401

422

200

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

Contains an array of all the suggested best practices