| Requires the role: | superadmin |
| PUT | /widget/configurationschema/{Version}/migration | Set or replace the migration patch from the previous schema version | Sets MigrationFromPreviousVersion for the given Version. SuperAdmin only. Overwrites any existing value for this Version — unlike the schema document itself, this field is expected to be corrected after authoring, not immutable. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WidgetConfigurationSchemaResponse:
id: int = 0
version: int = 0
schema: Dict[str, Object] = field(default_factory=dict)
default_configuration: Optional[str] = None
migration_from_previous_version: Optional[str] = None
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="Returned if Version doesn't exist, Version-1 doesn't exist, Patch isn't a well-formed RFC 6902 document, references a path unknown to the previous version's schema, or (when the previous version has a DefaultConfiguration) doesn't produce a document that validates against this Version's Schema", StatusCode=400)
# @ApiResponse(Description="Returned if the current user is not a SuperAdmin", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SetWidgetConfigurationSchemaMigration:
# @ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")
version: int = 0
"""
The schema version this patch produces.
"""
# @ApiMember(Description="JSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string.", IsRequired=true)
patch: Optional[str] = None
"""
JSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string.
"""
Python SetWidgetConfigurationSchemaMigration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /widget/configurationschema/{Version}/migration HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Version: 0,
Patch: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Version: 0,
Schema:
{
String: {}
},
DefaultConfiguration: String,
MigrationFromPreviousVersion: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}