Sites

Preview what deploying would change about the schema

The difference between the development database and the live one, described before it is applied — the statements, what they mean in plain language, and whether anything would be lost. Nothing runs. Show this to the user before deploying: a schema change that only becomes visible once it has happened is one nobody gets to object to.

get/sites/{id}/db/schema/plan

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/sites/{id}/db/schema/plan
  • Auth: API key in header Authorization

Path parameters

idstring required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

Planned schema change

objectstring
up_to_dateboolean

The live database already matches; deploying would change nothing.

summarystring[]

What the change means, in language a non-technical merchant can act on.

statementsstring[]

The DDL that would run.

notesstring[]

Anything that would be removed or rebuilt.

destructiveboolean
sqlstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.