Suggestions

Context-aware suggestions for policy design and configuration.

Get next and nested suggested block types

post

Get next and nested suggested block types. Only users with the Standard Registry role are allowed to make the request.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

blockTypestringRequired

Responses

200

Successful operation. Suggested next and nested block types respectively.

application/json

nextstringRequired

nestedstringRequired

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/suggestions

POST /api/v1/suggestions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "blockType": "interfaceContainerBlock"
}

{
  "next": "string",
  "nested": "string"
}

Get suggestions config

get

Get suggestions config. Only users with the Standard Registry role are allowed to make the request.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful operation. Response suggestions config.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

get/suggestions/config

GET /api/v1/suggestions/config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": "string",
      "index": 0
    }
  ]
}

Set suggestions config

post

Set suggestions config. Only users with the Standard Registry role are allowed to make the request.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

201

Successful operation. Returns the updated suggestions config.

application/json

401

Unauthorized request.

application/json

403

Forbidden

application/json

500

Internal server error.

application/json

post/suggestions/config

POST /api/v1/suggestions/config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "items": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": "block",
      "index": 0
    }
  ]
}

{
  "items": [
    {
      "id": "69aeb71ef8c5b278e3bab4e5",
      "type": "string",
      "index": 0
    }
  ]
}