BokaMera.API.Host

SetWidgetConfigurationSchemaMigration

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
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 Foundation
import ServiceStack

// @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")
public class SetWidgetConfigurationSchemaMigration : Codable
{
    /**
    * The schema version this patch produces.
    */
    // @ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")
    public var version:Int

    /**
    * 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)
    public var patch:String

    required public init(){}
}

public class WidgetConfigurationSchemaResponse : Codable
{
    public var id:Int
    public var version:Int
    public var schema:[String:String] = [:]
    public var defaultConfiguration:String
    public var migrationFromPreviousVersion:String
    public var createdDate:Date
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift SetWidgetConfigurationSchemaMigration DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + 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"}}}