Schema Changes

post

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Responses

200Success

application/json

idstring · nullableOptionalDefault: null

codestringRequired

titlestringRequired

bodystring[]Required

durabilitystring · enum · nullableOptionalDefault: temporaryPossible values:

durationinteger · nullableOptionalDefault: 5000

kindstring · enum · nullableOptionalDefault: infoPossible values:

payloadanyOptionalDefault: null

actionobject · Action · nullableOptionalDefault: null

displaystring · enum · nullableOptionalDefault: notificationPossible values:

created_atstring · nullableOptionalDefault: null

post/api/v1/schema_changes/{engine_id}/apply/

POST /api/v1/schema_changes/{engine_id}/apply/ HTTP/1.1
Accept: */*

200Success

{
  "id": "text",
  "code": "text",
  "title": "text",
  "body": [
    "text"
  ],
  "durability": "temporary",
  "duration": 5000,
  "kind": "info",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "payload": null,
  "action": {},
  "display": "notification",
  "created_at": "text"
}

put

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Responses

200Success

application/json

idstring · nullableOptionalDefault: null

codestringRequired

titlestringRequired

bodystring[]Required

durabilitystring · enum · nullableOptionalDefault: temporaryPossible values:

durationinteger · nullableOptionalDefault: 5000

kindstring · enum · nullableOptionalDefault: infoPossible values:

payloadanyOptionalDefault: null

actionobject · Action · nullableOptionalDefault: null

displaystring · enum · nullableOptionalDefault: notificationPossible values:

created_atstring · nullableOptionalDefault: null

404Error

application/json

put/api/v1/schema_changes/{engine_id}/cancel/

PUT /api/v1/schema_changes/{engine_id}/cancel/ HTTP/1.1
Accept: */*

{
  "id": "text",
  "code": "text",
  "title": "text",
  "body": [
    "text"
  ],
  "durability": "temporary",
  "duration": 5000,
  "kind": "info",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "payload": null,
  "action": {},
  "display": "notification",
  "created_at": "text"
}

post

Schema changes

Authorizations

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

engine_idstringRequired

Query parameters

database_typestring · enumRequiredPossible values:

Responses

204

Success: Schema changes

No content

503

Message: unable to fetch engine from external service

post/api/v1/schema_changes/{engine_id}/sync/

POST /api/v1/schema_changes/{engine_id}/sync/?database_type=SOURCE HTTP/1.1
Accept: */*

No content