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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class 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(Validator="IsAuthenticated")
    public static class SetWidgetConfigurationSchemaMigration
    {
        /**
        * The schema version this patch produces.
        */
        @ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")
        public Integer Version = 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)
        public String Patch = null;
        
        public Integer getVersion() { return Version; }
        public SetWidgetConfigurationSchemaMigration setVersion(Integer value) { this.Version = value; return this; }
        public String getPatch() { return Patch; }
        public SetWidgetConfigurationSchemaMigration setPatch(String value) { this.Patch = value; return this; }
    }

    public static class WidgetConfigurationSchemaResponse
    {
        public Integer Id = null;
        public Integer Version = null;
        public HashMap<String,Object> Schema = new HashMap<String,Object>();
        public String DefaultConfiguration = null;
        public String MigrationFromPreviousVersion = null;
        public Date CreatedDate = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public WidgetConfigurationSchemaResponse setId(Integer value) { this.Id = value; return this; }
        public Integer getVersion() { return Version; }
        public WidgetConfigurationSchemaResponse setVersion(Integer value) { this.Version = value; return this; }
        public HashMap<String,Object> getSchema() { return Schema; }
        public WidgetConfigurationSchemaResponse setSchema(HashMap<String,Object> value) { this.Schema = value; return this; }
        public String getDefaultConfiguration() { return DefaultConfiguration; }
        public WidgetConfigurationSchemaResponse setDefaultConfiguration(String value) { this.DefaultConfiguration = value; return this; }
        public String getMigrationFromPreviousVersion() { return MigrationFromPreviousVersion; }
        public WidgetConfigurationSchemaResponse setMigrationFromPreviousVersion(String value) { this.MigrationFromPreviousVersion = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public WidgetConfigurationSchemaResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public WidgetConfigurationSchemaResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java SetWidgetConfigurationSchemaMigration DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"Version":0,"Patch":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}