Import API v1

messages/v1/messages/servermodel.describe.error.database_not_available.yml

+---
+uri: servermodel.describe.error.database_not_available
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  Erreur retournée lorsque la base de données n'est pas disponible.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.describe.error.invalid_servermodel_id.yml

+---
+uri: servermodel.describe.error.invalid_servermodel_id
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  L'argument ServerModelId fourni n'est pas du type Integer
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.describe.error.unknown_servermodel_id.yml

+---
+uri: servermodel.describe.error.unknown_servermodel_id
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  L'identifiant ServerModelId ne correspond a aucun enregistrement dans la base.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.describe.yml

+---
+uri: servermodel.describe
+
+description: |
+  Retourne les attributs détaillées d'un modèle de serveur.
+
+sampleuse: |
+  zephir-client servermodel.describe '{"servermodelid": 1, "inheritance": false}'
+
+pattern: rpc
+
+public: true
+
+domain: servermodel-domain
+
+parameters:
+  servermodelid:
+    type: Number
+    description: Identifiant du modèle de serveur à récupérer.
+    ref: Servermodel.ServermodelId
+  inheritance:
+    type: Boolean
+    description: Inclure les données héritées des modèles de serveur parents.
+    default: true
+  resolvdepends:
+    type: Boolean
+    description: Résoudre les dépendances de services
+    default: true
+  schema:
+    type: Boolean
+    description: Inclure le schema de configuration (reaggrege les donnees provenant du datasource).
+    default: false
+  probes:
+    type: Boolean
+    description: Inclure les informations sur les sondes de la configuration.
+    default: false
+
+response:
+  type: ServermodelDescribe
+  description: Description du modèle de serveur.
+
+errors:
+  - uri: servermodel.describe.error.database_not_available
+  - uri: servermodel.describe.error.invalid_servermodel_id
+  - uri: servermodel.describe.error.unknown_servermodel_id
+
+related:
+  - servermodel.list
+  - servermodel.create
+  - servermodel.update
+  - servermodel.delete
+  - servermodel.event

messages/v1/messages/servermodel.event.yml

+---
+uri: servermodel.event
+
+sampleuse: ~
+
+description: |
+  Notifie l'ajout/suppression/modification/liste/description d'un modèle de serveur
+
+pattern: event
+
+parameters:
+  method:
+    type: String
+    description: |
+      Méthode utilisée parmis : list / describe / create / update / delete
+  parameters:
+    type: Dict
+    description: |
+      list => non requis
+      describe => servermodelid: Integer
+      create => servermodelparentid: Integer
+                servermodelname: String
+                sourceid: Integer
+      update => servermodelid: Integer
+                servermodelname: String
+      delete => servermodelid: Integer
+  result:
+    type: String
+    description: |
+      list => non requis
+      describe => non requis
+      create => Integer
+      update => String
+      delete => String
+
+public: false
+
+domain: server-domain
+
+related:
+  - servermodel.list
+  - servermodel.describe
+  - servermodel.create
+  - servermodel.update
+  - servermodel.delete

messages/v1/messages/servermodel.list.error.database_not_available.yml

+---
+uri: servermodel.list.error.database_not_available
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  Erreur retournée lorsque la base de données n'est pas disponible.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.list.yml

+---
+uri: servermodel.list
+
+description: |
+  Retourne la liste des modèles de serveur disponibles.
+
+sampleuse: |
+  zephir-client servermodel.list
+
+pattern: rpc
+
+public: true
+
+domain: servermodel-domain
+
+response:
+  type: '[]Servermodel'
+  description: Liste des modèles de serveur disponibles.
+
+errors:
+  - uri: servermodel.list.error.database_not_available
+
+related:
+  - servermodel.describe
+  - servermodel.create
+  - servermodel.update
+  - servermodel.delete
+  - servermodel.event

messages/v1/messages/servermodel.source.list.yml

+---
+uri: servermodel.source.list
+
+description: |
+  Retourne la liste des sources.
+
+sampleuse: |
+  zephir-client -d'{}' servermodel.source.list
+
+pattern: rpc
+
+public: true
+
+domain: servermodel-domain
+
+response:
+  type: '[]Dict'
+  description: Liste des sources disponibles.

messages/v1/messages/servermodel.subrelease.list.yml

+---
+uri: servermodel.subrelease.list
+
+description: |
+  Retourne la liste des subreleases.
+
+sampleuse: |
+  zephir-client -d'{}' servermodel.subrelease.list
+
+pattern: rpc
+
+public: true
+
+domain: servermodel-domain
+
+response:
+  type: '[]Dict'
+  description: Liste des sous-releases disponibles.

messages/v1/messages/servermodel.update.error.database_not_available.yml

+---
+uri: servermodel.update.error.database_not_available
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  Erreur retournée lorsque la base de données n'est pas disponible.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.update.error.duplicate_servermodel.yml

+---
+uri: servermodel.update.error.duplicate_servermodel
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  La combinaison nom/source/version/release existe déjà.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.update.error.invalid_servermodel_id.yml

+---
+uri: servermodel.update.error.invalid_servermodel_id
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  L'argument ServerModelId fourni n'est pas du type Integer
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.update.error.servermodelname_not_provided.yml

+---
+uri: servermodel.update.error.servermodelname_not_provided
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  Le servermodelname n'est pas fourni.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.update.error.unknown_servermodel_id.yml

+---
+uri: servermodel.update.error.unknown_servermodel_id
+
+sampleuse: ~
+
+public: true
+
+pattern: error
+
+description: |
+  L'identifiant ServerModelId ne correspond a aucun enregistrement dans la base.
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: servermodel-domain

messages/v1/messages/servermodel.update.yml

+---
+uri: servermodel.update
+
+description: |
+  Demande la mise à jour d'un modèle de serveur.
+
+sampleuse: |
+  zephir-client servermodel.update '{"servermodelid":1,"servermodelname":"toto"}'
+
+pattern: rpc
+
+public: true
+
+domain: servermodel-domain
+
+parameters:
+  servermodelid:
+    type: Number
+    description: |
+      Identifiant du modèle de serveur à modifier.
+  servermodelname:
+    type: String
+    description: |
+      Le nouveau nom à attribuer au modèle de serveur.
+
+response:
+  type: Servermodel
+  description: Modèle de serveur avec ses attributs détaillés.
+
+errors:
+  - uri: servermodel.update.error.database_not_available
+  - uri: servermodel.update.error.invalid_servermodel_id
+  - uri: servermodel.update.error.unknown_servermodel_id
+  - uri: servermodel.update.error.duplicate_servermodel
+  - uri: servermodel.update.error.servermodelname_not_provided
+
+related:
+  - servermodel.list
+  - servermodel.describe
+  - servermodel.create
+  - servermodel.delete
+  - servermodel.event

messages/v1/messages/vault.database.create.yml

+---
+uri: vault.database.create
+
+description: |
+  Demander les paramètres d’accès à une base de donnée.
+
+sampleuse: |
+  zephir-client vault.database.create '{"name":"DatabaseName"}'
+
+pattern: rpc
+
+public: false
+
+domain: vault-domain
+
+parameters:
+  name:
+    type: String
+    description: |
+      Nom de la base de données pour laquelle les accès sont sollicités.
+  persistent:
+    type: Boolean 
+    description: L'utilisateur est persistant
+    default: false
+
+response:
+  type: Boolean
+  description: La base a été créée.

messages/v1/messages/vault.database.get.yml

+---
+uri: vault.database.get
+
+description: |
+  Demander les paramètres d’accès à une base de donnée.
+
+sampleuse: |
+  zephir-client vault.database.get '{"name":"DatabaseName"}'
+
+pattern: rpc
+
+public: false
+
+domain: vault-domain
+
+parameters:
+  name:
+    type: String
+    description: |
+      Nom de la base de données pour laquelle les accès sont sollicités.
+  persistent:
+    type: Boolean 
+    description: L'utilisateur est persistant
+    default: false
+
+response:
+  type: VaultDatabase
+  description: Informations sur la base.

messages/v1/messages/vault.error.database_not_available.yml

+---
+uri: vault.error.database_not_available
+
+sampleuse: ~
+
+description: |
+  Erreur retournée lorsque la base de données n'est pas disponible.
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: |
+      Description supplémentaire des causes de l'erreur
+
+domain: vault-domain

messages/v1/messages/vault.error.secret-not-available.yml

+---
+uri: vault.error.secret-not-available
+
+sampleuse: ~
+
+description: |
+  No available secret
+
+public: true
+
+pattern: error
+
+parameters:
+  reason:
+    type: String
+    description: human readable error message
+
+domain: vault-domain
+
+related:
+  - vault.secret.get

messages/v1/messages/vault.secret.get.yml

+---
+uri: vault.secret.get
+
+description: |
+  Accès à un secret.
+
+sampleuse: |
+  zephir-client vault.secret.get '{"secretkey":"MySecretKey"}'
+
+pattern: rpc
+
+public: false
+
+domain: vault-domain
+
+parameters:
+  secretkey:
+    type: String
+    ref: Vault.SecretKey
+    description: Nom du secret.
+
+response:
+  type: Dict
+  description: Contenu du secret.
+
+errors:
+  - uri: vault.error.secret-not-available