From 931c99c9f3908ed705159a25006649b72335cd8b Mon Sep 17 00:00:00 2001 From: Michael Lange Date: Wed, 11 Oct 2017 15:30:49 -0700 Subject: [PATCH 1/3] Remove extraneous search query param from the job index page --- ui/app/controllers/jobs/job/index.js | 1 - 1 file changed, 1 deletion(-) diff --git a/ui/app/controllers/jobs/job/index.js b/ui/app/controllers/jobs/job/index.js index f90d4db20..e42c5c2f6 100644 --- a/ui/app/controllers/jobs/job/index.js +++ b/ui/app/controllers/jobs/job/index.js @@ -8,7 +8,6 @@ export default Controller.extend(Sortable, { queryParams: { currentPage: 'page', - searchTerm: 'search', sortProperty: 'sort', sortDescending: 'desc', }, From f2d1fb9673a22eca181e5011ec90398775a1763c Mon Sep 17 00:00:00 2001 From: Michael Lange Date: Wed, 11 Oct 2017 15:48:22 -0700 Subject: [PATCH 2/3] Removes extraneous search query param from the servers list page --- ui/app/controllers/servers.js | 1 - 1 file changed, 1 deletion(-) diff --git a/ui/app/controllers/servers.js b/ui/app/controllers/servers.js index bf9dac326..4f90fae10 100644 --- a/ui/app/controllers/servers.js +++ b/ui/app/controllers/servers.js @@ -9,7 +9,6 @@ export default Controller.extend(Sortable, { queryParams: { currentPage: 'page', - searchTerm: 'search', sortProperty: 'sort', sortDescending: 'desc', }, From 886418dccf2242626a05853fd9787aeb9748e4f8 Mon Sep 17 00:00:00 2001 From: Michael Lange Date: Wed, 11 Oct 2017 15:49:18 -0700 Subject: [PATCH 3/3] List query params on the API UI docs page --- website/source/api/ui.html.md | 89 +++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) diff --git a/website/source/api/ui.html.md b/website/source/api/ui.html.md index dadf5439d..42f4c9db1 100644 --- a/website/source/api/ui.html.md +++ b/website/source/api/ui.html.md @@ -20,6 +20,23 @@ This page lists all known jobs in a paginated, searchable, and sortable table. | ---------- | ----------- | | `/ui/jobs` | `text/html` | +### Parameters + +- `namespace` `(string: "")` - Specifies the namespace all jobs should be a member + of. This is specified as a querystring parameter. Namespaces are an enterprise feature. + +- `sort` `(string: "")` - Specifies the property the list of jobs should be sorted by. + This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + +- `search` `(string: "")` - Specifies a regular expression uses to filter the list of + visible jobs. This is specified as a querystring parameter. + +- `page` `(int: 0)` - Specifies the page in the jobs list that should be visible. This + is specified as a querystring parameter. + ## Job Detail @@ -31,6 +48,17 @@ deployment for the job, it will be shown on the overview. | ------------------ | ----------- | | `/ui/jobs/:job_id` | `text/html` | +### Parameters + +- `sort` `(string: "")` - Specifies the property the list of task groups should be + sorted by. This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + +- `page` `(int: 0)` - Specifies the page in the task groups list that should be visible. This + is specified as a querystring parameter. + ### Job Definition @@ -79,6 +107,20 @@ allocations. | ----------------------------------- | ----------- | | `/ui/jobs/:job_id/:task_group_name` | `text/html` | +### Parameters + +- `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by. + This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + +- `search` `(string: "")` - Specifies a regular expression uses to filter the list of + visible allocations. This is specified as a querystring parameter. + +- `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This + is specified as a querystring parameter. + ## Allocation Detail @@ -92,6 +134,14 @@ description of the event. | --------------------------- | ----------- | | `/ui/allocations/:alloc_id` | `text/html` | +### Parameters + +- `sort` `(string: "")` - Specifies the property the list of tasks should be sorted by. + This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + ## Nodes List @@ -102,6 +152,20 @@ table. | ----------- | ----------- | | `/ui/nodes` | `text/html` | +### Parameters + +- `sort` `(string: "")` - Specifies the property the list of client nodes should be sorted by. + This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + +- `search` `(string: "")` - Specifies a regular expression uses to filter the list of + visible client nodes. This is specified as a querystring parameter. + +- `page` `(int: 0)` - Specifies the page in the client nodes list that should be visible. This + is specified as a querystring parameter. + ## Node Detail @@ -112,6 +176,20 @@ address, port, datacenter, allocations, and attributes. | -------------------- | ----------- | | `/ui/nodes/:node_id` | `text/html` | +### Parameters + +- `sort` `(string: "")` - Specifies the property the list of allocations should be sorted by. + This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + +- `search` `(string: "")` - Specifies a regular expression uses to filter the list of + visible allocations. This is specified as a querystring parameter. + +- `page` `(int: 0)` - Specifies the page in the allocations list that should be visible. This + is specified as a querystring parameter. + ## Servers List @@ -123,6 +201,17 @@ the leader. | ------------- | ----------- | | `/ui/servers` | `text/html` | +### Parameters + +- `sort` `(string: "")` - Specifies the property the list of server agents should be sorted by. + This is specified as a querystring parameter. + +- `desc` `(boolean: false)` - Specifies whether or not the sort direction is descending + or ascending. This is specified as a querystring parameter. + +- `page` `(int: 0)` - Specifies the page in the server agents list that should be visible. This + is specified as a querystring parameter. + ## Server Detail