Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動。 情報
2015 年 9 月 8 日(火)に、Apigee Edge Developer Services Portal for Private Cloud の四半期版をリリースしました。
以前のプロダクト名「Apigee Edge On-premises Developer Services Portal」または「OPDK」は、「Apigee Edge Developer Services Portal for Private Cloud」に変更されました。
ご不明な点がございましたら、Apigee カスタマー サポートにお問い合わせください。
Apigee Edge のすべてのリリースノートの一覧については、Apigee リリースノートをご覧ください。
ポータルの Apigee Edge 要件
このリリースのポータルを Edge for Private Cloud のインストールに接続する場合は、バージョン 4.15.07.00 以降に接続して、すべての SmartDocs 機能をサポートする必要があります。詳細については、4.15.07.00 - Apigee Edge for Private Cloud リリースノートをご覧ください。
新機能
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 サービス内に存在する API モデルから生成されます。Edge の API モデルに加えた変更は、すべての Pantheon 環境で同じになります(Pantheon 環境全体に開発者が存在する仕組みに似ています)。
SmartDocs ベータ版から一般提供にアップグレードする
- Pantheon のdev 環境またはtest 環境で 15.05.27 リリースを更新してテストします。
- 使用している既存の API モデルに代わる新しいモデルを作成します。
- Swagger ドキュメントまたは WADL ドキュメントをインポートしている場合は、新しいリビジョンに再度インポートします。
- SmartDocs モジュールを使用して API モデルを維持している場合は、SmartDocs JSON としてエクスポートし、ファイル アタッチメントを使用して新しいモデルにインポートします。
- モデルのリビジョンのセキュリティ プロパティを設定します。[Content > SmartDocs > model] ページで、[Security Settings] を選択します。
- モデル設定ページ([Content] > [SmartDocs])で、[Operations] 列の [Settings] をクリックして、事前構成された認証を確認します。
- カスタム テンプレートを更新して CSS アセットと JS アセットの v6 を使用し、authSchemes や apiSchema などの新しいオブジェクト名を反映するように変更します。SmartDocs テンプレートの更新については、SmartDocs を使用した API のドキュメント化をご覧ください。
- モデル リビジョンを再レンダリングして公開します。
- 新しいドキュメントを検証したら、本番環境ポータルを 15.05.27 リリースに更新します。
Edge Enterprise をご利用で、アップグレード プロセスについてご不明な点やご懸念がある場合は、marsh@apigee.com と cnovak@apigee.com までメールでお問い合わせください。それ以外の場合は、Apigee コミュニティで最適な回答をご確認ください。
修正済みのバグ
このリリースでは以下のバグが修正されています。
問題 ID | 説明 |
---|---|
DEVSOL-487 | 収益化の日付形式を管理者が設定可能に 日付形式を、収益化の設定でヨーロッパと米国の日付形式に設定できるようになりました。 |
DEVSOL-584 | パス パラメータが初回使用時に記憶されない 呼び出し時のパス パラメータが常に記憶されませんでした。 |
DEVSOL-603 | 競合するプランのページの形式が不適切 既存のプランと重複するプランを購入する際、表示されるページの形式がユーザーにとって適切になりました。 |
DEVSOL-709 | SmartDocs: 空の値でリクエストを送信した後に URL テンプレート パラメータを編集できない メソッドのドキュメントでテンプレート パラメータを削除した後、SmartDocs からリクエストを送信すると、テンプレート パラメータを編集できなくなる問題を修正しました。 |
DEVSOL-723 | SmartDocs のインポート失敗時にユーザー フレンドリーなメッセージを表示する |
DEVSOL-1013 | デベロッパー ポータルのユーザーのメールアドレスを編集可能に プロフィール編集ページのメールアドレス フィールドが無効化されなくなり、デベロッパーはメールアドレスを変更できるようになります。 |
DEVSOL-1244 | OPDK リリースで環境インジケーター モジュールを有効にしない |
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 | 一般提供に移行する際にベータ版を削除する |
DEVSOL-1390 |
PHP SDK Edge ライブラリが更新され、__toString() の呼び出しに関する問題が修正されました 致命的なエラー: /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php の 221 行目で、オブジェクト以外のメンバー関数 format() を呼び出しています これは、toString() メソッドを呼び出すカスタムコードを使用している収益化のお客様にのみ影響するバグです。 |
DEVSOL-1398 | ユーザーにプロンプトを表示せずにインストール時に SmartDocs Petstore モデルをインポート SmartDocs の使用例をより網羅的に提供するため、サイトのインストール時に、天気モデルではなく、petstore swagger の例(http://petstore.swagger.io/v2/swagger.json)がインポートされるようになりました。 |
DEVSOL-1407 | デベロッパーが多いと Cron が失敗する Drupal cron の実行時に、多数のデベロッパーがタイムアウトの問題を引き起こします。組織のユーザー数が 200 を超える場合、バッチ処理が使用されるようになりました。 |
DEVSOL-1410 | デベロッパー ポータルのインストール時に接続エラーが明示されない トラブルシューティングの問題を最小限に抑えるために、Edge 管理接続が機能していない場合にインストーラにエラー メッセージを追加しました。 |
DEVSOL-1422 | Apigee プロファイルから SMTP 構成フォームを削除 インストール プロセスで SMTP を構成するかどうかを尋ねるメッセージが表示されなくなりました。代わりに、インストールが完了した後に、標準の Drupal 手順に沿って SMTP モジュールを有効にして適切に構成できます。 |
DEVSOL-1427 |
Devconnect デベロッパー アプリ モジュールにフックを追加して、アナリティクス データの変更を可能に # hook_devconnect_developer_apps_analytics_chart_data_alter() # hook_devconnect_developer_app_analytics_datapoints_params_alter() # hook_devconnect_developer_app_analytics_datapoints_alter() これにより、カスタム モジュールでデベロッパー アプリのアナリティクス グラフを変更できます。 |
DEVSOL-1464 | モデルの認証設定を保存する際の致命的なエラー セキュリティ スキームを削除する際に、関連するテンプレートの認証スキームも削除する必要があるかどうかを選択するチェックボックスが表示されるようになりました。 |
DEVSOL-1470 | [API] メニュー リンクと対応するビューを作成 デベロッパー ポータルの SmartDocs に、デフォルトで [API] という名前のメインメニューに、レンダリングされた SmartDocs ドキュメントへのリンクが追加されました。このリンクは、公開されたメソッドを含むモデルにリンクします。 |
DEVSOL-1486 | SmartDocs 呼び出しで事前定義されたキーによる認証が可能 事前提供された API キーとユーザー提供の API キーの両方による認証が可能になります。 |
DEVSOL-1499 | SmartDocs のパラメータの説明で HTML コードが解析されない SmartDocs のパラメータの説明で HTML コードが解析されるようになりました。 |
DEVSOL-1507 | [メソッドを追加] を使用して API に複数のパラメータを追加できない メソッドを編集するときに、SmartDocs API に複数のパラメータを追加できるようになりました。 |
DEVSOL-1509 | SmartDocs API の「サンプル」フィールドを編集する方法がない SmartDocs ページを編集するときに、[Body MIME type]、[Body documentation]、[Body sample] を設定できるようになりました。 |
DEVSOL-1534 | SmartDocs の出力に Content-type が入力されない Content-type が SmartDocs のメソッド ページに入力されるようになりました。 |
DEVSOL-1554 | 収益化の無効な日付の比較 収益化が有効になっているデベロッパー ポータルの [購入済みプラン] タブで、開始日が将来の日付のプランに対して [キャンセル] ボタンが表示されませんでした。 |
DEVSOL-1556 | 古いバージョンの Drupal モジュールが配布されている media_youtube モジュールと features モジュールが最新バージョンに更新されました。 |
DEVSOL-1558 | PetStore の例で SmartDocs メソッド ページがレンダリングされない 新規インストールで、SmartDocs PetStore の例のメソッドが正しくレンダリングされるようになりました。 |
DEVSOL-1562 | SmartDocs モデルごとにビューを生成する 新しいモデルを作成すると、そのモデルにデフォルトで新しいビューが作成されます。 |
DEVSOL-1565 | SmartDocs メソッドの編集で致命的なエラーが発生する SmartDocs メソッドの編集でエラーが発生することがある問題を修正しました。 |
DEVSOL-1567 | 管理画面の上部メニューに [モデルを追加] が表示される 管理画面の上部メニューに [モデルを追加] メニュー項目が表示される問題を修正しました。 |
DEVSOL-1576 | API ドキュメント ビューに表示名ではなくモデル名が表示される メニューの [API] をクリックしたときに表示される API ドキュメント ページに、表示名ではなくモデルの内部名が表示されていました。このリリースにアップデートする際にこのビューを変更した場合は、ビューを元に戻して変更を確認する必要があります。手順は次のとおりです。# 管理者としてログインします # [構造] > [ビュー] に移動します # [SmartDocs モデル] の [編集] の横にあるプルダウンをクリックして、すべてのオペレーションを表示します。# 「revert」と表示されている場合は、独自の変更でコードが上書きされています。[元に戻す] をクリックして、ビューをデフォルトの状態に戻します。ただし、このビューに加えた変更はすべて削除されます。 |
DEVSOL-1578 | サイトのインストール時に Weather モデルと Petstore モデルの両方をレンダリングする Petstore と Weather の SmartDocs モデルの両方が新しいサイトにインポートされます。 |
DEVSOL-1584 | プランを購入できない Apigee レスポンシブ テーマまたは Apigee レスポンシブ テーマのサブテーマを使用している場合、クラウド リリース 15.05.27.00 および 15.06.08.00 で収益化プランの購入フォームが送信されない問題を修正しました。 |
DEVSOL-1597 | デベロッパーのタイムアウト設定を変更できない Edge 接続のタイムアウト設定が正しく適用されないバグを修正しました。 |
DEVSOL-1620 |
[マイページ]、環境インジケーター、機能のモジュールのアップグレード https://www.drupal.org/project/me https://www.drupal.org/project/environment_indicator |
DEVSOL-1648 | arg_separator.output が「&」であることを確認して reCAPTCHA の破損を防ぐ Google reCAPTCHA の使用が破損するプラットフォーム関連の問題が修正されました。 |
DEVSOL-1651 | smartdocs モジュールが有効になっていない場合に Apigee Base テーマが失敗する apigee_base テーマは、SmartDocs モジュールが有効になっていることに依存しなくなりました。 |
DEVSOL-1654 |
admin_views のバージョンを上げて重大なセキュリティ修正を適用
|