~mil/mobroute

80025b7be346e4bfea54ca3b0c055007c9c49b15 — Miles Alan 2 months ago db69e6c
CLI qa pass on docs
1 files changed, 12 insertions(+), 13 deletions(-)

M cli/const.go
M cli/const.go => cli/const.go +12 -13
@@ 10,10 10,10 @@ var (
	subcmdMobsqlExamples = map[string]string{
		"Determine GTFS Feed Status":                    `mobroute mobsql -mp '{"mobsql_params": {"op": "status", "feed_ids": [767]}}'`,
		"Load a GTFS Feed":                              `mobroute mobsql -mp '{"mobsql_params": {"op": "load", "feed_ids": [767]}}'`,
		"Compute Routing-Optimized GTFS Derived Tables": `mobroute mobsql -mp '{"mobsql_params": {"op": " compute", "feed_ids": [767]}}'`,
		"Purge GTFS Feed Data":                          `mobroute mobsql -mp '{"mobsql_params": {"op": " purge_gtfs", "feed_ids": [767]}}'`,
		"Purge Computed Tables":                         `mobroute mobsql -mp '{"mobsql_params": {"op": " purge_computed", "feed_ids": [767]}}'`,
		"Purge All Tables":                              `mobroute mobsql -mp '{"mobsql_params": {"op": " purge_all", "feed_ids": [767]}}'`,
		"Compute Routing-Optimized GTFS Derived Tables": `mobroute mobsql -mp '{"mobsql_params": {"op": "compute", "feed_ids": [767]}}'`,
		"Purge GTFS Feed Data":                          `mobroute mobsql -mp '{"mobsql_params": {"op": "purge_gtfs", "feed_ids": [767]}}'`,
		"Purge Computed Tables":                         `mobroute mobsql -mp '{"mobsql_params": {"op": "purge_computed", "feed_ids": [767]}}'`,
		"Purge All Tables":                              `mobroute mobsql -mp '{"mobsql_params": {"op": "purge_all", "feed_ids": [767]}}'`,
	}
)



@@ 22,11 22,11 @@ const (
JSON Parameters for oneshot route subcommand, should be in format of: {"route_params": {"feed_ids": [516],...}}

Required route parameters:
  - feed_ids: Array of integer feed IDs (MDBID) to use for routing requests
  - from: Array of two floats; [lat, lon]
  - to: Array of two floats; [lat, lon]
  - transfer_categories: Array of transfers categories to load - "f" for feed, "i" for implicit, "g" for generated, e.g. ["f", "i"]
  - output_formats: Array of formats for the output may include - ["legs", "geojson", "diagnostics", "mapurl", "request"]
  - feed_ids: Array of integer feed IDs (MDBID) to use for routing requests (ex: [516, 510])
  - from: Array of two floats in lat, lon format (ex: [50.012338, 19.88192])
  - to: Array of two floats in lat, lon format (ex: [50.012338, 19.88192])
  - transfer_categories: Array of transfers categories to load - may include "f" for feed, "i" for implicit, "g" for generated (ex: ["f", "i"])
  - output_formats: Array of formats for the output may include - may include "legs", "geojson", "diagnostics", "mapurl", "request" (ex: ["legs", "geojson"])

Optional route parameters:
  - time: Datetime at which route should depart in RFC3339 format (default: current system time)


@@ 37,11 37,10 @@ Optional route parameters:
  - max_n_transfers: Maximum number of transfers a route can contain (default: 20)
  - walkspeed_km_hr: Ratio of kilometers per hour the user walk (default: 4.5)
`

	subcmdMobsqlDoc = `JSON Parameters for oneshot mobsql subcommand, should be in format of: {"mobsql_params": {"feed_ids": [767], "op": "status"}}.
subcmdMobsqlDoc = ` JSON Parameters for oneshot mobsql subcommand, should be in format of: {"mobsql_params": {"feed_ids": [767], "op": "status"}}

Required mobsql parameters:
  - feed_ids: Array of integer feed IDs (MDBID) to use for mobsql requests
  - op: Operation to perform, one of - ["status", "load", "compute", "purge_gtfs", "purge_computed", "purge_all"]
  - feed_ids: Array of integer feed IDs (MDBID) to use for mobsql requests (ex: [767])
  - op: Operation to perform - may be one of "status", "load", "compute", "purge_gtfs", "purge_computed", "purge_all" (ex: "status")
`
)