4.15.07.00 - Notes de version du portail de services pour les développeurs Apigee

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X.
info

Le mardi 8 septembre 2015, nous avons publié une version trimestrielle du portail des services de développement Apigee Edge pour le cloud privé.

L'ancien nom du produit "Portail des services de développement sur site d'Apigee Edge" ou "OPDK" est désormais "Portail des services de développement d'Apigee Edge pour le cloud privé".

Pour toute question, contactez l'assistance client Apigee.

Pour obtenir la liste de toutes les notes de version d'Apigee Edge, consultez les notes de version d'Apigee.

Exigences Apigee Edge pour le portail

Si vous connectez cette version du portail à une installation d'Edge pour Private Cloud, vous devez la connecter à la version 4.15.07.00 ou ultérieure pour vous assurer que toutes les fonctionnalités SmartDocs sont compatibles. Pour en savoir plus, consultez les notes de version 4.15.07.00 d'Apigee Edge pour Private Cloud.

Nouvelles fonctionnalités

Disponibilité générale de SmartDocs

SmartDocs passe de la version bêta à la disponibilité générale. Voici les mises à jour et les nouvelles fonctionnalités:

  • Compatibilité avec Swagger 2.0, y compris l'importation par fichier ou URL, y compris la compatibilité avec les objets de sécurité nommés de manière personnalisée.
  • Améliorations de la conception visuelle dans les modèles qui génèrent des SmartDocs.
  • Améliorations de l'usabilité et du workflow dans le portail des développeurs, disponibles dans le menu "Contenu > SmartDocs" de Drupal.
  • L'authentification "Jeton personnalisé" s'appelle désormais "Clé API".
  • Objets "sécurité" d'authentification définis au niveau de la révision.
  • Configuration de l'authentification du client au niveau du modèle. Les nouvelles révisions ne réinitialisent plus les identifiants client SmartDocs préconfigurés.

Pour en savoir plus sur les fonctionnalités, consultez cet article de blog.

Pour en savoir plus sur SmartDocs, consultez Utiliser SmartDocs pour documenter les API.

Processus de mise à niveau de SmartDocs

Si vous utilisiez déjà SmartDocs pendant la période bêta, vous devez mettre à niveau SmartDocs dans votre portail pour les développeurs pour profiter des nouvelles fonctionnalités de la version disponible pour tous.

Les pages SmartDocs déjà publiées dans votre portail pour les développeurs continueront de fonctionner, mais vous devez suivre la procédure de mise à jour avant de modifier ou de publier des modifications apportées à des pages existantes ou nouvelles.

N'oubliez pas que, même si vous pouvez afficher et publier des SmartDocs dans votre portail des développeurs, ils sont générés à partir du modèle d'API qui se trouve dans les services de gestion des API Edge d'Apigee. Toutes les modifications que vous apportez à un modèle d'API dans Edge seront les mêmes dans tous vos environnements Pantheon (comme les développeurs dans les environnements Pantheon).

Passer de la version bêta de SmartDocs à la version disponible pour tous les utilisateurs

  1. Mettez à jour et testez la version 15.05.27 dans vos environnements dev ou test sur Pantheon.
  2. Créez un modèle pour remplacer tout modèle d'API existant que vous utilisiez.
    • Si vous avez importé des documents Swagger ou WADL, importez-les à nouveau dans une nouvelle révision.
    • Si vous avez géré votre modèle d'API via le module SmartDocs, exportez-le au format JSON SmartDocs, puis importez-le dans votre nouveau modèle à l'aide d'une pièce jointe.
  3. Définissez les propriétés de sécurité de la révision de votre modèle. Sur la page Contenu > SmartDocs > modèle, sélectionnez Paramètres de sécurité.
  4. Vérifiez toute authentification préconfigurée sur la page des paramètres du modèle (Contenu > SmartDocs) en cliquant sur Paramètres dans la colonne "Opérations".
  5. Mettez à jour les modèles personnalisés pour qu'ils utilisent la version 6 des composants CSS et JS, et apportez les modifications nécessaires pour refléter les nouveaux noms d'objets, tels que authSchemes et apiSchema. Pour savoir comment mettre à jour des modèles SmartDocs, consultez Utiliser SmartDocs pour documenter des API.
  6. Réaffichez et publiez la version de votre modèle.
  7. Après avoir validé la nouvelle documentation, mettez à jour votre portail de production vers la version 15.05.27.

Si vous êtes un client Edge Enterprise et que vous avez des questions ou des préoccupations concernant le processus de mise à niveau, veuillez envoyer un e-mail à marsh@apigee.com et cnovak@apigee.com. Sinon, veuillez utiliser la communauté Apigee pour obtenir la meilleure réponse.

Bugs résolus

Les bugs suivants sont résolus dans cette version.

ID du problème Description
DEVSOL-487 Le format de jour dans "Monétisation" doit être configurable par les administrateurs
Le format de date est désormais configurable dans "Monétisation", sous les paramètres de monétisation, pour les formats de date européens et américains.
DEVSOL-584 Le paramètre de chemin d'accès n'était pas mémorisé lors de la première utilisation
Le paramètre de chemin d'accès lors des appels n'était pas toujours mémorisé.
DEVSOL-603 Mauvais formatage de la page du forfait en conflit
Lorsque vous achetez un forfait qui se chevauche avec un forfait existant, la page affichée est désormais bien formatée pour l'utilisateur.
DEVSOL-709 SmartDocs: le paramètre de modèle d'URL n'est pas modifiable après l'envoi d'une requête avec une valeur vide
corrige le problème qui rend les paramètres de modèle non modifiables après l'envoi de la requête depuis SmartDocs après avoir supprimé le paramètre de modèle dans la documentation de la méthode.
DEVSOL-723 Afficher des messages conviviaux en cas d'échec de l'importation SmartDocs
DEVSOL-1013 Modification des adresses e-mail des utilisateurs du portail des développeurs pour les rendre modifiables
Le champ d'adresse e-mail de la page de modification du profil ne sera plus désactivé, et les développeurs pourront modifier leur adresse e-mail.
DEVSOL-1244 Ne pas activer le module d'indicateur d'environnement pour les versions OPDK
DEVSOL-1273 "DevConnect Mint" apparaît deux fois dans la liste des modules
Sous "Modules", "DevConnect Mint" s'affichait deux fois. Ce problème est désormais résolu.
DEVSOL-1313 Compatibilité avec l'importation de fichiers JSON/YAML ou d'URL pour Swagger et WADL
Les fichiers WADL peuvent désormais être importés via une URL et les fichiers Swagger peuvent être importés.
DEVSOL-1339 Modification des emplacements du menu d'administration SmartDocs
SmartDocs se trouve désormais dans le menu "Contenu", et les paramètres SmartDocs dans le menu d'administration des paramètres.
DEVSOL-1340 Supprimer la version bêta lors du passage à GA
DEVSOL-1390

La bibliothèque PHP SDK Edge a été mise à jour pour résoudre le problème d'appel de __toString()
La bibliothèque PHP SDK Edge a été mise à jour pour résoudre le problème d'appel de __toString() sur l'objet DeveloperRatePlan, qui génère cette erreur:

Erreur fatale: appel à une fonction membre format() sur un non-objet dans /Applications/MAMP/htdocs/ordnance/docroot/profiles/apigee/libraries/mgmt-api-php-sdk/Apigee/Mint/DeveloperRatePlan.php à la ligne 221

Il s'agit d'un bug qui ne concerne que les clients Monetization avec du code personnalisé appelant la méthode toString().

DEVSOL-1398 Modèle SmartDocs Petstore importé lors de l'installation sans invite à l'utilisateur
SmartDocs importe désormais l'exemple swagger Petstore lors de l'installation du site (http://petstore.swagger.io/v2/swagger.json) au lieu du modèle météo afin d'obtenir un exemple plus complet de l'utilisation de SmartDocs.
DEVSOL-1407 Le cron échoue lorsqu'il y a de nombreux développeurs
Lorsque vous exécutez le cron Drupal, un grand nombre de développeurs entraîne un problème d'expiration du délai. Lorsqu'une organisation compte plus de 200 utilisateurs, un processus par lot est désormais utilisé.
DEVSOL-1410 Erreurs de connexion non visibles lors de l'installation du Dev Portal
Amélioration des messages d'erreur dans le programme d'installation lorsque la connexion de gestion Edge ne fonctionne pas afin de réduire les problèmes de dépannage.
DEVSOL-1422 Suppression du formulaire de configuration SMTP du profil Apigee
Le processus d'installation ne vous demande plus si vous souhaitez configurer le SMTP. Vous pouvez le faire une fois l'installation terminée, en suivant la pratique standard Drupal consistant à activer le module SMTP et à le configurer correctement.
DEVSOL-1427

Ajout de crochets au module Devconnect Developer Apps pour permettre de modifier les données analytiques
Le module devconnect_developer_apps fournit désormais trois nouveaux crochets:

# hook_devconnect_developer_apps_analytics_chart_data_alter()

# hook_devconnect_developer_app_analytics_datapoints_params_alter()

# hook_devconnect_developer_app_analytics_datapoints_alter()

Ils permettent aux modules personnalisés de modifier le graphique des données analytiques de l'application du développeur.

DEVSOL-1464 Erreur fatale lors de l'enregistrement des paramètres d'authentification d'un modèle
Lorsqu'un schéma de sécurité est supprimé, une case à cocher permet désormais de sélectionner si le schéma d'authentification du modèle associé doit également être supprimé.
DEVSOL-1470 Création du lien de menu "API" et de la vue correspondante
Les SmartDocs du portail des développeurs sont désormais fournis par défaut avec un lien vers la documentation générée par SmartDocs dans le menu principal intitulé "API", qui redirige vers tous les modèles avec des méthodes publiées.
DEVSOL-1486 Les appels SmartDocs peuvent s'authentifier avec une clé prédéfinie
Active l'authentification avec des clés API fournies à l'avance et fournies par l'utilisateur.
DEVSOL-1499 Le code HTML n'était pas analysé dans les descriptions des paramètres SmartDocs
Le code HTML est désormais analysé dans les descriptions des paramètres SmartDocs.
DEVSOL-1507 Impossible d'ajouter plusieurs paramètres à une API avec "Ajouter une méthode"
Vous pouvez désormais ajouter plusieurs paramètres à une API SmartDocs lorsque vous modifiez la méthode.
DEVSOL-1509 Impossible de modifier le champ "sample" pour une API SmartDocs
Vous pouvez désormais définir les paramètres "Type MIME du corps", "Documentation du corps" et "Exemple du corps" lorsque vous modifiez une page SmartDocs.
DEVSOL-1534 Le type de contenu n'est pas renseigné dans la sortie SmartDocs
Le type de contenu est désormais renseigné sur la page de méthode SmartDocs.
DEVSOL-1554 Comparaison de dates non valide dans la section "Monétisation"
Dans l'onglet "Forfait acheté" des portails des développeurs avec la monétisation activée, le bouton "Annuler" n'était jamais affiché pour un forfait dont la date de début était future,
DEVSOL-1556 Ancienne version des modules Drupal envoyée
La dernière version du module media_youtube et des fonctionnalités a été mise à jour.
DEVSOL-1558 Les pages de méthode SmartDocs ne s'affichent pas pour l'exemple PetStore
Lors des nouvelles installations, les exemples de méthodes SmartDocs PetStore s'affichent désormais correctement.
DEVSOL-1562 Générer une vue pour chaque modèle SmartDocs
Lorsque vous créez un modèle, une vue est créée par défaut pour ce modèle.
DEVSOL-1565 La modification d'une méthode SmartDocs génère une erreur fatale
Correction d'un problème qui entraînait parfois une erreur lors de la modification d'une méthode SmartDocs.
DEVSOL-1567 "Ajouter un modèle" s'affiche dans le menu administrateur supérieur
Correction du problème qui faisait que l'élément de menu "Ajouter un modèle" s'affichait dans le menu administrateur supérieur.
DEVSOL-1576 Affichage de la documentation de l'API affichant le nom du modèle, et non le nom à afficher
La page de documentation de l'API qui s'affiche lorsque vous cliquez sur "API" dans le menu affichait le nom interne du modèle au lieu du nom à afficher. Si vous passez à la version et que vous avez modifié cette vue, vous devrez la rétablir pour voir ces modifications en procédant comme suit: # Connectez-vous en tant qu'administrateur # Accédez à Structure > Vues # Cliquez sur le menu déroulant à côté de "Modifier" sur "Modèles SmartDocs" pour afficher toutes les opérations. # Si vous voyez "revert", cela signifie que vous avez écrasé le code avec votre propre modification. Cliquez sur "Annuler" pour rétablir l'état par défaut de la vue. Notez que toutes les modifications que vous avez apportées à cette vue seront supprimées.
DEVSOL-1578 Affichage des modèles Weather et Petstore lors des installations sur site
Les modèles Petstore et Weather SmartDocs sont tous deux importés sur les nouveaux sites.
DEVSOL-1584 Impossible d'acheter des forfaits
Correction du problème qui empêchait l'envoi du formulaire d'achat des forfaits de monétisation pour les versions cloud 15.05.27.00 et 15.06.08.00 si vous utilisiez le thème Apigee Responsive ou un sous-thème du thème Apigee Responsive.
DEVSOL-1597 Impossible de modifier les paramètres d'expiration du développeur
Un bug qui empêchait l'application correcte des paramètres d'expiration de la connexion Edge a été corrigé.
DEVSOL-1620

Mises à niveau du module "Moi", de l'indicateur d'environnement et des fonctionnalités
Mise à jour de sécurité modérément critique pour le module "Moi" et mises à jour de module pour l'indicateur d'environnement et les fonctionnalités. Plus d'infos :

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

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

DEVSOL-1648 Assurez-vous que la valeur de arg_separator.output est "&" pour éviter que reCAPTCHA ne soit endommagé
Un problème lié à la plate-forme qui empêchait l'utilisation de Google reCAPTCHA a été corrigé.
DEVSOL-1651 Le thème de base Apigee échoue si le module SmartDocs n'est pas activé
Le thème apigee_base ne dépend plus de l'activation du module SmartDocs.
DEVSOL-1654

Augmentation de la version d'admin_views pour appliquer un correctif de sécurité critique
Les modules contrib suivants ont été mis à jour:

  • Vues d'administration
  • Migrer
  • Rediriger
  • Redis
  • Affiche les opérations groupées