Merge pull request #103 from OneBusAway/more-apis

More apis

src/api/example_responses/config.json

@@ -0,0 +1 @@
+{"code":200,"currentTime":1710960036523,"data":{"entry":{"gitProperties":{"git.branch":"d600e47ead0928a9e1bd76af9f16c12294d3782c","git.build.host":"swdev31","git.build.time":"23.01.2024 @ 16:01:10 EST","git.build.user.email":"[email protected]","git.build.user.name":"sheldonabrown","git.build.version":"2.5.2-cs","git.closest.tag.commit.count":"0","git.closest.tag.name":"onebusaway-application-modules-2.5.2-cs","git.commit.id":"d600e47ead0928a9e1bd76af9f16c12294d3782c","git.commit.id.abbrev":"d600e47","git.commit.id.describe":"onebusaway-application-modules-2.5.2-cs","git.commit.id.describe-short":"onebusaway-application-modules-2.5.2-cs","git.commit.message.full":"[maven-release-plugin] prepare release onebusaway-application-modules-2.5.2-cs","git.commit.message.short":"[maven-release-plugin] prepare release onebusaway-application-modules-2.5.2-cs","git.commit.time":"23.01.2024 @ 15:48:19 EST","git.commit.user.email":"[email protected]","git.commit.user.name":"sheldonabrown","git.dirty":"false","git.remote.origin.url":"[email protected]:camsys/onebusaway-application-modules.git","git.tags":"onebusaway-application-modules-2.5.2-cs"},"id":"b6bff432-3b99-4f75-8834-4b0c6969fb3f","name":"FEB24_2_4","serviceDateFrom":"1709280000000","serviceDateTo":"1722409200000"},"references":{"agencies":[],"routes":[],"situations":[],"stopTimes":[],"stops":[],"trips":[]}},"text":"OK","version":2}

src/api/example_responses/current-time.json

@@ -0,0 +1 @@
+{"code":200,"currentTime":1710960121182,"data":{"entry":{"readableTime":"2024-03-20T11:42:01-07:00","time":1710960121182},"references":{"agencies":[],"routes":[],"situations":[],"stopTimes":[],"stops":[],"trips":[]}},"text":"OK","version":2}

src/api/example_responses/report-problem-with-stop-1_75403.json

@@ -0,0 +1 @@
+{"code":200,"currentTime":1710960205535,"data":{},"text":"OK","version":2}

src/api/example_responses/report-problem-with-trip-1_79430293.json

@@ -0,0 +1 @@
+{"code":200,"currentTime":1710960426279,"data":{},"text":"OK","version":2}

src/api/where/methods/config.md

@@ -1,65 +1,11 @@
 ---
-layout: page
-title: config.json Method
+layout: rest_api
+title: config Method
+description: Get access to configuration information about the OBA server.
+sample_request_url: https://api.pugetsound.onebusaway.org/api/where/config.json?key=TEST
+example_response_file: config.json
 ---
 
-Access to configuration information.
-
-## Sample Request
-
-[https://api.pugetsound.onebusaway.org/api/where/config.json?key=TEST](https://api.pugetsound.onebusaway.org/api/where/config.json?key=TEST)
-
-
-## Sample Response
-
-  ```
-  {
-  "code": 200,
-  "currentTime": 1709665910298,
-  "data": {
-    "entry": {
-      "gitProperties": {
-        "git.branch": "d600e47ead0928a9e1bd76af9f16c12294d3782c",
-        "git.build.host": "swdev31",
-        "git.build.time": "23.01.2024 @ 16:01:10 EST",
-        "git.build.user.email": "[email protected]",
-        "git.build.user.name": "sheldonabrown",
-        "git.build.version": "2.5.2-cs",
-        "git.closest.tag.commit.count": "0",
-        "git.closest.tag.name": "onebusaway-application-modules-2.5.2-cs",
-        "git.commit.id": "d600e47ead0928a9e1bd76af9f16c12294d3782c",
-        "git.commit.id.abbrev": "d600e47",
-        "git.commit.id.describe": "onebusaway-application-modules-2.5.2-cs",
-        "git.commit.id.describe-short": "onebusaway-application-modules-2.5.2-cs",
-        "git.commit.message.full": "[maven-release-plugin] prepare release onebusaway-application-modules-2.5.2-cs",
-        "git.commit.message.short": "[maven-release-plugin] prepare release onebusaway-application-modules-2.5.2-cs",
-        "git.commit.time": "23.01.2024 @ 15:48:19 EST",
-        "git.commit.user.email": "[email protected]",
-        "git.commit.user.name": "sheldonabrown",
-        "git.dirty": "false",
-        "git.remote.origin.url": "[email protected]:camsys/onebusaway-application-modules.git",
-        "git.tags": "onebusaway-application-modules-2.5.2-cs"
-      },
-      "id": "b6bff432-3b99-4f75-8834-4b0c6969fb3f",
-      "name": "FEB24_2_4",
-      "serviceDateFrom": "1709280000000",
-      "serviceDateTo": "1722409200000"
-    },
-    "references": {
-      "agencies": [],
-      "routes": [],
-      "situations": [],
-      "stopTimes": [],
-      "stops": [],
-      "trips": []
-    }
-  },
-  "text": "OK",
-  "version": 2
-}
-
-  ```
-
 ## Request Parameters
 
 * key - API key for authentication.

src/api/where/methods/current-time.md

@@ -1,30 +1,11 @@
 ---
-layout: page
+layout: rest_api
 title: current-time Method
+description: Retrieve the current system time.
+sample_request_url: https://api.pugetsound.onebusaway.org/api/where/current-time.json?key=TEST
+example_response_file: current-time.json
 ---
 
-Retrieve the current system time
-
-## Sample Request
-
-[http://api.pugetsound.onebusaway.org/api/where/current-time.json?key=TEST](http://api.pugetsound.onebusaway.org/api/where/current-time.json?key=TEST)
-
-## Sample Response
-
-    <response>
-      <version>2</version>
-      <code>200</code>
-      <text>OK</text>
-      <currentTime>1270614730908</currentTime>
-      <data class="time">
-        <references/>
-        <time>
-          <time>1270614730908</time>
-          <readableTime>2010-04-06T21:32:10-07:00</readableTime>
-        </time>
-      </data>
-    </response>
-
 ## Response
 
 * `time` - current system time as milliseconds since the Unix epoch

src/api/where/methods/report-problem-with-stop.md

@@ -1,29 +1,15 @@
 ---
-layout: page
+layout: rest_api
 title: report-problem-with-stop Method
+description: |
+  Submit a user-generated problem report for a particular stop.  The reporting mechanism provides lots of fields that can
+  be specified to give more context about the details of the problem (which trip, stop, vehicle, etc was involved),
+  making it easier for a developer or transit agency staff to diagnose the problem.  These reports feed into the
+  problem reporting admin interface.
+sample_request_url: https://api.pugetsound.onebusaway.org/api/where/report-problem-with-stop/1_75403.json?key=TEST&code=stop_name_wrong
+example_response_file: report-problem-with-stop-1_75403.json
 ---
 
-Submit a user-generated problem report for a particular stop.  The reporting mechanism provides lots of fields that can
-be specified to give more context about the details of the problem (which trip, stop, vehicle, etc was involved),
-making it easier for a developer or transit agency staff to diagnose the problem.  These reports feed into the
-problem reporting admin interface.
-
-## Sample Request
-
-[http://api.pugetsound.onebusaway.org/api/where/report-problem-with-stop/1_75403.json?key=TEST&code=stop_name_wrong](http://api.pugetsound.onebusaway.org/api/where/report-problem-with-stop/1_75403.json?key=TEST&code=stop_name_wrong)
-
-## Sample Response
-
-~~~~
-<response>
-  <version>2</version>
-  <code>200</code>
-  <currentTime>1318879898047</currentTime>
-  <text>OK</text>
-  <data/>
-</response>
-~~~~
-
 ## Request Parameters
 
 * stopId - the trip id, encoded directly in the URL:

src/api/where/methods/report-problem-with-trip.md

@@ -1,29 +1,15 @@
 ---
-layout: page
+layout: rest_api
 title: report-problem-with-trip Method
+description: |
+  Submit a user-generated problem report for a particular trip.  The reporting mechanism provides lots of fields that can
+  be specified to give more context about the details of the problem (which trip, stop, vehicle, etc was involved),
+  making it easier for a developer or transit agency staff to diagnose the problem.  These reports feed into the
+  problem reporting admin interface.
+sample_request_url: https://api.pugetsound.onebusaway.org/api/where/report-problem-with-trip/1_79430293.json?key=TEST&serviceDate=1291536000000&vehicleId=1_3521&stopId=1_75403&code=vehicle_never_came
+example_response_file: report-problem-with-trip-1_79430293.json
 ---
 
-Submit a user-generated problem report for a particular trip.  The reporting mechanism provides lots of fields that can
-be specified to give more context about the details of the problem (which trip, stop, vehicle, etc was involved),
-making it easier for a developer or transit agency staff to diagnose the problem.  These reports feed into the
-problem reporting admin interface.
-
-## Sample Request
-
-[http://api.pugetsound.onebusaway.org/api/where/report-problem-with-trip/1_79430293.json?key=TEST&serviceDate=1291536000000&vehicleId=1_3521&stopId=1_75403&code=vehicle_never_came](http://api.pugetsound.onebusaway.org/api/where/report-problem-with-trip/1_79430293.json?key=TEST&serviceDate=1291536000000&vehicleId=1_3521&stopId=1_75403&code=vehicle_never_came)
-
-## Sample Response
-
-~~~~
-<response>
-  <version>2</version>
-  <code>200</code>
-  <currentTime>1318879898047</currentTime>
-  <text>OK</text>
-  <data/>
-</response>
-~~~~
-
 ## Request Parameters
 
 * tripId - the trip id, encoded directly in the URL: