Inicia uma migração de schema

Inicia o processo de migração para uma nova versão de schema. O sistema será bloqueado para operações CUD durante a migração.

POST /api/v1/admin/migration/start

Inicia uma migração de schema

cURL

curl --request POST \
  --url https://services.pref.rio/app-busca-search/api/v1/admin/migration/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_version": "<string>",
  "async": true,
  "dry_run": true
}
'

200

{
  "backup_collection": "<string>",
  "completed_at": 123,
  "error_message": "<string>",
  "is_locked": true,
  "migrated_documents": 123,
  "progress": 123,
  "schema_version": "<string>",
  "source_collection": "<string>",
  "started_at": 123,
  "started_by": "<string>",
  "target_collection": "<string>",
  "total_documents": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Dados da migração

schema_version · string · required

async · boolean

Se true, executa em background (para API)

dry_run · boolean

Response

200

application/json

OK

backup_collection · string

completed_at · integer

error_message · string

is_locked · boolean

migrated_documents · integer

progress · number

schema_version · string

source_collection · string

started_at · integer

started_by · string

status · enum<string>

Available options: idle, in_progress, completed, failed, rollback

target_collection · string

total_documents · integer