diff --git a/api-ref/source/v1/actions-v1.inc b/api-ref/source/v1/actions-v1.inc index c0c6a358..0a26c67e 100644 --- a/api-ref/source/v1/actions-v1.inc +++ b/api-ref/source/v1/actions-v1.inc @@ -30,6 +30,7 @@ Query Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -39,6 +40,12 @@ Response Parameters - actions: actions +Request Example +--------------- + +.. literalinclude:: samples/actions-list-request.json + :language: javascript + Response Example ---------------- @@ -222,4 +229,4 @@ Query Parameters - action_id: action_id_path -There is no response for this operation. \ No newline at end of file +There is no response for this operation. diff --git a/api-ref/source/v1/backups-v1.inc b/api-ref/source/v1/backups-v1.inc index 0f99c31d..dc713f59 100644 --- a/api-ref/source/v1/backups-v1.inc +++ b/api-ref/source/v1/backups-v1.inc @@ -28,6 +28,7 @@ Query Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -37,6 +38,12 @@ Response Parameters - backups: backups +Request Example +--------------- + +.. literalinclude:: samples/backup-list-request.json + :language: javascript + Response Example ---------------- diff --git a/api-ref/source/v1/clients-v1.inc b/api-ref/source/v1/clients-v1.inc index 5fc36744..46b82f6a 100644 --- a/api-ref/source/v1/clients-v1.inc +++ b/api-ref/source/v1/clients-v1.inc @@ -29,6 +29,7 @@ Query Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -38,6 +39,12 @@ Response Parameters - clients: clients +Request Example +--------------- + +.. literalinclude:: samples/clients-list-request.json + :language: javascript + Response Example ---------------- diff --git a/api-ref/source/v1/jobs-v1.inc b/api-ref/source/v1/jobs-v1.inc index bfd4d1cd..41d43dbd 100644 --- a/api-ref/source/v1/jobs-v1.inc +++ b/api-ref/source/v1/jobs-v1.inc @@ -29,6 +29,7 @@ Query Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -38,6 +39,12 @@ Response Parameters - jobs: jobs +Request Example +--------------- + +.. literalinclude:: samples/jobs-list-request.json + :language: javascript + Response Example ---------------- diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index 0ce67ecb..3d45097b 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -174,6 +174,15 @@ result: description: | A string represents if the operation was successful ``success`` or failed. +search_option: + type: dict + in: body + required: false + description: | + The query option of list. It is a JSON structure. It contains the keywords + ``match``, ``match_not``, or one of the two. The values about keys + ``match`` and ``match_not`` are a list of {key, value}. + session_description: type: string in: body diff --git a/api-ref/source/v1/samples/actions-list-request.json b/api-ref/source/v1/samples/actions-list-request.json new file mode 100644 index 00000000..0c3dd219 --- /dev/null +++ b/api-ref/source/v1/samples/actions-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "max_retries": 20 + } + ], + "match": [ + { + "backup_name": "test0001_backup" + } + ] +} diff --git a/api-ref/source/v1/samples/backup-list-request.json b/api-ref/source/v1/samples/backup-list-request.json new file mode 100644 index 00000000..d843a524 --- /dev/null +++ b/api-ref/source/v1/samples/backup-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "storage": "ftps" + } + ], + "match": [ + { + "backup_name": "freezer_mysql_backup" + } + ] +} diff --git a/api-ref/source/v1/samples/clients-list-request.json b/api-ref/source/v1/samples/clients-list-request.json new file mode 100644 index 00000000..c4895f52 --- /dev/null +++ b/api-ref/source/v1/samples/clients-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "client_id": "tecs_node1" + } + ], + "match": [ + { + "user_id":"0cd44caf6db5486b94a04b33256a5ff4" + } + ] +} diff --git a/api-ref/source/v1/samples/jobs-list-request.json b/api-ref/source/v1/samples/jobs-list-request.json new file mode 100644 index 00000000..f0f3df5b --- /dev/null +++ b/api-ref/source/v1/samples/jobs-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "schedule_interval": "10 days" + } + ], + "match": [ + { + "client_id": "752d8bd43d654e7a840bbfda77ce41af_szaher" + } + ] +} diff --git a/api-ref/source/v1/samples/sessions-list-request.json b/api-ref/source/v1/samples/sessions-list-request.json new file mode 100644 index 00000000..84249dfb --- /dev/null +++ b/api-ref/source/v1/samples/sessions-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "schedule_interval": "10 days" + } + ], + "match": [ + { + "hold_off": 50 + } + ] +} diff --git a/api-ref/source/v1/sessions-v1.inc b/api-ref/source/v1/sessions-v1.inc index b3a81d36..f6fd9e5e 100644 --- a/api-ref/source/v1/sessions-v1.inc +++ b/api-ref/source/v1/sessions-v1.inc @@ -37,6 +37,7 @@ Query Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -46,6 +47,12 @@ Response Parameters - sessions: sessions +Request Example +--------------- + +.. literalinclude:: samples/sessions-list-request.json + :language: javascript + Response Example ---------------- diff --git a/api-ref/source/v2/actions-v2.inc b/api-ref/source/v2/actions-v2.inc index c35dee86..1352e5c3 100644 --- a/api-ref/source/v2/actions-v2.inc +++ b/api-ref/source/v2/actions-v2.inc @@ -38,6 +38,7 @@ Request Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -47,6 +48,12 @@ Response Parameters - actions: actions +Request Example +--------------- + +.. literalinclude:: samples/actions-list-request.json + :language: javascript + Response Example ---------------- @@ -242,4 +249,4 @@ Query Parameters - project_id: project_id_path - action_id: action_id_path -There is no response for this operation. \ No newline at end of file +There is no response for this operation. diff --git a/api-ref/source/v2/backups-v2.inc b/api-ref/source/v2/backups-v2.inc index fb48f5ff..b0babdc7 100644 --- a/api-ref/source/v2/backups-v2.inc +++ b/api-ref/source/v2/backups-v2.inc @@ -38,6 +38,7 @@ Request Parameters - limit: limit - marker: marker + - search: search_option Response Parameters ------------------- @@ -47,6 +48,12 @@ Response Parameters - backups: backups +Request Example +--------------- + +.. literalinclude:: samples/backup-list-request.json + :language: javascript + Response Example ---------------- @@ -122,4 +129,4 @@ Query Parameters - project_id: project_id_path - backup_id: backup_id_path -There is no response for this operation. \ No newline at end of file +There is no response for this operation. diff --git a/api-ref/source/v2/clients-v2.inc b/api-ref/source/v2/clients-v2.inc index a94f715a..eb982706 100644 --- a/api-ref/source/v2/clients-v2.inc +++ b/api-ref/source/v2/clients-v2.inc @@ -37,6 +37,7 @@ Request Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -46,6 +47,12 @@ Response Parameters - clients: clients +Request Example +--------------- + +.. literalinclude:: samples/clients-list-request.json + :language: javascript + Response Example ---------------- diff --git a/api-ref/source/v2/jobs-v2.inc b/api-ref/source/v2/jobs-v2.inc index f851acfe..2142f6e7 100644 --- a/api-ref/source/v2/jobs-v2.inc +++ b/api-ref/source/v2/jobs-v2.inc @@ -37,6 +37,8 @@ Request Parameters - limit: limit - offset: marker + - search: search_option + Response Parameters ------------------- @@ -46,6 +48,13 @@ Response Parameters - jobs: jobs +Request Example +--------------- + +.. literalinclude:: samples/jobs-list-request.json + :language: javascript + + Response Example ---------------- diff --git a/api-ref/source/v2/parameters.yaml b/api-ref/source/v2/parameters.yaml index 9e19b1c7..e4b0fb86 100644 --- a/api-ref/source/v2/parameters.yaml +++ b/api-ref/source/v2/parameters.yaml @@ -190,6 +190,15 @@ result: description: | A string represents if the operation was successful ``success`` or failed. +search_option: + type: dict + in: body + required: false + description: | + The query option of list. It is a JSON structure. It contains the keywords + ``match``, ``match_not``, or one of the two. The values about keys + ``match`` and ``match_not`` are a list of {key, value}. + session_description: type: string in: body diff --git a/api-ref/source/v2/samples/actions-list-request.json b/api-ref/source/v2/samples/actions-list-request.json new file mode 100644 index 00000000..0c3dd219 --- /dev/null +++ b/api-ref/source/v2/samples/actions-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "max_retries": 20 + } + ], + "match": [ + { + "backup_name": "test0001_backup" + } + ] +} diff --git a/api-ref/source/v2/samples/backup-list-request.json b/api-ref/source/v2/samples/backup-list-request.json new file mode 100644 index 00000000..d843a524 --- /dev/null +++ b/api-ref/source/v2/samples/backup-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "storage": "ftps" + } + ], + "match": [ + { + "backup_name": "freezer_mysql_backup" + } + ] +} diff --git a/api-ref/source/v2/samples/clients-list-request.json b/api-ref/source/v2/samples/clients-list-request.json new file mode 100644 index 00000000..c4895f52 --- /dev/null +++ b/api-ref/source/v2/samples/clients-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "client_id": "tecs_node1" + } + ], + "match": [ + { + "user_id":"0cd44caf6db5486b94a04b33256a5ff4" + } + ] +} diff --git a/api-ref/source/v2/samples/jobs-list-request.json b/api-ref/source/v2/samples/jobs-list-request.json new file mode 100644 index 00000000..f0f3df5b --- /dev/null +++ b/api-ref/source/v2/samples/jobs-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "schedule_interval": "10 days" + } + ], + "match": [ + { + "client_id": "752d8bd43d654e7a840bbfda77ce41af_szaher" + } + ] +} diff --git a/api-ref/source/v2/samples/sessions-list-request.json b/api-ref/source/v2/samples/sessions-list-request.json new file mode 100644 index 00000000..84249dfb --- /dev/null +++ b/api-ref/source/v2/samples/sessions-list-request.json @@ -0,0 +1,12 @@ +{ + "match_not": [ + { + "schedule_interval": "10 days" + } + ], + "match": [ + { + "hold_off": 50 + } + ] +} diff --git a/api-ref/source/v2/sessions-v2.inc b/api-ref/source/v2/sessions-v2.inc index 051e6112..b4b3d728 100644 --- a/api-ref/source/v2/sessions-v2.inc +++ b/api-ref/source/v2/sessions-v2.inc @@ -43,6 +43,7 @@ Request Parameters - limit: limit - offset: marker + - search: search_option Response Parameters ------------------- @@ -52,6 +53,12 @@ Response Parameters - sessions: sessions +Request Example +--------------- + +.. literalinclude:: samples/sessions-list-request.json + :language: javascript + Response Example ---------------- diff --git a/doc/source/conf.py b/doc/source/conf.py index f0c067fa..98cf225a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -141,12 +141,12 @@ html_theme = 'default' #html_last_updated_fmt = '%b %d, %Y' git_cmd = ["git", "log", "--pretty=format:%ad, commit %h", "--date=local", "-n1"] -try: - html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') -except Exception: - warnings.warn('Cannot get last updated time from git repository. ' - 'Not setting "html_last_updated_fmt".') - +#try: +# html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') +#except Exception: +# warnings.warn('Cannot get last updated time from git repository. ' +# 'Not setting "html_last_updated_fmt".') +html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True diff --git a/doc/source/index.rst b/doc/source/index.rst index aecbe02d..8fa08763 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,8 +11,7 @@ Contents: .. toctree:: :maxdepth: 2 - cli/index - + cli/index Indices and tables ================== @@ -20,3 +19,4 @@ Indices and tables * :ref:`genindex` * :ref:`search` +