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

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Le mardi 8 septembre 2015, nous avons publié une version trimestrielle du portail Apigee Edge Developer Services pour le cloud privé.

L'ancien nom du produit "Apigee Edge On-premises Developer Services Portal" ou "OPDK" est désormais "Apigee Edge Developer Services Portal for Private Cloud".

Pour toute question, contactez l'assistance Apigee Edge.

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

Exigences d'Apigee Edge pour le portail

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

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 :

  • Prise en charge de Swagger 2.0, y compris l'importation par fichier ou URL, et prise en charge des objets de sécurité personnalisés.
  • Améliorations de la conception visuelle dans les modèles qui génèrent 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 "security" 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 la documentation SmartDocs, consultez Utiliser SmartDocs pour documenter les API.

Processus de mise à niveau de SmartDocs

Si vous avez déjà utilisé SmartDocs pendant la période bêta, les nouvelles fonctionnalités de la version en disponibilité générale nécessitent que vous mettiez à niveau SmartDocs dans votre portail de développeur.

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

N'oubliez pas que, même si vous pouvez afficher et publier des documents 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 d'API Edge d'Apigee. Toutes les modifications que vous apportez à un modèle d'API dans Edge sont les mêmes dans tous vos environnements Pantheon (comme les développeurs dans les environnements Pantheon).

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

  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 avez utilisé.
    • 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 et 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 tous les modèles personnalisés pour utiliser 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 les modèles SmartDocs, consultez Utiliser SmartDocs pour documenter les API.
  6. Rendez à nouveau votre révision de modèle et publiez-la.
  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 du jour dans la section "Monétisation" doit être configurable par les administrateurs
Le format de la date est désormais configurable dans la section "Monétisation", sous les paramètres de monétisation, pour les formats de date européens et américains.
DEVSOL-584 Paramètre de chemin d'accès non mémorisé lors de la première utilisation
Le paramètre de chemin d'accès n'était pas toujours mémorisé lors des appels.
DEVSOL-603 La page "Plan en conflit" est mal mise en forme
Lorsque vous achetez un forfait qui chevauche un forfait existant, la page affichée est désormais mise en forme correctement 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 à partir de SmartDocs après la suppression du 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 Rendre les adresses e-mail des utilisateurs du portail des développeurs 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 N'activez pas 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", "Dev Connect Mint" s'affiche deux fois. Ce problème est désormais résolu.
DEVSOL-1313 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 Modifier l'emplacement du menu "Admin" de SmartDocs
SmartDocs se trouve désormais dans le menu "Contenu", et les paramètres SmartDocs se trouvent dans le menu "Admin" des paramètres.
DEVSOL-1340 Supprimer la version bêta lors du passage à la version GA
DEVSOL-1390

La bibliothèque Edge du SDK PHP a été mise à jour pour corriger le problème d'appel de __toString()
La bibliothèque Edge du SDK PHP a été mise à jour pour corriger le problème d'appel de __toString() sur l'objet DeveloperRatePlan qui crée cette erreur :

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

Il s'agit d'un bug qui n'affecte que les clients de la monétisation avec un 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 de disposer d'un exemple plus exhaustif d'utilisation de SmartDocs.
DEVSOL-1407 Échec de Cron lorsqu'il y a de nombreux développeurs
Lors de l'exécution de Drupal Cron, un grand nombre de développeurs provoquait un problème de délai d'attente. Lorsqu'une organisation compte plus de 200 utilisateurs, un processus par lot est désormais utilisé.
DEVSOL-1410 Les erreurs de connexion ne sont pas apparentes lors de l'installation du portail des développeurs
Des messages d'erreur plus clairs ont été ajoutés au programme d'installation lorsque la connexion à la gestion Edge ne fonctionne pas, afin de minimiser les problèmes de dépannage.
DEVSOL-1422 Supprimer le formulaire de configuration SMTP du profil Apigee
Le processus d'installation ne vous demande plus si vous souhaitez configurer SMTP. Vous pouvez le faire une fois l'installation terminée, en suivant la procédure Drupal standard qui consiste à activer le module SMTP et à le configurer correctement.
DEVSOL-1427

Ajouter des hooks au module "Applications pour les développeurs Devconnect" pour permettre la modification des données analytiques
Le module devconnect_developer_apps fournit désormais trois nouveaux hooks :

# hook_devconnect_developer_apps_analytics_chart_data_alter()

# hook_devconnect_developer_app_analytics_datapoints_params_alter()

# hook_devconnect_developer_app_analytics_datapoints_alter()

Elles 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 pour un modèle
Lorsqu'un schéma de sécurité est supprimé, une case à cocher permet de sélectionner si le schéma d'authentification du modèle associé doit également être supprimé.
DEVSOL-1470 Créer un lien de menu "API" et la vue correspondante
Le portail des développeurs SmartDocs est désormais fourni par défaut avec un lien vers la documentation SmartDocs affichée dans le menu principal, nommé "API", qui renvoie à tous les modèles avec des méthodes publiées.
DEVSOL-1486 Les appels SmartDocs peuvent s'authentifier avec une clé prédéfinie.
Permet l'authentification avec des clés API préfournies et fournies par l'utilisateur.
DEVSOL-1499 Code HTML non 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 la méthode "Ajouter"
Vous pouvez désormais ajouter plusieurs paramètres à une API SmartDocs lorsque vous modifiez la méthode.
DEVSOL-1509 Vous ne voyez pas comment modifier le champ "Exemple" pour une API SmartDocs
Vous pouvez désormais définir les champs "Type MIME du corps", "Documentation du corps" et "Exemple de 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 la 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 pour lesquels la monétisation est activée, le bouton "Annuler" n'a jamais été affiché pour un forfait dont la date de début est future.
DEVSOL-1556 Ancienne version des modules Drupal en cours d'expédition
Les modules media_youtube et features ont été mis à jour vers la dernière version.
DEVSOL-1558 Les pages de méthodes SmartDocs ne s'affichent pas pour l'exemple PetStore
Lors des nouvelles installations, les méthodes SmartDocs PetStore s'affichent désormais correctement.
DEVSOL-1562 Générez une vue pour chaque modèle Smart Docs.
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 L'option "Ajouter un modèle" s'affiche dans le menu d'administration supérieur
Correction du problème qui faisait que l'option de menu "Ajouter un modèle" s'affichait dans le menu d'administration supérieur.
DEVSOL-1576 La vue de la documentation de l'API affiche le nom du modèle, et non son nom à afficher
La page de documentation de l'API qui s'affiche lorsque vous cliquez sur "API" dans le menu indiquait le nom interne du modèle au lieu de son nom à afficher. Si vous effectuez une mise à jour vers cette version et que vous avez modifié cette vue, vous devrez la rétablir pour voir ces modifications. Pour ce faire : # 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 "Rétablir" pour rétablir l'état par défaut de la vue. Notez que cela supprimera toutes les modifications que vous avez apportées à cette vue.
DEVSOL-1578 Afficher les modèles Weather et Petstore sur les installations de site
Les modèles SmartDocs Petstore et Weather sont importés sur les nouveaux sites.
DEVSOL-1584 Impossible d'acheter des forfaits
Correction d'un problème qui empêchait l'envoi du formulaire d'achat de forfaits de monétisation pour la version 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 de délai avant expiration du développeur
Un bug qui empêchait l'application correcte des paramètres de délai avant 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é de niveau critique modéré 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 arg_separator.output est défini sur "&" pour éviter que reCAPTCHA ne soit interrompu.
Un problème lié à la plate-forme qui empêchait l'utilisation de Google reCAPTCHA a été résolu.
DEVSOL-1651 Échec du thème de base Apigee si le module SmartDocs n'est pas activé
Le thème de base Apigee ne dépend plus de l'activation du module SmartDocs.
DEVSOL-1654

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

  • Vues administratives
  • Migrer
  • Redirection
  • Redis
  • Afficher les opérations groupées