Repository navigation
v0.11.0
PidginHost PHP SDK v0.11.0
Install from Packagist:
composer require pidginhost/sdk:0.11.0
Versions v0.8.0 through v0.10.2 shipped without entries in this file. The
Go changelog
records those schema changes; they apply to this SDK too.
Changed (breaking)
-
AttachIPv4→AttachIPv4Request,AttachIPv6→AttachIPv6Request. The server attach routes now have distinct request and response components, so the generated request types are renamed. -
POST /api/cloud/servers/{id}/detach-ipv4/returnsServerDetachIPv4Responseinstead ofDetachIPv4Response. Thedetachedfield is unchanged.DetachIPv4Responsestill serves the standalonePOST /api/cloud/ipv4/{id}/detach/route. -
Six enum components renamed off content-derived names. Where several serializers expose a field called
status,typeorpriorityover different choice sets, drf-spectacular was naming the component by hashing its values, so adding a single choice silently renamed the type. These are now pinned:Was Now Priority3cdEnumTicketPriorityEnumStatus03cEnumInvoiceStatusEnumStatus63aEnumServiceStatusEnumStatusA57EnumResourceStatusEnumStatusEf2EnumTicketStatusEnumType85bEnumClusterTypeEnumA one-time rename: the names no longer move when a choice set gains a value.
ClusterType.typehad already been renamed once this way (Type2faEnum→Type85bEnumwhenbetawas added) and now shares the pre-existingClusterTypeEnum, which carried the identicaldev/prod/betaset under a second name.
Added
rebootonAttachIPv4RequestandAttachIPv6Request(boolean, defaultfalse). A public address is written to the machine config and the guest OS only reads it while booting, so on a running server the address is inert until a restart. Setrebootto have the API issue that restart.reboot_requiredandrebootedonAttachIPv4ResponseandAttachIPv6Response.attachedalone could describe a server that answers neither ping nor SSH on the new address; these say whether a restart is still owed and whether one was performed. A stopped server reports bothfalseand is never booted just to pick the address up, andreboot: trueon a rescue-mode or transitioning server keepsreboot_required: truerather than rebooting out of the rescue ISO.AttachIPv6Responseis new.POST /api/cloud/servers/{id}/attach-ipv6/previously echoed the request body back, so there was noattachedflag to check.- Rescue mode:
POST /api/cloud/servers/{id}/rescue/enter/and.../rescue/exit/, typed asRescueEnterQueued/RescueExitQueued. - Boot ISOs:
GET /api/cloud/servers/{id}/boot-isos/withBootISO,PaginatedBootISOList, andIsoBootRequest. - Glue / personal-DNS records:
/api/domain/domain/{domain}/dns/and/api/domain/domain/{domain}/dns/{name}/, typed asDNSGlueandPaginatedDNSGlueList. TicketMessage,ServiceCompany,DestroyProtectionResponse, andCategoryEnum.
Fixed
attach-ipv4reports a missing field as a missing field. Omittingipv4returnedObject with address=None does not exist, which reads as a bad address rather than a bad field name; it is now400 {"ipv4": ["This field is required."]}.attach-ipv6rejects a conflicting address with a400instead of200plus a message, so a failed attach no longer looks like a success. Re-attaching the address a server already has is idempotent.
Notes
In this SDK, model class names match the component names; accessors follow (getRebootRequired()).