4.15.07.00 - Apigee Developer Services Portal Release Notes

On Tueday September 8, 2015, we released a quarterly version of Apigee Edge Developer Services Portal for Private Cloud.

The former product name "Apigee Edge On-premises Developer Services Portal" or "OPDK" is now "Apigee Edge Developer Services Portal for Private Cloud".

If you have questions, go to Apigee Customer Support.

For a list of all Apigee Edge release notes, see Apigee Release Notes.

Apigee Edge requirements for the portal

If you are connecting this release of the portal to an installation of Edge for Private Cloud, then you must connect it to version 4.15.07.00 or later to ensure that all SmartDocs features are supported. See 4.15.07.00 - Apigee Edge for Private Cloud release notes for more.

New features

SmartDocs general availability

SmartDocs is graduating from beta to general availability. Updates and new features include:

  • Support for Swagger 2.0, including import by file or URL, including support for custom-named security objects.
  • Visual design improvements in the templates that generate SmartDocs.
  • Usability and workflow enhancements in the Developer Portal, available through the Content > SmartDocs menu in Drupal.
  • What has been known as "Custom Token" authentication is now called "API Key".
  • Authentication "security" objects defined at the revision level.
  • Configuration of client authentication at the template level. New revisions no longer reset any preconfigured SmartDocs client credentials.

For more feature descriptions, see this blog post.

For SmartDocs documentation, see Using SmartDocs to document APIs.

SmartDocs upgrade process

If you've already been using SmartDocs during the beta period, new features and capabilities in the general availability version require that you upgrade SmartDocs in your developer portal.

Any SmartDocs pages that have already been published in your developer portal will continue to work, but you must follow the update process before editing or publishing any changes to existing or new pages.

Keep in mind that while you can render and publish SmartDocs inside your developer portal, SmartDocs are generated from the API model that lives within Apigee's Edge API Management Services. Any changes you make to an API model in Edge will be the same across all your Pantheon environments (similar to how developers exist across Pantheon environments).

To upgrade from SmartDocs beta to general availability

  1. Update and test the 15.05.27 release in your dev or test environments on Pantheon.
  2. Create a new model to replace any existing API model you have been using.
    • If you have been importing Swagger or WADL documents, import them again into a new revision.
    • If you have been maintaining your API model via the SmartDocs module, export as SmartDocs JSON and import into your new model using file attachment.
  3. Set the security properties of the revision of your model. On the Content > SmartDocs > model page, select Security Settings.
  4. Check any pre-configured authentication in the model settings page (Content > SmartDocs) by clicking Settings in the Operations column.
  5. Update any custom templates to use v6 of the CSS and JS assets, and make changes to reflect any new object names, such as authSchemes and apiSchema. For information on updating SmartDocs templates, see Using SmartDocs to document APIs.
  6. Re-render and publish your model revision.
  7. After validating the new documentation, update your production portal to the 15.05.27 release.

If you are an Edge enterprise customer and have questions or concerns about the upgrade process, please email marsh@apigee.com and cnovak@apigee.com. Otherwise, please use the Apigee Community for the best response.

Bugs fixed

The following bugs are fixed in this release.

Issue ID Description
DEVSOL-487 Day format in Monetization should be configurable by admins
The date format is now configurable in Monetization under monetization settings for European and US date formats.
DEVSOL-584 Path parameter not remembered on first use
Path parameter when making calls was not always remembered.
DEVSOL-603 Conflict Plan page is poorly formatted
When purchasing a plan that overlaps with an existing plan, the page shown is now formatted nicely for the user.
DEVSOL-709 SmartDocs: URL template parameter not editable after sending request with empty value
Fixes the issue that renders the template parameters un-editable after sending the request from SmartDocs after deleting the template parameter in the method documentation.
DEVSOL-723 Show user friendly messages on SmartDocs Import failure
DEVSOL-1013 Make Dev Portal user email addresses editable
The email address field in the edit profile page will not be disabled anymore and developers can change their email addresses.
DEVSOL-1244 Do not enable Environment Indicator module for OPDK releases
DEVSOL-1273 "DevConnect Mint" shows up twice in Modules list
Under Modules, "Dev Connect Mint" was displayed twice. This is now fixed.
DEVSOL-1313 Support JSON/YAML File or URL import for both Swagger and WADL
WADL files can now be imported via URL and Swagger files can be uploaded.
DEVSOL-1339 Change SmartDocs Admin menu locations
SmartDocs is now located under the content menu, and the smartdocs settings are under the settings admin menu.
DEVSOL-1340 Remove Beta when going to GA
DEVSOL-1390

The PHP SDK Edge library has been updated to fix the issue of calling __toString()
The PHP SDK Edge library has been updated to fix the issue of calling __toString() on the DeveloperRatePlan object which creates this error:

Fatal error: Call to a member function format() on a non-object in /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php on line 221

This is a bug that only affects Monetization customers with custom code calling the toString() method.

DEVSOL-1398 SmartDocs Petstore Model imported on install w/out prompting user
SmartDocs now imports the petstore swagger example during site installation (http://petstore.swagger.io/v2/swagger.json) instead of the weather model in order to have a more exhaustive example of using SmartDocs.
DEVSOL-1407 Cron fails when there are many developers
When running Drupal cron, a large amount of developers would cause a timeout issue. When an org has more than 200 users, a batch process is now used.
DEVSOL-1410 Connection Errors not apparent when installing Dev Portal
Added better error messaging to installer when Edge management connection is not working to minimize troubleshooting issues.
DEVSOL-1422 Remove SMTP Configuration form from Apigee profile
The install process no longer asks you if you want to configure SMTP, instead this can be done after installation completes following standard Drupal practice of enabling the SMTP module and configuring it properly.
DEVSOL-1427

Add hooks to Devconnect Developer Apps module to allow altering of the analytics data
The devconnect_developer_apps module now provides three new hooks:

# hook_devconnect_developer_apps_analytics_chart_data_alter()

# hook_devconnect_developer_app_analytics_datapoints_params_alter()

# hook_devconnect_developer_app_analytics_datapoints_alter()

These allow custom modules to alter the developer app analytics chart.

DEVSOL-1464 Fatal error when saving Auth settings for a model
When a Security scheme is deleted, it now gives a checkbox to select if the associated Template auth scheme also needs to be deleted.
DEVSOL-1470 Create "APIs" Menu link and corresponding view
Dev Portal SmartDocs now comes by default with a link to the SmartDocs rendered documentation in the main menu named "APIs", which links to any models with published methods.
DEVSOL-1486 SmartDocs calls can authenticate with a predefined key
Enables authentication with both pre-supplied and user-supplied API keys.
DEVSOL-1499 HTML code not parsed in SmartDocs param descriptions
HTML code is now parsed in SmartDocs param descriptions.
DEVSOL-1507 Cannot add multiple params to an API with Add Method
You can now add multiple params to a SmartDocs API when editing the method.
DEVSOL-1509 Don't see a way to edit the "sample" field for a SmartDocs API
You can now set the "Body MIME type," "Body documentation" and "Body sample" when you edit a SmartDocs page.
DEVSOL-1534 Content-type not being populated in SmartDocs output
Content-type is now being populated in SmartDocs method page.
DEVSOL-1554 Invalid date comparison in Monetization
In the purchased plan tab for monetization enabled developer portals, the "Cancel" button was never displayed for a plan with a future start date,
DEVSOL-1556 Old version of Drupal modules being shipped
The media_youtube and features module has been updated to latest version.
DEVSOL-1558 SmartDocs method pages not rendering for PetStore example
On new installs, the example SmartDocs PetStore methods now render correctly.
DEVSOL-1562 Generate a view for each SmartDocs model
When creating a new model, a new view is created by default for that model.
DEVSOL-1565 Editing SmartDocs method generates a Fatal error
Fixed issue where editing a SmartDocs method would sometimes generate an error.
DEVSOL-1567 "Add model" being displayed on top admin menu
Fixed the problem that "Add model" menu item is being displayed on the top admin menu.
DEVSOL-1576 API Documentation View displays model name, not display name
The API Documentation page that is shown when clicking "APIs" in the menu was showing the model's internal name instead of display name. If you are updating to the release and you have changed this view, you will need to revert your view to see these changes by following these steps: # Login as an administrator # Go to Structure > Views # Click the dropdown next to "Edit" on "SmartDocs Models" to see all operations. # If you see "revert", then you have overwritten the code w/your own change. Click "revert" to put the view back to the default state. Note that this will remove any changes you have made to this view.
DEVSOL-1578 Render both Weather and Petstore models on site installs
Both the Petstore and Weather SmartDocs models are imported on new sites.
DEVSOL-1584 Plans cannot be purchased
Fixed issue where monetization plans purchase form would not submit for cloud release 15.05.27.00 and 15.06.08.00 if you were using the Apigee Responsive theme or a subtheme of the Apigee Responsive theme.
DEVSOL-1597 Cannot change developer timeout settings
A bug in which the Edge connection timeout settings were not properly applied was fixed.
DEVSOL-1620

Me, environment indicator, and features module upgrades
Moderately critical security update for the me module and module updates for environment indicator and features. More info:

https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator

https://www.drupal.org/project/features

DEVSOL-1648 Make sure arg_separator.output is '&' to prevent reCAPTCHA breakage
A platform-related issue in which use of Google reCAPTCHA was broken has been fixed.
DEVSOL-1651 Apigee Base theme fails if smartdocs module is not enabled
apigee_base theme is no longer dependent on SmartDocs module being enabled.
DEVSOL-1654

Bump version of admin_views to pick up critical security fix
The following contrib modules were updated:

  • Administrative Views
  • Migrate
  • Redirect
  • Redis
  • Views Bulk Operations