15.05.27.00 - Apigee Developer Services ポータル リリースノート

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご覧ください。
info

2015 年 6 月 2 日(火)、Apigee Developer Services Portal の新しいクラウド バージョンをリリースしました。

ご不明な点がございましたら、Apigee Edge サポートにお問い合わせください。

Apigee Edge のすべてのリリースノートの一覧については、Apigee リリースノートをご覧ください。

新機能

SmartDocs の一般提供

SmartDocs がベータ版から一般提供に移行します。更新情報と新機能は次のとおりです。

  • Swagger 2.0 のサポート。ファイルまたは URL によるインポート、カスタム名のセキュリティ オブジェクトのサポートなど。
  • SmartDocs を生成するテンプレートのビジュアル デザインが改善されました。
  • Drupal の [Content] > [SmartDocs] メニューからアクセスできるデベロッパー ポータルのユーザビリティとワークフローの強化。
  • これまで「カスタム トークン」認証と呼ばれていたものが「API キー」と呼ばれるようになりました。
  • リビジョン レベルで定義された認証「セキュリティ」オブジェクト。
  • テンプレート レベルでのクライアント認証の構成。新しいリビジョンでは、事前構成された SmartDocs クライアント認証情報がリセットされなくなりました。

機能の詳細については、こちらのブログ投稿をご覧ください。

SmartDocs のドキュメントについては、SmartDocs を使用した API のドキュメント化をご覧ください。

SmartDocs のアップグレード プロセス

ベータ版期間中に SmartDocs をすでに使用している場合は、一般提供版の新機能と機能を使用するために、デベロッパー ポータルで SmartDocs をアップグレードする必要があります。

デベロッパー ポータルで公開済みの SmartDocs ページは引き続き機能しますが、既存のページまたは新しいページに変更を加えて編集または公開する前に、更新プロセスを行う必要があります。

デベロッパー ポータル内で SmartDocs をレンダリングして公開できますが、SmartDocs は Apigee の Edge API Management Services 内にある API モデルから生成されることに注意してください。Edge で API モデルに加えた変更は、すべての Pantheon 環境で同じになります(開発者が Pantheon 環境全体に存在する場合と同様です)。

SmartDocs ベータ版から一般提供版にアップグレードするには

  1. Pantheon の開発環境またはテスト環境で、15.05.27 リリースを更新してテストします。
  2. 使用している既存の API モデルを置き換える新しいモデルを作成します。
    • Swagger ドキュメントまたは WADL ドキュメントをインポートしたことがある場合は、新しいリビジョンに再度インポートします。
    • SmartDocs モジュールを使用して API モデルを維持している場合は、SmartDocs JSON としてエクスポートし、ファイル添付を使用して新しいモデルにインポートします。
  3. モデルのリビジョンのセキュリティ プロパティを設定します。[Content] > [SmartDocs] > [model] ページで、[Security Settings] を選択します。
  4. [Operations] 列の [Settings] をクリックして、モデル設定ページ([Content] > [SmartDocs])で事前構成済みの認証を確認します。
  5. CSS アセットと JS アセットの v6 を使用するようにカスタム テンプレートを更新し、authSchemes や apiSchema などの新しいオブジェクト名を反映するように変更します。SmartDocs テンプレートの更新については、SmartDocs を使用した API のドキュメント化をご覧ください。
  6. モデル リビジョンを再レンダリングして公開します。
  7. 新しいドキュメントを検証したら、本番環境ポータルを 15.05.27 リリースに更新します。

Edge エンタープライズのお客様で、アップグレード プロセスについてご質問やご不明な点がある場合は、marsh@apigee.com と cnovak@apigee.com にメールでお問い合わせください。それ以外の場合は、Apigee コミュニティをご利用ください。

修正済みのバグ

このリリースでは以下のバグが修正されています。

問題 ID 説明
DEVSOL-487 Monetization の日付形式を管理者が構成できるようにする
Monetization の収益化設定で、ヨーロッパと米国の形式の日付形式を構成できるようになりました。
DEVSOL-603 競合するプランのページが正しくフォーマットされていない
既存のプランと重複するプランを購入する際に表示されるページが、ユーザー向けに適切にフォーマットされるようになりました。
DEVSOL-642 クライアント レベルの構成をセキュリティ設定からテンプレート設定に移動
DEVSOL-709 SmartDocs: 空の値でリクエストを送信した後、URL テンプレート パラメータを編集できない
メソッドのドキュメントでテンプレート パラメータを削除した後、SmartDocs からリクエストを送信すると、テンプレート パラメータを編集できなくなる問題を修正しました。
DEVSOL-1013 デベロッパー ポータル ユーザーのメールアドレスを編集可能にする
プロフィール編集ページのメールアドレス フィールドが無効にならなくなり、デベロッパーはメールアドレスを変更できるようになります。
DEVSOL-1273 [モジュール] リストに [DevConnect Mint] が 2 回表示される
[モジュール] に [Dev Connect Mint] が 2 回表示されました。この問題は解決しました。
DEVSOL-1313 Swagger と WADL の両方で JSON/YAML ファイルまたは URL のインポートをサポート
WADL ファイルを URL 経由でインポートできるようになり、Swagger ファイルをアップロードできるようになりました。
DEVSOL-1339 SmartDocs 管理メニューの場所を変更
SmartDocs がコンテンツ メニューに移動し、SmartDocs の設定が設定管理メニューに移動しました。
DEVSOL-1340 GA に移行する際にベータ版を削除
SmartDocs はコンテンツ メニューに移動し、SmartDocs の設定は設定管理メニューに移動しました。
DEVSOL-1390 PHP SDK Edge ライブラリが更新され、__toString() の呼び出しに関する問題が修正されました
PHP SDK Edge ライブラリが更新され、DeveloperRatePlan オブジェクトで __toString() を呼び出すと次のエラーが発生する問題が修正されました。{quote} 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 {quote} これは、toString() メソッドを呼び出すカスタムコードを使用している収益化のお客様にのみ影響するバグです。
DEVSOL-1398 インストール時にユーザーにプロンプトを表示せずに SmartDocs Petstore モデルをインポート
SmartDocs の使用例をより包括的に示すため、SmartDocs はサイトのインストール時に天気モデルではなく、petstore swagger の例(http://petstore.swagger.io/v2/swagger.json)をインポートするようになりました。
DEVSOL-1407 開発者が多いと Cron が失敗する
Drupal cron の実行時に、開発者が多いとタイムアウトの問題が発生しました。組織のユーザー数が 200 人を超える場合、バッチ処理が使用されるようになりました。
DEVSOL-1470 「APIs」メニュー リンクと対応するビューを作成
Dev Portal SmartDocs には、デフォルトで「APIs」という名前のメインメニューに SmartDocs レンダリング ドキュメントへのリンクが設定されています。このリンクは、公開されたメソッドを含むモデルにリンクされています。

既知の問題

このリリースには、次の既知の問題があります。

問題 ID 説明
DEVSOL-1558
新規インストールで Petstore の例の SmartDocs メソッド ページが正しくレンダリングされない
SmartDocs の Petstore メソッドのページ例が、新規インストールで正しくレンダリングされない。この問題を解決するには:
  1. Drupal メニューで、[Content] > [SmartDocs] を選択します。
  2. [Petstore Example] モデルを選択します。
  3. [Update Options] で [Render and publish nodes] を選択します。
  4. [すべて選択 / 選択解除] チェックボックスをオンにして、すべてのノードを選択します。
  5. [更新] をクリックします。

これでノードが正しくレンダリングされるはずです。