Lisez-moi

Important :

Nous prévoyons de mettre à niveau la version Orchestrator Swagger vers Swagger 3.0. Les API Orchestrator sont actuellement définies à l’aide de Swagger 2.0.

Ne vous inquiétez pas de la rétrocompatibilité avec vos clients API existants : nous veillerons à ce que l'API reste compatible.

Nous vous recommandons d’utiliser vos clients précédents, car les modifications JSON ne les modifient pas, grâce à la rétrocompatibilité de notre structure de requête.

Après la mise à jour vers Swagger 3.0, il sera nécessaire de réajuster en fonction de la nouvelle définition JSON l’ensemble des clients API à nouveau générés.

Si vous prévoyez d'intégrer nos API à votre client, vous devez être conscient des mises à jour et des modifications possibles qui peuvent survenir à la définition Swagger, aux schémas JSON ou aux points de terminaison d'API.

La liste ci-dessous fournit des informations et des recommandations concernant les modifications apportées à Swagger. Si vous avez d'autres questions, contactez notre équipe d'assistance.

Informations et recommandations sur les modifications apportées à Swagger

1. La description de l'API JSON représentée dans le document Swagger JSON peut changer à tout moment. Cependant, il décrira la même API sous-jacente, pour assurer la rétrocompatibilité.
2. L'interface Swagger et le JSON correspondant sont générés en fonction des points de terminaison actuels, et nous publions toujours la dernière version. Pour garantir la rétrocompatibilité, nous prenons en charge la même structure de requête.
3. Comme alternative aux clients API générés au runtime, utilisez des clients API à temps fixe ou à temps de compilation. Cela réduit la dépendance et empêche les mises à jour d'automatisation majeures en cas de modification de l'API ou de la définition Swagger.
4. Les éléments marqués comme obsolètes sont disponibles pendant une durée limitée, après quoi les éléments sont supprimés de la définition Swagger et de l'API JSON.
5. Chaque fois que certaines API changent en interne, une nouvelle version de l'API Swagger est publiée. Le numéro de version de l'API n'influence pas l'utilisation de l'API cliente. Nous vous déconseillons de vous fier à la gestion des versions de l’API.

Exemples d'API

Les exemples fournis dans le document de référence Orchestrator existant décrivent des scénarios et des points de terminaison complexes.

Vous pouvez voir toutes les API disponibles dans le Swagger JSON, qui contient les dernières mises à jour.