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 'package:servicestack/servicestack.dart';

class WidgetConfigurationSchemaResponse implements IConvertible
{
    int Id = 0;
    int Version = 0;
    Map<String,dynamic?> Schema = {};
    String? DefaultConfiguration;
    String? MigrationFromPreviousVersion;
    DateTime CreatedDate = DateTime(0);
    ResponseStatus ResponseStatus;

    WidgetConfigurationSchemaResponse({this.Id,this.Version,this.Schema,this.DefaultConfiguration,this.MigrationFromPreviousVersion,this.CreatedDate,this.ResponseStatus});
    WidgetConfigurationSchemaResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Version = json['Version'];
        Schema = JsonConverters.fromJson(json['Schema'],'Map<String,dynamic?>',context!);
        DefaultConfiguration = json['DefaultConfiguration'];
        MigrationFromPreviousVersion = json['MigrationFromPreviousVersion'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Version': Version,
        'Schema': JsonConverters.toJson(Schema,'Map<String,dynamic?>',context!),
        'DefaultConfiguration': DefaultConfiguration,
        'MigrationFromPreviousVersion': MigrationFromPreviousVersion,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "WidgetConfigurationSchemaResponse";
    TypeContext? context = _ctx;
}

// @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")
class SetWidgetConfigurationSchemaMigration implements IConvertible
{
    /**
    * The schema version this patch produces.
    */
    // @ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")
    int Version = 0;

    /**
    * 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)
    String Patch = "";

    SetWidgetConfigurationSchemaMigration({this.Version,this.Patch});
    SetWidgetConfigurationSchemaMigration.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Version = json['Version'];
        Patch = json['Patch'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Version': Version,
        'Patch': Patch
    };

    getTypeName() => "SetWidgetConfigurationSchemaMigration";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'WidgetConfigurationSchemaResponse': TypeInfo(TypeOf.Class, create:() => WidgetConfigurationSchemaResponse()),
    'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
    'SetWidgetConfigurationSchemaMigration': TypeInfo(TypeOf.Class, create:() => SetWidgetConfigurationSchemaMigration()),
});

Dart SetWidgetConfigurationSchemaMigration DTOs

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

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