cardinal-dev/Cardinal

[Development] Start Building API Foundation

Closed this issue · 2 comments

See: #131

Almost to a point where we can close this out (for now). Endpoint structure will be the following:

(Cardinal API)

  • /api/v1/access_points (GET, POST, DELETE)
  • /api/v1/access_points/{id}/ops/change_ip (POST)
  • /api/v1/access_points/{id}/ops/change_hostname (POST)
  • /api/v1/access_points/{id}/ops/fetcher (POST)
  • /api/v1/access_points/{id}/ops/tftp(POST)
  • /api/v1/access_points/{id}/ops/http/enable (POST)
  • /api/v1/access_points/{id}/ops/http/disable (POST)
  • /api/v1/access_points/{id}/ops/snmp/enable (POST)
  • /api/v1/access_points/{id}/ops/snmp/disable (POST)
  • /api/v1/access_points/{id}/ops/deploy_ssid/24ghz (POST)
  • /api/v1/access_points/{id}/ops/deploy_ssid/5ghz (POST)
  • /api/v1/access_points/{id}/ops/deploy_ssid/24ghz_radius (POST)
  • /api/v1/access_points/{id}/ops/deploy_ssid/24ghz_radius (POST)
  • /api/v1/access_points/{id}/ops/remove_ssid/24ghz (POST)
  • /api/v1/access_points/{id}/ops/remove_ssid/5ghz (POST)
  • /api/v1/access_points/{id}/ops/remove_ssid/24ghz_radius (POST)
  • /api/v1/access_points/{id}/ops/remove_ssid/24ghz_radius (POST)
  • /api/v1/access_point_groups (GET, POST, DELETE)
  • /api/v1/access_point_groups/{id}/ops/tftp_backup (POST)
  • /api/v1/access_point_groups/{id}/ops/http/enable (POST)
  • /api/v1/access_point_groups/{id}/ops/http/disable (POST)
  • /api/v1/access_point_groups/{id}/ops/snmp/enable (POST)
  • /api/v1/access_point_groups/{id}/ops/snmp/disable (POST)
  • /api/v1/access_point_groups/{id}/ops/deploy_ssid/24ghz (POST)
  • /api/v1/access_point_groups/{id}/ops/deploy_ssid/5ghz (POST)
  • /api/v1/access_point_groups/{id}/ops/deploy_ssid/24ghz_radius (POST)
  • /api/v1/access_point_groups/{id}/ops/deploy_ssid/24ghz_radius (POST)
  • /api/v1/access_point_groups/{id}/ops/remove_ssid/24ghz (POST)
  • /api/v1/access_point_groups/{id}/ops/remove_ssid/5ghz (POST)
  • /api/v1/access_point_groups/{id}/ops/remove_ssid/24ghz_radius (POST)
  • /api/v1/access_point_groups/{id}/ops/remove_ssid/24ghz_radius (POST)
  • /api/v1/ssids/24ghz (GET, POST, DELETE)
  • /api/v1/ssids/5ghz (GET, POST, DELETE)
  • /api/v1/ssids/24ghz_radius (GET, POST, DELETE)
  • /api/v1/ssids/5ghz_radius (GET, POST, DELETE)
  • /api/v1/metrics (GET)
  • /api/v1/network_toolkit (POST)
  • /api/v1/network_toolkit/jobs (GET)

(UI Views)

  • /forms/add-ap (GET)
  • /forms/add-ap-group (GET)
  • /forms/delete-ap (GET)
  • /forms/delete-ap-group (GET)
  • /forms/network-toolkit (GET)
  • /forms/manage-ap-dashboard (GET, POST)
  • /forms/change-ap-ip (GET)
  • /forms/change-ap-name (GET)
  • /forms/deploy-ssids (GET)
  • /forms/deploy-ssid-24ghz (GET)
  • /forms/deploy-ssid-5ghz (GET)
  • /forms/deploy-ssid-24ghz-radius (GET)
  • /forms/deploy-ssid-5ghz-radius (GET)
  • /forms/remove-ssids (GET)
  • /forms/remove-ssid-24ghz (GET)
  • /forms/remove-ssid-5ghz (GET)
  • /forms/remove-ssid-24ghz-radius (GET)
  • /forms/remove-ssid-5ghz-radius (GET)
  • /forms/manage-ap-group-dashboard (GET, POST)
  • /forms/deploy-ssids-group (GET)
  • /forms/deploy-ssid-24ghz-group (GET)
  • /forms/deploy-ssid-5ghz-group (GET)
  • /forms/deploy-ssid-24ghz-radius-group (GET)
  • /forms/deploy-ssid-5ghz-radius-group (GET)
  • /forms/remove-ssids-group (GET)
  • /forms/remove-ssid-24ghz-group (GET)
  • /forms/remove-ssid-5ghz-group (GET)
  • /forms/remove-ssid-24ghz-radius-group (GET)
  • /forms/remove-ssid-5ghz-radius-group (GET)
  • /forms/add-ssids (GET)
  • /forms/add-ssid-24ghz (GET)
  • /forms/add-ssid-24ghz-radius (GET)
  • /forms/add-ssid-5ghz (GET)
  • /forms/add-ssid-5ghz-radius (GET)
  • /forms/delete-ssids (GET)
  • /forms/delete-ssid-24ghz (GET)
  • /forms/delete-ssid-24ghz-radius (GET)
  • /forms/delete-ssid-5ghz (GET)
  • /forms/delete-ssid-5ghz-radius (GET)

The preceding structure will be the goal for Cardinal v3.0. Future releases will have a proper frontend where React handles UI elements.