github.com/akamai/AkamaiOPEN-edgegrid-golang/v5@v5.0.0/CHANGELOG.md (about) 1 # EDGEGRID GOLANG RELEASE NOTES 2 3 ## 5.0.0 (March 28, 2023) 4 5 ### FEATURES/ENHANCEMENTS: 6 7 * APPSEC 8 * Add `AdvancedSettingsRequestBody` interface to support configuring request size inspection limit 9 10 * EDGEKV 11 * [ListGroupsWithinNamespace](https://techdocs.akamai.com/edgekv/reference/get-groups) 12 13 * Image and Video Manager 14 * Add possible value `avif` for `forcedFormats` and `allowedFormats` 15 16 * PAPI 17 * Add `complianceRecord` field to `Activation` struct for PAPI activation 18 19 #### BREAKING CHANGES: 20 21 * APPSEC 22 * Remove deprecated `EvalHost` and `EvalProtectHost` interfaces. (Use the `WAPSelectedHostnames` interface instead.) 23 * Remove deprecated `BypassNetworkList` interface. (Use the `WAPBypassNetworkList` interface instead.) 24 25 ## 4.1.0 (Feb 27, 2023) 26 27 ### FEATURES/ENHANCEMENTS: 28 29 * APPSEC 30 * Added following BotManager fields to GetExportConfigurationResponse 31 * BotManagement 32 * CustomBotCategories 33 * CustomDefinedBots 34 * CustomBotCategorySequence 35 * CustomClients 36 * ResponseActions 37 * AdvancedSettings 38 * Added AdvancedSettingsAttackPayloadLogging interface 39 40 #### BUG FIXES: 41 42 * Fix V4 of Edgegrid doesn't parse hostname ([#182](https://github.com/akamai/AkamaiOPEN-edgegrid-golang/pull/182)) 43 44 ## 4.0.0 (Jan 31, 2023) 45 46 #### BREAKING CHANGES: 47 48 * Migrate to go 1.18 49 50 * PAPI 51 * Fix response structures for GetAvailableBehaviors and GetAvailableCriteria: 52 * [GetAvailableCriteria](https://techdocs.akamai.com/property-mgr/reference/get-available-criteria) 53 * [GetAvailableBehaviors](https://techdocs.akamai.com/property-mgr/reference/get-available-behaviors) 54 55 * CPS 56 * Update `Accept` header to the latest schema `application/vnd.akamai.cps.enrollment.v11+json` for the following endpoints: 57 * [ListEnrollments](https://techdocs.akamai.com/cps/reference/get-enrollments) 58 * [GetEnrollment](https://techdocs.akamai.com/cps/reference/get-enrollment) 59 60 * APPSEC 61 * Fix incorrect return type structure in `UpdateBypassNetworkListsResponse` 62 * Return `RatePolicyCondition` via a pointer in response structs of `RatePolicy` APIs 63 64 #### FEATURES/ENHANCEMENTS: 65 66 * Replace obsolete APIs documentation links with new one from [https://techdocs.akamai.com](https://techdocs.akamai.com) 67 68 * APPSEC 69 * Add `burstWindow` and `condition` fields to RatePolicy 70 71 * CPS 72 * Add `preferredTrustChain` field to `csr` struct ([#351](https://github.com/akamai/terraform-provider-akamai/issues/351)) 73 * Set `utf-8 charset` in `content-type` header for requests 74 75 #### BUG FIXES: 76 77 * Fix code errors in documentation examples ([#177](https://github.com/akamai/AkamaiOPEN-edgegrid-golang/pull/177)) 78 79 * IAM 80 * Issue updating user information - removed validation on user update 81 82 ## 3.1.0 (Dec 12, 2022) 83 84 #### FEATURES/ENHANCEMENTS: 85 86 * General 87 * Add badges to readme and improve code quality 88 89 * [IMPORTANT] Added Property Include API support 90 * Includes 91 * [ListIncludes](https://techdocs.akamai.com/property-mgr/reference/get-includes) 92 * [ListIncludeParents](https://techdocs.akamai.com/property-mgr/reference/get-include-parents) 93 * [GetInclude](https://techdocs.akamai.com/property-mgr/reference/get-include) 94 * [CreateInclude](https://techdocs.akamai.com/property-mgr/reference/post-includes) 95 * [DeleteInclude](https://techdocs.akamai.com/property-mgr/reference/delete-include) 96 * Include Activations 97 * [ActivateInclude](https://techdocs.akamai.com/property-mgr/reference/post-include-activation) 98 * [DeactivateInclude](https://techdocs.akamai.com/property-mgr/reference/post-include-activation) 99 * [CancelIncludeActivation](https://techdocs.akamai.com/property-mgr/reference/delete-include-activation) 100 * [GetIncludeActivation](https://techdocs.akamai.com/property-mgr/reference/get-include-activation) 101 * [ListIncludeActivations](https://techdocs.akamai.com/property-mgr/reference/get-include-activations) 102 * Include Rules 103 * [GetIncludeRuleTree](https://techdocs.akamai.com/property-mgr/reference/get-include-version-rules) 104 * [UpdateIncludeRuleTree](https://techdocs.akamai.com/property-mgr/reference/patch-include-version-rules) 105 * Include Versions 106 * [CreateIncludeVersion](https://techdocs.akamai.com/property-mgr/reference/post-include-versions) 107 * [GetIncludeVersion](https://techdocs.akamai.com/property-mgr/reference/get-include-version) 108 * [ListIncludeVersions](https://techdocs.akamai.com/property-mgr/reference/get-include-versions) 109 * [ListIncludeVersionAvailableCriteria](https://techdocs.akamai.com/property-mgr/reference/get-include-available-criteria) 110 * [ListIncludeVersionAvailableBehaviors](https://techdocs.akamai.com/property-mgr/reference/get-include-available-behaviors) 111 112 #### BREAKING CHANGES: 113 114 * APPSEC 115 * Factor out `PolicySecurityControls` struct 116 117 ## 3.0.0 (November 28, 2022) 118 119 ### Deprecations 120 121 * CPS 122 * UpdateChange() function has been deprecated 123 124 #### FEATURES/ENHANCEMENTS: 125 126 * CPS 127 * ChangeManagementInfo - get or acknowledge change management info, get change deployment info 128 * Deployments - list deployments, get production deployment, get staging deployment 129 * DeploymentSchedules - get deployment schedule, update deployment schedule 130 * History - get DV history, get certificate history, get change history 131 * PostVerification - get or acknowledge post verification warnings 132 * ThirdPartyCSR - get third-party CSR, upload certificate 133 134 #### BREAKING CHANGES: 135 136 * Rename package `configdns` to `dns` 137 * Rename package `configgtm` to `gtm` 138 * CPS 139 * Renamed structs: Challenges and ValidationRecords to Challenge and ValidationRecord accordingly 140 * Type change: `NotAfter` and `NotBefore` fields in `DeploymentSchedule` struct used in response for `GetChangeStatus` are `*string` instead of `string` 141 142 ## 2.17.0 (October 24, 2022) 143 144 #### FEATURES/ENHANCEMENTS: 145 146 * Datastream 147 * Add ListStreams 148 * Add new connectors: Elasticsearch, NewRelic and Loggly 149 * Extend Splunk and Custom HTTPS connectors mTLS certificates configuration 150 * Extend SumoLogic, Splunk and Custom HTTPS connectors with ability to specify custom HTTP headers 151 152 #### BUG FIXES: 153 154 * APPSEC 155 * Fix incorrect JSON sent when applying appsec_ip_geo resource in allow mode 156 157 ## 2.16.0 (September 26, 2022) 158 159 #### FEATURES/ENHANCEMENTS: 160 161 * APPSEC 162 * Add interfaces to support file malware scanning (FMS): 163 * MalwareContentTypes 164 * MalwarePolicy 165 * MalwarePolicyAction 166 * MalwareProtection 167 * Add GetRuleRecommendations method to TuningRecommendations interface 168 * Add deprecation notes for the following: 169 * methods: 170 * GetIPGeoProtections 171 * GetNetworkLayerProtections 172 * GetRateProtections 173 * GetReputationProtections 174 * GetSlowPostProtectionSetting 175 * GetSlowPostProtections 176 * GetWAFProtections 177 * RemoveNetworkLayerProtection 178 * RemovePolicyProtections 179 * RemoveReputationProtection 180 * structs: 181 * GetIPGeoProtectionsRequest 182 * GetNetworkLayerProtectionsRequest 183 * GetRateProtectionsRequest 184 * GetReputationProtectionsRequest 185 * GetSlowPostProtectionSettingRequest 186 * GetSlowPostProtectionSettingResponse 187 * GetSlowPostProtectionsRequest 188 * GetWAFProtectionsRequest 189 * RemoveNetworkLayerProtectionRequest 190 * RemovePolicyProtectionsRequest 191 * RemoveReputationProtectionRequest 192 193 * [IMPORTANT] Added Bot Management API Support 194 * Akamai Bot Category - read 195 * Akamai Bot Category Action - read, update 196 * Akamai Defined Bot - read 197 * Bot Analytics Cookie - read, update 198 * Bot Analytics Cookie Values - read 199 * Bot Category Exception - read, update 200 * Bot Detection - read 201 * Bot Detection Action - read, update 202 * Bot Endpoint Coverage Report - read 203 * Bot Management Setting - read, update 204 * Challenge Action - create, read, update, delete 205 * Challenge Interception Rules - read, update 206 * Client Side Security - read, update 207 * Conditional Action - create, read, update, delete 208 * Custom Bot Category - create, read, update, delete 209 * Custom Bot Category Action - read, update 210 * Custom Bot Category Sequence - read, update 211 * Custom Client - create, read, update, delete 212 * Custom Defined Bot - create, read, update, delete 213 * Custom Deny Action - create, read, update, delete 214 * Javascript Injection - read, update 215 * Recategorized Akamai Defined Bot - create, read, update, delete 216 * Response Action - read 217 * Serve Alternate Action - create, read, update, delete 218 * Transactional Endpoint - create, read, update, delete 219 * Transactional Endpoint Protection - read, update 220 221 ## 2.15.0 (August 22, 2022) 222 223 #### FEATURES/ENHANCEMENTS: 224 225 * APPSEC 226 * Add xff field to custom rule conditions 227 * Add NotificationEmails to Activation struct 228 229 * GTM 230 * Improved error messages 231 232 * CPS 233 * Add cps ListEnrollments 234 * Extend CreateEnrollment with AllowDuplicateCN option 235 236 ## 2.14.1 (July 26, 2022) 237 238 #### BUG FIXES: 239 240 * IAM 241 * Change IAM GroupID type to int64 242 243 ## 2.14.0 (June 28, 2022) 244 245 #### FEATURES/ENHANCEMENTS: 246 247 * APPSEC 248 * Added penalty box support for security policy in evaluation mode 249 250 * HAPI 251 * EdgeHostname - update 252 253 * IAM 254 * Blocked properties - read, update 255 * Group - create, read, update, delete 256 * Role - create, read, update, delete 257 * User - lock, unlock, TFA, set password, reset password 258 259 #### BUG FIXES: 260 * APPSEC 261 * Fixed incorrect error message on activation failure 262 * The `EffectiveTimePeriod`, `SamplingRate`, `LoggingOptions`, and `Operation` fields of the various `CustomRule` response structs are now marshalled correctly 263 264 ## 2.13.0 (May 31, 2022) 265 266 #### FEATURES/ENHANCEMENTS: 267 268 * Image and Video Manager 269 * Add new `ImQuery` transformation 270 * New `PostBreakPointTransformationType` 271 272 #### BUG FIXES: 273 274 * Image and Video Manager 275 * `default_value` field on variable in image policy should not be required 276 * Change all primitive optional parameters to pointers 277 * Correct `Anchor` field in `RectangleShapeType` 278 * Value field for `NumberVariableInline` should be defined as `float64` 279 * Rename `PointShapeType.True` to `PointShapeType.Y`, to match the OpenAPI definition 280 * Add `Composite` transformation to `PostBreakpointTransformations` 281 * Fix `PostBreakpointTransformations.PolicyInputImage` 282 283 ## 2.12.0 (Apr. 25, 2022) 284 285 #### FEATURES/ENHANCEMENTS: 286 287 * APPSEC 288 * Add WAPBypassNetworkLists interface, to be used in preference to deprecated BypassNetworkLists interface 289 290 * Support for account switch keys from environment ([#149](https://github.com/akamai/AkamaiOPEN-edgegrid-golang/pull/149)) 291 292 ## 2.11.0 (March 24, 2022) 293 294 #### FEATURES/ENHANCEMENTS: 295 296 * [IMPORTANT] Added Image and Video Manager API support 297 * Policy Set - create, read, update, delete 298 * Policy - create, read, update, delete, rollback to previous version, view policy history 299 300 * CLOUDLETS 301 * Support for RC cloudlet type (Request Control) 302 303 * PAPI 304 * CP code - read, update 305 306 ## 2.10.0 (Feb. 28, 2022) 307 308 #### FEATURES/ENHANCEMENTS: 309 310 * [IMPORTANT] Added EdgeWorkers and EdgeKV API support 311 * EDGEWORKERS 312 * Ids - create, read, update, delete, clone 313 * Versions - create, read, delete, validate version bundle 314 * Activations - create, read, delete 315 * Deactivations - read, delete 316 * Resource tiers - read 317 * Reports - read 318 * Secure token - create 319 * Permission groups - read 320 * Properties - read 321 * Contracts - read 322 * EDGEKV 323 * Items - create, read, update, delete 324 * Namespaces - create, read, update 325 * Initialization - create, read 326 * Access token - create, read, delete 327 328 * APPSEC 329 * Source for evasive path match interface updated with links to documentation 330 331 * CLOUDLETS 332 * Support for AS cloudlet type (Audience Segmentation) 333 334 ## 2.9.1 (Feb. 7, 2022) 335 336 #### FEATURES/ENHANCEMENTS: 337 338 * APPSEC 339 * Remove deprecation notes for individual policy protection methods 340 341 #### BUG FIXES: 342 343 * CLOUDLETS 344 * Fixed validation for ALB version DataCenter percent 345 346 ## 2.9.0 (Jan. 24, 2022) 347 348 #### FEATURES/ENHANCEMENTS: 349 350 * CLOUDLETS 351 * Support for VP cloudlet type (Visitor Prioritization) 352 * Support for CD cloudlet type (Continuous Deployment / Phased Release) 353 * Support for FR cloudlet type (Forward Rewrite) 354 * Support for AP cloudlet type (API Prioritization) 355 356 * APPSEC 357 * Add support for Evasive Path Match feature 358 * Deprecate individual policy protection interface methods 359 360 * NETWORK LISTS 361 * Include ContractID and GroupID in GetNetworkListResponse 362 363 ## 2.8.1 (Nov. 30, 2021) 364 365 #### FEATURES/ENHANCEMENTS: 366 * [IMPORTANT] Added Cloudlets API support 367 * Policy (Application Load Balancer) - create, read, update, delete policy 368 * Policy (Edge Redirector) - create, read, update, delete policy 369 * Policy activation - create, read 370 * Application Load Balancer configuration - create, update, read 371 * Activation for Application Load Balancer configuration - create, read 372 373 * APPSEC 374 * Add support for advanced exceptions in ASE rules 375 * Update bypass-network-list datasource and resource for multi-policy WAP 376 377 ## 2.7.0 (Oct 19, 2021) 378 379 #### FEATURES/ENHANCEMENTS: 380 * [IMPORTANT] Added DataStream API support 381 * Stream operations 382 * Stream activation operations 383 * Read access to various DataStream properties 384 * Added HAPI v1 support 385 * Delete edge hostname 386 387 ## 2.6.0 (Aug 16, 2021) 388 389 #### BUG FIXES: 390 * APPSEC 391 * Fix incorrect comments/URL references in inline documentation 392 393 #### FEATURES/ENHANCEMENTS 394 * APPSEC 395 * Get an evaluation attack group's or risk score group's action 396 397 * NETWORK LISTS 398 * Support contract_id and group_id for network list create/update 399 400 ## 2.5.0 (Jun 15, 2021) 401 402 #### BREAKING CHANGES: 403 * APPSEC 404 * The following have been removed, togther with their unit tests and test data: 405 * pkg/appsec/attack_group_action.go 406 * pkg/appsec/attack_group_condition_exception.go 407 * pkg/appsec/eval_rule_action.go 408 * pkg/appsec/eval_rule_condition_exception.go 409 * pkg/appsec/rule_action.go 410 * pkg/appsec/rule_condition_exception.go 411 412 #### BUG FIXES: 413 * DNSv2 414 * Fixed parsing SVCB, HTTPS rdata. 415 416 #### FEATURES/ENHANCEMENTS: 417 * [IMPORTANT] CPS - Added Certificate Provisioning API support 418 * Enrollments - create, read, update, delete enrollments 419 * Change status API - get change status, cancel change 420 * DV certificate API - get and acknowledge DV challenges 421 * Pre verification warnings - get and acknowledge pre verification warnings 422 423 * APPSEC 424 * The following have been added, together with their unit tests and test data: 425 * pkg/appsec/api_constraints_protection.go 426 * pkg/appsec/advanced_settings_pragma_header.go 427 * pkg/appsec/attack_group.go 428 * pkg/appsec/eval_rule.go 429 * pkg/appsec/rule.go 430 * pkg/appsec/ip_geo_protection.go 431 432 ## 2.4.1 (Apr 19, 2021) 433 434 #### BUG FIXES: 435 436 * APPSEC 437 * Suppress 'null' text on output of empty/false values 438 * Prevent configuration drift when reapplying configuration after importing or creating resources 439 440 ## 2.4.0 (Mar 29, 2021) PAPI - Secure by default 441 442 * PAPI 443 * Support to provision default certs as part of hostnames request 444 * New cert status object in hostnames response if it exists 445 446 ## 2.3.0 (Mar 15, 2021) Network Lists 447 448 Add support for the following operations in the Network Lists API v2: 449 450 * Create a network list 451 * Update an existing network list 452 * Get the existing network lists, including optional filtering by name or type 453 * Subscribe to a network list 454 * Activate a network list 455 456 ## 2.2.1 (Mar 3, 2021) 457 * PAPI - Fixed issue with rules causing advanced locked behaviors to fail 458 459 ## 2.2.0 (Feb 23, 2021) APPSEC - Extended list of supported list endpoints from APPSEC API 460 461 #### BUG FIXES: 462 * PAPI 463 * Fixed issue with version and rule comments being dropped 464 * Fixed client side validation to allow certain PAPI errors to passthrough 465 466 #### FEATURES/ENHANCEMENTS: 467 * APPSEC 468 * Custom Deny 469 * SIEM Setting 470 * Advanced Options Settings 471 * API Match Target 472 * API Request Constraint 473 * Create/Delete/Rename Security Policy 474 * Host Coverage / Edit Version Notes 475 * All WAP Features / WAP Hostname Evaluation 476 * Create Security Configuration 477 * Rename Security Configuration Version 478 * Delete Security Configuration Version 479 * Clone Security Configuration 480 * Import tool for adding existing resources to Terraform state 481 * DNS 482 * Add support for HTTPS, SVCB records to ParseRData 483 484 ## 2.1.1 (Feb 3, 2021) 485 * PAPI - Fixed validation on empty rule behaviors causing some properties with nested behaviors to fail 486 487 ## 2.1.0 (Jan 13, 2021) 488 * [IMPORTANT] IAM - New Identity and Access Management API Support 489 490 ## 2.0.4 (Dec 23, 2020) 491 * APPSEC - Extended list of supported endpoints from APPSEC API: 492 * DDoS Protection -- Rate Policy & Action 493 * DDoS Protection -- Slowpost setting & Action 494 * Application Layer Protection -- Rule Action, Exceptions & Conditions 495 * Application Layer Protection -- Rule Evaluation Action, Exceptions & Conditions 496 * Application Layer Protection -- Attack Group Action, Exceptions & Conditions 497 * Application Layer Protection -- Rule Upgrade & Change Mode for Rule Eval 498 * Reputation Profile & Action 499 * Network Layer Control -- IP & GEO setting 500 501 ## 2.0.3 (Dec 7, 2020) 502 * PAPI - Property hostname validation fix for missing hostnames. 503 * PAPI - fix minor typo in rules error messages 504 505 ## 2.0.2 (Nov 19, 2020) 506 * [IMPORTANT] APPSEC - Added Application Security API 507 * [ENHANCEMENT] DNS - Bulk Api endpoints added 508 * ALL - Re-enabled global account switch key support in edgerc files 509 * PAPI - Edgehostname IPV6 support fix. Added enums with allowed values. 510 * PAPI - Edgehostname blank cname or egdehostname id fix 511 * PAPI - propertyversion blank etag field fix 512 513 ## 2.0.1 (Oct 15, 2020) 514 * [IMPORTANT] Breaking changes from earlier clients. Project updated to use v2 directory structure. 515 * [ENHANCEMENT] PAPI - Api error return to the user when an activation or validation error occurs. 516 * [NOTE] Project re-organized to prepare for additional APIs to be included in future versions of this library. 517 518 ## 1.0.0 (Oct 15, 2020) 519 * Official release for the EdgeGrid Golang library 520 * DNSv2 - Zone create signature to pass blank instead of nil 521 * PAPI - Return nil instead of error if no cp code was found 522 * GTM - Datacenter API requires blank instead of nil 523 524 ## 0.9.18 (Jul 13, 2020) 525 * [AT-40][Add] Preliminary Logging CorrelationID 526 527 ## 0.9.17 (Jun 9, 2020) 528 * Corrected AKAMAICDN target parsing 529 * Added endpoints for list zones, creating and updating multiple recordsets 530 * Refactored recordsets into separate source file 531 532 ## 0.9.16 (May 29, 2020) 533 * Client-v1, Papi-v1 Updates 534 * Add lock around http request creation. 535 * papi - add logging to papi endpoints. 536 537 ## 0.9.15 (May 15, 2020) 538 * DNSv2 - Added CERT, TSLA Record parsing. Removed MX Record parsing 539 540 ## 0.9.14 (May 12, 2020) 541 * DNSv2 - Enhance RecordError functions 542 543 ## 0.9.13 (Apr 26, 2020) 544 * DNSv2 - filterZoneCreate check upper case Type 545 546 ## 0.9.12 (Apr 21, 2020) 547 * DNSv2 - Added optional arg to bypass dns record lock for create, update and delete functions. default preserves prior behavior 548 549 ## 0.9.11 (Apr 13 , 2020) 550 * DNSv2 Updates 551 * Add additional fields, including TSIG, to zone 552 * Support alias zone types 553 * Add utility functions for Rdata parsing and process. 554 * Add GetRecord, GetRecordSet functions 555 * Add additional Recordset metadata 556 * Add http request/response logging 557 558 ## 0.9.10 (Mar 5, 2020) 559 * Add support for caching Edgehostnames and Products 560 * Support for cache in papi library for edgehostnames and products to minimize round trips to fetch repeated common data to avoid 561 WAF deny rule IPBLOCK-BURST4-54013 issue 562 563 ## 0.9.9 (Feb 29, 2020) 564 * Add support for caching Contract, Groups, and Cp Codes 565 * cache to minimize round trips on repeated common data fetches to avoid 566 WAF deny rule IPBLOCK-BURST4-54013 issue 567 568 ## 0.9.0 (Aug 6, 2019) 569 * Added support for GTM