Skip to content
Snippets Groups Projects
mock_api.json 4.22 KiB
Newer Older
Matthieu Lamalle's avatar
Matthieu Lamalle committed
{
	"server.create": {
		"description": ":      Créer un serveur.",
		"sampleuse": "zephir-client server.create '{\"servername\":\"MonJoliServeur\", \"serverdescription\": \"un bien joli serveur\", \"servermodelid\":1, \"serverpassphrase\": \"MyPassPhrase\"}'\n",
		"pattern": "rpc",
		"public": true,
		"domain": "server-domain",
		"parameters": {
			"servername": {
				"type": "String",
				"description": "Nom du serveur.\n"
			},
			"serverdescription": {
				"type": "String",
				"description": "Description du serveur.\n"
			},
			"servermodelid": {
				"type": "Number",
				"ref": "Servermodel.ServermodelId",
				"description": "ID du modèle de serveur.\n"
			},
			"serverpassphrase": {
				"type": "String",
				"description": "Phrase secrète de la clef privé.\n"
			}
		},
		"response": {
			"type": "Server",
			"description": "Description du serveur créé."
		},
		"errors": [
			{
				"uri": "server.error.database-not-available"
			},
			{
				"uri": "server.error.db-connection"
			},
			{
				"uri": "server.error.invalid-servermodel-id"
			},
			{
				"uri": "server.error.unknown-servermodel-id"
			},
			{
				"uri": "server.error.servername-not-provided"
			}
		],
		"related": [
			"server.list",
			"server.describe",
			"server.update",
			"server.delete"
		]
	},
	"server.describe": {
		"description": "Retourne les attributs détaillées d’un serveur.\n",
		"sampleuse": "zephir-client server.describe '{\"serverid\":1}'\n",
		"pattern": "rpc",
		"public": true,
		"domain": "server-domain",
		"parameters": {
			"serverid": {
				"type": "Number",
				"ref": "Server.ServerId",
				"description": "Identifiant du serveur."
			},
			"configuration": {
				"type": "Boolean",
				"description": "Inclure les valeurs de configuration.",
				"default": false
			}
		},
		"response": {
			"type": "ServerDescribe",
			"description": "Description du serveur."
		},
		"errors": [
			{
				"uri": "server.error.database-not-available"
			},
			{
				"uri": "server.error.db-connection"
			},
			{
				"uri": "server.error.invalid-server-id"
			},
			{
				"uri": "server.error.unknown-server-id"
			}
		],
		"related": [
			"server.list",
			"server.create",
			"server.update",
			"server.delete"
		]
	},
	"server.delete": {
		"description": "Supprimer un serveur.\n",
		"public": true,
		"pattern": "rpc",
		"domain": "server-domain",
		"sampleuse": "zephir-client server.delete '{\"serverid\":1}'\n",
		"parameters": {
			"serverid": {
				"type": "Number",
				"ref": "Server.ServerId",
				"description": "ID du serveur.\n"
			}
		},
		"response": {
			"type": "Server",
			"description": "Description du serveur supprimé."
		},
		"errors": [
			{
				"uri": "server.error.database-not-available"
			},
			{
				"uri": "server.error.db-connection"
			},
			{
				"uri": "server.error.invalid-server-id"
			},
			{
				"uri": "server.error.unknown-server-id"
			}
		],
		"related": [
			"server.list",
			"server.describe",
			"server.create",
			"server.update"
		]
	},
	"config.session.server.list": {
		"description": "Liste les sessions de configuration des serveurs.\n",
		"sampleuse": "zephir-client config.session.server.list\n",
		"pattern": "rpc",
		"public": true,
		"domain": "config-domain",
		"response": {
			"type": "[]ConfigSession",
			"description": "Liste des sessions.\n"
		}
	},
	"config.session.server.start": {
		"description": "Démarrer une session de configuration pour un serveur.\n",
		"sampleuse": "zephir-client config.session.server.start '{\"id\":2}'\n",
		"pattern": "rpc",
		"public": true,
		"domain": "config-domain",
		"parameters": {
			"id": {
				"type": "Number",
				"ref": "Server.ServerId",
				"description": "Id de la configuration\n"
			}
		},
		"response": {
			"type": "ConfigSession",
			"description": "Description de la session."
		}
	},
	"config.session.server.stop": {
		"description": "Termine une session de configuration d'un serveur.\n",
		"sampleuse": "zephir-client config.session.server.stop '{\"sessionid\":\"xxxxx\"}'\n",
		"pattern": "rpc",
		"public": true,
		"domain": "config-domain",
		"parameters": {
			"sessionid": {
				"ref": "Config.SessionId",
				"type": "String",
				"description": "Id de la session."
			}
		},
		"response": {
			"type": "ConfigSession",
			"description": "Description de la session."
		}
	}
}