github.com/akamai/AkamaiOPEN-edgegrid-golang/v4@v4.1.0/CHANGELOG.md (about)

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