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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [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("IsAuthenticated")]
    public partial class SetWidgetConfigurationSchemaMigration
    {
        ///<summary>
        ///The schema version this patch produces.
        ///</summary>
        [ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")]
        public virtual int Version { get; set; }

        ///<summary>
        ///JSON Patch (RFC 6902) document transforming a Version-1 shaped Configuration into a Version-shaped one, as a JSON string.
        ///</summary>
        [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 virtual string Patch { get; set; }
    }

    public partial class WidgetConfigurationSchemaResponse
    {
        public virtual int Id { get; set; }
        public virtual int Version { get; set; }
        public virtual Dictionary<string, Object> Schema { get; set; } = new();
        public virtual string? DefaultConfiguration { get; set; }
        public virtual string? MigrationFromPreviousVersion { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}