| Required role: | TenantReader |
| PATCH | /api/deployments/generation/name | Generate deployment name with the user defined part | |
|---|---|---|---|
| PATCH | /deployments/generation/name | Generate deployment name with the user defined part |
import 'package:servicestack/servicestack.dart';
enum Environments
{
Lab,
Poc,
Dev,
Test,
Int,
Uat,
Prod,
}
/**
* Generate deployment name with the user defined part
*/
// @Api(Description="Generate deployment name with the user defined part")
// @ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof(String), StatusCode=200)
class GenerateDeploymentName implements IBaseRequest, IHasTenantName, IPatch, IConvertible
{
// @ApiMember(DataType="string", IsRequired=true, ParameterType="header")
// @Validate(Validator="NotEmpty")
String tenantName = "";
/**
* User defined/custom part of the name
*/
// @ApiMember(DataType="string", Description="User defined/custom part of the name", IsRequired=true, ParameterType="body")
// @Validate(Validator="NotEmpty")
// @Validate(Validator="MaximumLength(100)")
// @Validate(Validator="RegularExpression(′^[0-9a-z]+[0-9a-z-]*[0-9a-z]+$′)")
String userDefinedPart = "";
/**
* What kind of environment is this deployment
*/
// @ApiMember(Description="What kind of environment is this deployment", IsRequired=true, ParameterType="body")
Environments environment;
GenerateDeploymentName({this.tenantName,this.userDefinedPart,this.environment});
GenerateDeploymentName.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
tenantName = json['tenantName'];
userDefinedPart = json['userDefinedPart'];
environment = JsonConverters.fromJson(json['environment'],'Environments',context!);
return this;
}
Map<String, dynamic> toJson() => {
'tenantName': tenantName,
'userDefinedPart': userDefinedPart,
'environment': JsonConverters.toJson(environment,'Environments',context!)
};
getTypeName() => "GenerateDeploymentName";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'duneframework.com', types: <String, TypeInfo> {
'Environments': TypeInfo(TypeOf.Enum, enumValues:Environments.values),
'GenerateDeploymentName': TypeInfo(TypeOf.Class, create:() => GenerateDeploymentName()),
});
Dart GenerateDeploymentName 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.
PATCH /api/deployments/generation/name HTTP/1.1
Host: core.starburst.svc
Accept: application/json
Content-Type: application/json
Content-Length: length
{"tenantName":"String","userDefinedPart":"String","environment":"Lab","txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length (string)