| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@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")
open class SetWidgetConfigurationSchemaMigration
{
/**
* The schema version this patch produces.
*/
@ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")
open var Version:Int? = null
/**
* JSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string.
*/
@ApiMember(Description="JSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string.", IsRequired=true)
open var Patch:String? = null
}
open class WidgetConfigurationSchemaResponse
{
open var Id:Int? = null
open var Version:Int? = null
open var Schema:HashMap<String,Object> = HashMap<String,Object>()
open var DefaultConfiguration:String? = null
open var MigrationFromPreviousVersion:String? = null
open var CreatedDate:Date? = null
open var ResponseStatus:ResponseStatus? = null
}
Kotlin SetWidgetConfigurationSchemaMigration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Version":0,"Patch":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}