What's new in the docs

This page describes notable changes we made in the Apigee documentation over the past (and prior) periods.

In addition to this page, keep an eye on the Apigee Release Notes for documentation updates that correspond to specific Apigee releases.

May 4, 2018

Following are notable doc updates between the previous period and the date above.

Cloud

  • Hosted Targets Beta

    Hosted Targets (now in Beta release), which replaces the Trireme feature, lets you run Node.js applications in a native, secure, scalable, and isolated environment where Edge API proxies can call them as target services. For more information, see the Hosted Targets documentation.

  • Message templates

    Message templates let you dynamically populate strings in certain policy and TargetEndpoint XML elements. While message templating has been available in Edge for a long time, Apigee has released new string manipulation functions for use in message templates. We've created an About message templates topic to give you an overview of message templating, and a Message template function reference that shows you how to use the functions.

April 20, 2018

Following are notable doc updates between the previous period and the date above.

Cloud

  • List Company Apps management API pagination

    The List Company Apps management API returns a limit of 100 company apps for organizations with Core Persistence Services (CPS) enabled. We've added two query parameters to the API, count and startKey, to enable response pagination.

  • Apigee Test documentation retired

    Apigee Test has been retired, as listed on the deprecations and retirements page. Apigee Test documentation is no longer available. A possible alternative for testing the availability of APIs is Stackdriver Uptime Checks.

  • Secure store (vaults) documentation retired

    The Apigee secure store, also known as vaults, has been retired, as listed on the deprecations and retirements page. The secure store documentation is no longer available. The replacement for the secure store is encrypted key value maps (KVMs).

  • KVM names are case sensitive

    Key value map (KVM) names/identifiers are case sensitive in organizations with Core Persistence Services enabled. We've updated various topics in the docs to note this.

  • Clear All Cache management API

    We removed the "prefix" query parameter from the Clear All Cache Entries management API. The doc incorrectly said the "prefix" query parameter cleared caches with a specific prefix. But the API clears all caches regardless of prefix.

April 6, 2018

Following are notable doc updates between the previous period and the date above.

Cloud

  • Giving Apigee Support access to your Trace sessions

    If you need to give Apigee Support access to your Trace sessions for troubleshooting, you must now select the option for that in the Trace tool. For more information, see Apigee Support use of Trace.

  • Private and security settings: data protection officer and EU representative

    A new Data Protection Officer and EU Representative section in our FAQs describes how to identify a data protection officer and an EU representative for your Edge organization.

March 23, 2018

Following are notable doc updates between the previous period and the date above.

Cloud

  • KVM and API product names case sensitive in CPS

    We updated our documentation in various places to note that key value map (KVM) and API product names are case sensitive in organizations that have Core Persistence Services (CPS) enabled. Be sure to use the exact case of names in places like policy configuration and management API calls.

  • Distributed Spike Arrest

    Spike Arrest counts can be automatically distributed across message processors when using auto-scaling groups. You do this with the UseEffectiveCount element. For more information, see the Spike Arrest policy documentation.

  • Self-service TLS and virtual hosts

    We published documentation for the general availability release of self-service TLS and virtual hosts.

  • Removed parallel deployment of API proxy revisions content

    In the Deploying proxies in the UI topic, we removed the section, "Deploying multiple versions of an API proxy to the same environment," as deploying multiple revisions of an API proxy in parallel by changing the base path is not a best practice.

  • Management API: List API Products count and startKey

    The List API Products management API topic now includes pagination query parameters for count and startKey. These query parameters are available only in organizations that have Core Persistence Services (CPS) enabled.

  • Concurrent Rate Limit policy and DefaultFaultRule

    In the Concurrent Rate Limit policy topic, we note that the policy is also required in the DefaultFaultRule to ensure that the rate limit counters are maintained correctly in the event of an error.

  • Analytics prerequisites

    We created a First things first: How to generate complete analytics data section in the Analytics Overview topic to explain why you might not see all the analytics data you expect to see.

  • Management API: Get KVMs

    The Get KeyValueMap management APIs in organizations enabled with Core Persistence Services (CPS) behave differently than in non-CPS-enabled organizations. For details, see the "Get KeyValueMap APIs" section of the CPS retirements and changes.

Private Cloud

  • 4.18.01 release

    We published documentation for the Edge for Private Cloud 4.18.01 release.

December 15, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Management API traffic limit

    We've published a traffic limit for the Edge management API. Each organization on a paid plan is limited to 10,000 management API calls per minute, and trial organizations are allowed up to 600 calls per minute.

  • List apps by app status API

    The API documentation titled "List App IDs in an Organization by Key Status" was incorrect and has been changed to List App IDs in an Organization by App Status. The API returns a list of apps by app status (approved or revoked). The previously documented "pending" status has been removed from the topic.

December 1, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Error troubleshooting topics

    We've begun creating a library of troubleshooting topics for errors you might receive when using Apigee. The topics provide detailed information about possible causes and potential fixes you can try. For more information, see Troubleshoot Apigee errors.

  • 4.17.09 Edge for Private Cloud installer on Pivotal Cloud Foundry

    For more information, see Edge Installer for Pivotal Cloud Foundry.

  • New Edge portal custom domain configuration

    Enhancements have been made to the portal custom domain configuration process to facilitate self-service and improve performance. For more information, see Customizing your domain name. (69604000)

  • Japanese doc translations (???)

    The Japanese version of the Apigee documentation, formerly located at ja.docs.apigee.com, will be offline for a few months while we transition to a new documentation and translation framework. We apologize for the inconvenience. However, the good news is that when the translated content returns, there will be more of it than we previously had.

November 17, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

November 3, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • AWS "Dedicated Instances" for HIPAA compliance deprecation announcement
    Apigee announced the deprecation of AWS Dedicated Instances for HIPAA compliance. For more information, see https://docs.apigee.com/deprecated-features#hipaa_dedicated_instances. (68660828)
  • Concurrent Rate Limit policy and DefaultFaultRule
    Updated the Concurrent Rate Limit policy topic to state that the policy is also required in the DefaultFaultRule to ensure that the rate limit counters are maintained correctly in the event of an error. (68161202)

October 6, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Automated sign-up for new evaluation accounts
    The sign-up process for new evaluation accounts is now automated. New evaluation accounts are provisioned in minutes instead of hours in fewer steps. For more information, see Creating an Apigee Edge account. (66191481)

August 25, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Update naming restrictions for Target Servers and keystores
    The names of keystores and TargetServers cannot contain special characters. Only alphanumeric characters are allowed. The docs have been updated to reflect this. (DOC-2336)

August 11, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

Private Cloud

July 28, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Document API for managing monetization scheduled jobs
    In the section, Manage the monetization job schedule using the API, we added a note saying that Apigee Edge Private Cloud customers with system admin privileges can manage the monetization job schedule using the API. Apigee Edge Cloud customers should contact their Apigee Support representative for assistance with managing the monetization job schedule. (DOC-2269)

July 14, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • ConcurrentRateLimit performance overhead
    Added a note to the Concurrent Rate Limit policy topic saying that use of the policy has performance overhead. (DOC-2228)

Private Cloud

June 30, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

Private Cloud

  • Unpublish external-role-mapping topic
    Removed documentation for the External Role Mapping feature of the external authentication mechanism pending updates to this feature. (DOC-2056)
  • Drupal developer portal root directory in Private Cloud 4.17.05
    The root directory of Drupal for the Developer Service portal for the 4.17.05 Private Cloud Release now uses /opt/apigee/apigee-drupal/wwwroot as the root directory, replacing /opt/apigee/apigee-drupal. (DOC-2181)
  • Edge 4.17.05 installer for Pivotal Cloud Foundry
    On Tuesday, June 20, 2017, we released the Apigee Edge for Private Cloud Installer for Pivotal Cloud Foundry. See http://docs.apigee.com/private-cloud/v4.17.05/edge-installer-pivotal-cloud-foundry for more information. (DOC-2023)

June 16, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Analytics: Update metrics and dimension definitions
    Updated the Analytics metrics, dimensions, and filters reference with definitions of analytics metrics and dimensions. (DOC-377)
  • Drupal Dev Portal Default URL: *.devportal.apigee.io
    The default URL for Drupal developer portals has changed from:

    http://{environment}-{your-org-name}.devportal.apigee.com/
    to:
    http://{environment}-{your-org-name}.devportal.apigee.io/

    For more information, see Creating a developer portal. (DOC-2108)
  • Fix 'XSLT pagination' sample proxy
    Fixed the XSLT pagination sample proxy to use a local proxy as a target, replacing the broken target. (DOC-2107)
  • Added documentation on Router troubleshooting
    The Edge Router is implemented by using the Nginx router. We have added new documentation on troubleshooting the Router during configuration and update. See http://docs.apigee.com/private-cloud/latest/troubleshooting-edge-router. (DOC-2018)

Private Cloud

  • Document requirement to disable IPv6 on Google Cloud Platform for RedHat/CentOS 7
    If you are installing Edge on RedHat 7 or CentOS 7 on Google Cloud Platform, then you must disable IPv6 on all Qpid nodes. See the RedHat or CentOS documentation for your specific OS version for instructions on disabling IPv6. (DOC-2047)
  • New installer and command syntax for the apigee-analytics-collector utility
    Added documentation for the new installation instructions and command syntax for the apigee-analytics-collector utility. You now use apigee-service to install the apigee-analytics-collector utility, instead of npm, and invoke the apigee-analytics-collector utility through apigee-service. See http://docs.apigee.com/private-cloud/latest/uploading-api-traffic-data-apigee-beta-release. (DOC-2060)
  • Updated doc for enabling JMX
    The Edge for Private Cloud doc incorrectly specified that JMX was enabled by default for Edge components. However, JMX is only enabled by default for Cassandra. To enable JMX for other components, see the updated documentation at http://docs.apigee.com/private-cloud/latest/how-monitor#enablingjmxauthenticationandsettingthejmxpassword. (DOC-2055)

June 2, 2017

Following are notable doc updates between the previous period and the date above.

Private Cloud

May 19, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Set isEnabled default to true for Update TargetServer API
  • The default value for isEnabled is now correctly shown as 'true' in the property descriptions of the Update TargetServer API. (DOC-1889)
  • Offset parameter on the /stats API ignored on raw "fact" queries
    With the /stats management API, which gets metrics for a dimension, the offset pagination query parameter description includes a new note that the parameter is ignored if the Spark engine is used to process a "fact" query. (DOC-1977)
  • Managing the audience for your portal and its contents

    The New Edge UI documentation contains a new section on managing the audience for your portal and its contents. Specifically, you can:

    (DOC-1993)

Private Cloud

May 5, 2017

Following are notable doc updates between the previous period and the date above.

Cloud

  • Create docs for Acquia Drupal (for EU customers)
    Apigee now uses Acquia, a web site management service, for hosting cloud-based versions of the Developer Services portal in the European Union (EU). Acquia is designed to work with Drupal to let you develop, test, and publish your portal in a secure environment. For more information, see Working with Acquia. (DOC-1952)
  • Clarify the description of cache behavior
    In the Cache internals topic, we corrected some information and clarified caching behavior between message processors. (DOC-1973)
  • Mark Apigee Test as an Apigee Labs project
    Apigee Test is an Apigee Labs product. We've added a banner to the Apigee Test topics indicating this, and we moved the Apigee Test topics to a newApigee Labs section in the docs. (Note: This feature is retired.) (DOC-1884)

Private Cloud

  • Update Message Logging policy reference to describe Edge Private Cloud directory structure
    Updated the doc for the Message Logging policy to describe the log file location for Edge for Private Cloud and how to configure it. (DOC-1844)
  • Use IP addresses when configuring Cassandra nodes
    Updated multiple Edge for Private Cloud topics to indicate that you must use IP addresses in the config files to identify Cassandra nodes. You cannot use DNS names. (DOC-1985)
  • Replace metadata size with permgen size
    Updated Modifying Java Memory Settings to note that permgen size was replaced in Java 1.8 with class metadata size. (DOC-1962)
  • 10MB as default message payload size
    Updated the Edge Private Cloud docs to show 10MB as the default message payload size. For example, see the 4.17.01 doc here: http://docs.apigee.com/api-services/content/best-practices-api-proxy-design-and-development#size. (DOC-1933)
  • Property ws.acceptAnyCertificate changed to play.ws.ssl.loose.acceptAnyCertificate
    In the Edge Private Cloud 4.17.01 doc for Configure the Edge UI to use TLS to access the Edge API, the conf/application.conf+ws.acceptAnyCertificate property has been changed to conf/application.conf+play.ws.ssl.loose.acceptAnyCertificate. (DOC-1926)

Send feedback about...

Apigee Docs