Commit e10c743b authored by Daniel Dehennin's avatar Daniel Dehennin
Browse files

Import API v1

parent cb2ae6a8
---
uri: server.salt.registered
sampleuse: ~
description: |
Notify server peering
pattern: event
parameters:
serverid:
type: Number
description: server uid
public: false
domain: server-domain
---
uri: server.storage.event
sampleuse: ~
description: |
Notifie l'ajout/suppression/modification d'un fichier dans le container minio
pattern: event
parameters:
key:
type: String
description: chemin du fichier stocké (<bucket>/<objet>)
event_type:
type: String
description: "type d'évènement remonté (s3:ObjectCreated:Put, s3:ObjectRemoved:Delete)"
public: false
domain: server-domain
---
uri: server.update
description: |
Updates a server
public: true
sampleuse: |
zephir-client server.update '{"serverid":1,"servername":"toto", "serverdescription": "server description"}'
pattern: rpc
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: |
Server identifier
servername:
type: String
description: |
New server name
serverdescription:
type: String
description: |
Server description
response:
type: Server
description: Description du serveur mis à jour.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
- uri: server.error.servername-not-provided
related:
- servermodel.list
- servermodel.describe
- servermodel.create
- servermodel.delete
---
uri: server.updated
sampleuse: ~
description: |
Updated server message
pattern: event
public: false
domain: server-domain
parameters:
serverid:
type: Number
description: |
Server model identifier
---
uri: servermodel.applicationservice.join
description: |
Associe un service applicatif à un modèle de serveur.
sampleuse: |
zephir-client servermodel.applicationservice.join '{"parameters":{"servermodelparentid":1,"servermodelname":"MonServeurModele","servermodeldescription":"Ma description","sourceid":1}}'
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelid:
type: Number
description: |
Identifiant du modèle de serveur.
applicationserviceid:
type: Number
description: |
Identifiant du service applicatif.
response:
type: Boolean
description: Status de l'association.
---
uri: servermodel.applicationservice.list
description: |
Retourne la liste des applications service.
sampleuse: |
zephir-client -d'{}' servermodel.applicationservice.list
pattern: rpc
public: true
domain: servermodel-domain
parameters:
subreleaseid:
type: Number
description: |
Identifiant de la release.
response:
type: '[]Dict'
description: Liste des applications service disponibles.
---
uri: servermodel.create.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: servermodel-domain
---
uri: servermodel.create.error.duplicate_servermodel
sampleuse: ~
description: |
La combinaison nom/source/version/release existe déjà.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.create.error.invalid_parentservermodel_id
sampleuse: ~
description: |
L'identifiant ServerModelId du parent n'est pas un entier.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.create.error.invalid_source_id
sampleuse: ~
description: |
L'identifiant ServerModelSourceId n'est pas un entier.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.create.error.servermodelname_not_provided
sampleuse: ~
description: |
Le servermodelname n'est pas fourni.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.create.error.unknown_parentservermodel_id
sampleuse: ~
description: |
L'identifiant ServerModelId du parent ne correspond a aucun enregistrement dans la base.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.create.error.unknown_parentservermodel_id
sampleuse: ~
description: |
L'identifiant SourceId ne correspond a aucun enregistrement dans la base.
public: true
pattern: error
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.create
description: |
Créer un modèle de serveur.
sampleuse: |
zephir-client servermodel.create '{"servermodelparentid":1,"servermodelname":"MonServeurModele","servermodeldescription":"Ma description","sourceid":1}'
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelparentid:
type: Number
ref: Servermodel.ServermodelId
description: |
Identifiant du modèle de serveur parent auquel rattacher le nouveau modèle.
servermodelname:
type: String
description: |
Nom du modèle de serveur à créer.
servermodeldescription:
type: String
description: |
Nom du modèle de serveur à créer.
sourceid:
type: Number
ref: Servermodel.SourceId
description: |
Identifiant de la source.
response:
type: Servermodel
description: Informations sur le modèle de serveur créées.
errors:
- uri: servermodel.create.error.database_not_available
- uri: servermodel.create.error.duplicate_servermodel
- uri: servermodel.create.error.invalid_parentservermodel_id
- uri: servermodel.create.error.invalid_source_id
- uri: servermodel.create.error.unknown_parentservermodel_id
- uri: servermodel.create.error.unknown_source_id
- uri: servermodel.create.error.servermodelname_not_provided
related:
- servermodel.list
- servermodel.describe
- servermodel.update
- servermodel.delete
- servermodel.event
---
uri: servermodel.created
description: Un modèle de serveur a été créé.
pattern: event
public: false
domain: servermodel-domain
parameters:
type: Servermodel
description: Informations sur le modèle de serveur créées.
---
uri: servermodel.delete.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: servermodel-domain
---
uri: servermodel.delete.error.dependency_lock
sampleuse: ~
public: true
pattern: error
description: |
Ce modèle de serveur est parent d'autres modèles.
parameters:
reason:
type: String
description: |
Description supplémentaire des causes de l'erreur
domain: servermodel-domain
---
uri: servermodel.delete.error.database_not_available
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
---
uri: servermodel.delete.error.database_not_available
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
---
uri: servermodel.delete
description: |
Demande la suppression d'un modèle de serveur
sampleuse: |
zephir-client servermodel.delete '{"servermodelid":1}'
pattern: rpc
public: true
domain: servermodel-domain
parameters:
servermodelid:
type: Number
description: |
Identifiant du modèle de serveur à supprimer
response:
type: Servermodel
description: Modèle de serveur supprimé.
errors:
- uri: servermodel.delete.error.database_not_available
- uri: servermodel.delete.error.invalid_servermodel_id
- uri: servermodel.delete.error.unknown_servermodel_id
- uri: servermodel.delete.error.dependency_lock
related:
- servermodel.list
- servermodel.describe
- servermodel.create
- servermodel.update
- servermodel.event
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment