Add Columns to search_ports API function (#14348)

* Add Columns to search_ports function

* StyleCI

* StyleCI

* Add to Docs

* Suggested If fix
This commit is contained in:
electrocret
2022-11-17 10:18:09 -06:00
committed by GitHub
parent 2821d1abc4
commit 4c0ebb6f74
2 changed files with 9 additions and 5 deletions

View File

@@ -51,7 +51,7 @@ Route: `/api/v0/ports/search/:search`
Input: Input:
- - columns: Comma separated list of columns you want returned.
Example: Example:
@@ -97,7 +97,7 @@ Route: `/api/v0/ports/search/:field/:search`
Input: Input:
- - columns: Comma separated list of columns you want returned.
Example: Example:

View File

@@ -975,7 +975,7 @@ function get_port_graphs(Illuminate\Http\Request $request)
$hostname = $request->route('hostname'); $hostname = $request->route('hostname');
$columns = $request->get('columns', 'ifName'); $columns = $request->get('columns', 'ifName');
if ($validate = validate_column_list($columns, 'ports') !== true) { if (($validate = validate_column_list($columns, 'ports')) !== true) {
return $validate; return $validate;
} }
@@ -1056,9 +1056,13 @@ function search_ports(Illuminate\Http\Request $request)
{ {
$field = $request->route('field'); $field = $request->route('field');
$search = $request->route('search'); $search = $request->route('search');
$columns = $request->get('columns');
if (($validate = validate_column_list($columns, 'ports')) !== true) {
return $validate;
}
$query = Port::hasAccess(Auth::user()) $query = Port::hasAccess(Auth::user())
->select(['device_id', 'port_id', 'ifIndex', 'ifName']); ->select(['device_id', 'port_id', 'ifIndex', 'ifName', $columns]);
if (isset($search)) { if (isset($search)) {
$query->where($field, 'like', "%$search%"); $query->where($field, 'like', "%$search%");
@@ -1082,7 +1086,7 @@ function search_ports(Illuminate\Http\Request $request)
function get_all_ports(Illuminate\Http\Request $request) function get_all_ports(Illuminate\Http\Request $request)
{ {
$columns = $request->get('columns', 'port_id, ifName'); $columns = $request->get('columns', 'port_id, ifName');
if ($validate = validate_column_list($columns, 'ports') !== true) { if (($validate = validate_column_list($columns, 'ports')) !== true) {
return $validate; return $validate;
} }