From 1f840d3282579d0b9bbfbb8319a39564c1bf45ae Mon Sep 17 00:00:00 2001 From: Snehal Kumbhar Date: Tue, 27 Mar 2018 15:03:20 +0200 Subject: [PATCH] Added extra schema info in rest api --- aiida/restapi/common/schema_custom.json | 391 ++++++++++++++++++++++++ 1 file changed, 391 insertions(+) create mode 100644 aiida/restapi/common/schema_custom.json diff --git a/aiida/restapi/common/schema_custom.json b/aiida/restapi/common/schema_custom.json new file mode 100644 index 0000000000..42068d825d --- /dev/null +++ b/aiida/restapi/common/schema_custom.json @@ -0,0 +1,391 @@ +{ + "fields": { + "description": { + "help_text": "short description of the Computer", + "display_name": "Description", + "is_display": false + }, + "enabled": { + "help_text": "True(False) if the computer is(not) enabled to run jobs", + "display_name": "Enabled", + "is_display": true + }, + "hostname": { + "help_text": "Name of the host", + "display_name": "Host", + "is_display": true + }, + "id": { + "help_text": "Id of the object", + "display_name": "Id", + "is_display": true + }, + "name": { + "help_text": "Name of the object", + "display_name": "Name", + "is_display": true + }, + "scheduler_type": { + "help_text": "Scheduler type", + "valid_choices": { + "direct": { + "doc": "Support for the direct execution bypassing schedulers." + }, + "pbsbaseclasses.PbsBaseClass": { + "doc": "Base class with support for the PBSPro scheduler" + }, + "pbspro": { + "doc": "Subclass to support the PBSPro scheduler" + }, + "sge": { + "doc": "Support for the Sun Grid Engine scheduler and its variants/forks (Son of Grid Engine, Oracle Grid Engine, ...)" + }, + "slurm": { + "doc": "Support for the SLURM scheduler (http://slurm.schedmd.com/)." + }, + "torque": { + "doc": "Subclass to support the Torque scheduler.." + } + }, + "display_name": "Scheduler", + "is_display": true + }, + "metadata": { + "help_text": "metadata of the object", + "is_display": false, + "display_name": "Metadata" + }, + "_metadata": { + "help_text": "Metadata", + "display_name": "Metadata", + "is_display": false + }, + "transport_params": { + "help_text": "Transport Parameters", + "display_name": "", + "is_display": false + }, + "transport_type": { + "help_text": "Transport Type", + "valid_choices": { + "local": { + "doc": "Support copy and command execution on the same host on which AiiDA is running via direct file copy and execution commands." + }, + "ssh": { + "doc": "Support connection, command execution and data transfer to remote computers via SSH+SFTP." + } + }, + "display_name": "Transport type", + "is_display": false + }, + "label": { + "help_text": "User-assigned label", + "display_name": "Label", + "is_display": false + }, + "type": { + "help_text": "Code type", + "display_name": "Type", + "is_display": true + }, + "uuid": { + "help_text": "Universally Unique Identifier", + "display_name": "Unique ID", + "is_display": false + }, + "ctime": { + "help_text": "Creation time of the node", + "is_display": true, + "display_name": "Creation time" + }, + "time": { + "help_text": "Creation time", + "display_name": "Creation time", + "is_display": true + }, + "mtime": { + "help_text": "Last modification time", + "display_name": "Last Modification time", + "is_display": true + }, + "state": { + "help_text": "State of the calculation", + "is_display": true, + "display_name": "State" + }, + "first_name": { + "help_text": "First name of the user", + "is_display": true, + "display_name": "First name" + }, + "last_name": { + "help_text": "Last name of the user", + "is_display": true, + "display_name": "Last name" + }, + "email": { + "help_text": "e-mail of the user", + "is_display": true, + "display_name": "email" + }, + "institution": { + "help_text": "Affiliation of the user", + "is_display": true, + "display_name": "Institution" + }, + "date_joined": { + "help_text": "Date and time of registration", + "is_display": false, + "display_name": "User since" + }, + "last_login": { + "help_text": "Date and time of the last login", + "is_display": false, + "display_name": "Last login" + }, + "is_active": { + "help_text": "True(False) if the user is active(not)", + "is_display": false, + "display_name": "Active" + }, + "user_id": { + "help_text": "Id of the user that created the node", + "is_display": false, + "display_name": "Id of creator" + }, + "user_email": { + "help_text": "Email of the user that created the node", + "is_display": true, + "display_name": "Email of creator" + }, + "attributes": { + "help_text": "Attributes of the node", + "is_display": false, + "display_name": "Attributes" + }, + "attributes.job_id": { + "help_text": "ID assigned by the job scheduler", + "is_display": false, + "display_name": "Job ID" + }, + "attributes.lat_jobinfo": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.jobresource_params": { + "help_text": "Resources used by the job", + "is_display": false, + "display_name": "Job resources" + }, + "attributes.linkname_retrieved": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.max_wallclock_seconds": { + "help_text": "Maximum wall time assigned by the scheduler", + "is_display": false, + "display_name": "Walltime (s)" + }, + "attributes.parser": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.remote_workdir": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.retrieve_list": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.retrieve_singlefile_list": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.scheduler_lastchecktime": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.state": { + "help_text": "AiiDA state of the calculation", + "is_display": true, + "display_name": "State" + }, + "attributes.scheduler_state": { + "help_text": "scheduler state for the calculation", + "is_display": false, + "display_name": "scheduler state" + }, + "attributes.append_text": { + "help_text": "", + "is_display": false, + "display_name": "Appended text" + }, + "attributes.prepend_text": { + "help_text": "", + "is_display": false, + "display_name": "Prepended text" + }, + "attributes.remote_exec_path": { + "help_text": "", + "is_display": false, + "display_name": "" + }, + "attributes.input_plugin": { + "help_text": "Name of the plugin used to interface the code to AiiDA", + "is_display": false, + "display_name": "Plugin" + }, + "attributes.is_local": { + "help_text": "True (False) if the code is run remotely (on a local computer)", + "is_display": false, + "display_name": "Local code (T/F)" + }, + "attributes.": { + "help_text": "Name of the link assigned after retrieval", + "is_display": false, + "display_name": "Linkname retrieved" + }, + "extras": { + "help_text": "Extras of the node", + "is_display": false, + "display_name": "Extras" + } + }, + "columns": { + "nodes": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "codes": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "calculations": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes.state", + "attributes", + "extras" + ], + "data": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "structures": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "kpoints": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "bands": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "upfs": [ + "id", + "label", + "type", + "ctime", + "mtime", + "uuid", + "user_id", + "user_email", + "attributes", + "extras" + ], + "groups": [ + "id", + "name", + "type", + "description", + "user_id", + "user_email", + "uuid" + ], + "computers": [ + "id", + "name", + "hostname", + "description", + "enabled", + "scheduler_type", + "transport_type", + "transport_params", + "uuid" + ], + "users": [ + "id", + "first_name", + "last_name", + "email", + "institution", + "date_joined", + "last_login", + "is_active" + ] + } +}