JSON Schema and an example for each change kind.

GET 
/ai-builder-api/projects/:projectId/changes/schema

Static per server release: what change must look like for each kind POST /changes/plan accepts, as JSON Schema (draft 2020-12, input shape) with one valid example.

Request

Version stringrequired

The API version.

Available optionsv3

projectId stringrequired

The project's id.

Possible values: Value must match regular expression ^prj_[A-Za-z0-9_-]+$

kind string

One kind; absent returns every supported kind.

Possible values: Value must match regular expression ^[a-z][a-z_]{0,39}$

application/json

The schemas.

application/json

Schema

Schema

kindsobject[]required

Every kind of change this project accepts, each with its schema.

Example (auto)

{
  "kinds": [
    {
      "kind": "modules",
      "description": "Turn portal modules on or off.",
      "schema": {
        "type": "object"
      },
      "example": {
        "disable": [
          "communities"
        ]
      }
    }
  ]
}