| 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. |
|---|
// @ts-nocheck
export class WidgetConfigurationSchemaResponse
{
public Id: number;
public Version: number;
public Schema: { [index:string]: Object; } = {};
public DefaultConfiguration?: string;
public MigrationFromPreviousVersion?: string;
public CreatedDate: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<WidgetConfigurationSchemaResponse>) { (Object as any).assign(this, init); }
}
// @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")
export class SetWidgetConfigurationSchemaMigration
{
/** @description The schema version this patch produces. */
// @ApiMember(Description="The schema version this patch produces.", IsRequired=true, ParameterType="path")
public Version: number;
/** @description 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 Patch: string;
public constructor(init?: Partial<SetWidgetConfigurationSchemaMigration>) { (Object as any).assign(this, init); }
}
TypeScript SetWidgetConfigurationSchemaMigration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
Content-Type: application/json
Content-Length: length
{"Version":0,"Patch":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}