Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
apiproxy Update deprecation section Feb 15, 2017
README.md Add what's new in the docs proxy Sep 1, 2018
deploy.sh Adding Jira release notes API proxy sample Sep 30, 2014
invoke.sh Adding Jira release notes API proxy sample Sep 30, 2014
jira_whatsnew_proxy.zip Add what's new in the docs proxy Sep 1, 2018

README.md

Jira release notes generator

This sample leverages a Jira API to return issues that are tagged in Jira with a release_notes label. The proxy converts Jira's JSON response to XML, then applies an XSL stylesheet that generates HTML-formatted release notes. The stylesheet grabs text from a "Release Notes Summary" field in Jira.

You can also add new_feature and known_issue labels in Jira. Issues with those tags are automatically added to the respective sections of the generated HTML.

If your Jira environment uses different fields, modify the URI query parameters accordingly (in invoke.sh as well, if you want to use that script), and modify the .xsl resource file accordingly.

Hint: The XSL stylesheet relies on a specific XML hierarchy for grabbing content. To see what the correct XML hierarchy is for your Jira environment, temporarily detach the XSL policy from the API proxy flow to get back pure XML.

Policies and resources used

  • JSON to XML policy
  • XSL Transform policy
  • XSL stylesheet

Configure

Update /setup/setenv.sh with your environment details

What gets set:

  • The username and password that you use to login to enterprise.apigee.com.
  • The name of the organization in which you have an account. Login to enterprise.apigee.com and check account settings.

Note: When you invoke the proxy, you'll use your Jira username and password for basic auth.

Import and deploy sample project

To deploy, run $ sh deploy.sh

To test, run $ sh invoke.sh

What's New in the Docs API proxy

The jira_whatsnew_proxy.zip file is an API proxy similar to the release notes proxy. It generates an HTML page of items to be included in a "What's New in the Docs" topic, similar to this page in the Apigee docs.

Copyright © 2014, 2018 Apigee Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.