Blazor Diffusion

<back to all web services

CreateGenerationApiProvider

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class IdResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $id=null,

        // @DataMember(Order=2)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template ICreateDb of GenerationApiProvider
 */
class CreateGenerationApiProvider implements ICreateDb, JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $name='',
        /** @var string */
        public string $apiKey='',
        /** @var string */
        public string $apiKeyHeader='',
        /** @var string */
        public string $apiBaseUrl='',
        /** @var string */
        public string $heartbeatUrl='',
        /** @var int */
        public int $concurrency=0,
        /** @var int */
        public int $priority=0,
        /** @var bool|null */
        public ?bool $enabled=null,
        /** @var DateTime|null */
        public ?DateTime $offlineDate=null,
        /** @var array<string>|null */
        public ?array $models=null,
        /** @var int|null */
        public ?int $generationApiTypeId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['name'])) $this->name = $o['name'];
        if (isset($o['apiKey'])) $this->apiKey = $o['apiKey'];
        if (isset($o['apiKeyHeader'])) $this->apiKeyHeader = $o['apiKeyHeader'];
        if (isset($o['apiBaseUrl'])) $this->apiBaseUrl = $o['apiBaseUrl'];
        if (isset($o['heartbeatUrl'])) $this->heartbeatUrl = $o['heartbeatUrl'];
        if (isset($o['concurrency'])) $this->concurrency = $o['concurrency'];
        if (isset($o['priority'])) $this->priority = $o['priority'];
        if (isset($o['enabled'])) $this->enabled = $o['enabled'];
        if (isset($o['offlineDate'])) $this->offlineDate = JsonConverters::from('DateTime', $o['offlineDate']);
        if (isset($o['models'])) $this->models = JsonConverters::fromArray('string', $o['models']);
        if (isset($o['generationApiTypeId'])) $this->generationApiTypeId = $o['generationApiTypeId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->name)) $o['name'] = $this->name;
        if (isset($this->apiKey)) $o['apiKey'] = $this->apiKey;
        if (isset($this->apiKeyHeader)) $o['apiKeyHeader'] = $this->apiKeyHeader;
        if (isset($this->apiBaseUrl)) $o['apiBaseUrl'] = $this->apiBaseUrl;
        if (isset($this->heartbeatUrl)) $o['heartbeatUrl'] = $this->heartbeatUrl;
        if (isset($this->concurrency)) $o['concurrency'] = $this->concurrency;
        if (isset($this->priority)) $o['priority'] = $this->priority;
        if (isset($this->enabled)) $o['enabled'] = $this->enabled;
        if (isset($this->offlineDate)) $o['offlineDate'] = JsonConverters::to('DateTime', $this->offlineDate);
        if (isset($this->models)) $o['models'] = JsonConverters::toArray('string', $this->models);
        if (isset($this->generationApiTypeId)) $o['generationApiTypeId'] = $this->generationApiTypeId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP CreateGenerationApiProvider 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.

POST /jsv/reply/CreateGenerationApiProvider HTTP/1.1 
Host: blazordiffusion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	name: String,
	apiKey: String,
	apiKeyHeader: String,
	apiBaseUrl: String,
	heartbeatUrl: String,
	concurrency: 0,
	priority: 0,
	enabled: False,
	offlineDate: 0001-01-01,
	models: 
	[
		String
	],
	generationApiTypeId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}