Merge pull request #36 from hadleynet/master

Add links to SDP API guidance
CDCgov · Mar 22, 2019 · 7f16f7a · 7f16f7a
2 parents 05b449e + d4c6dff
commit 7f16f7a
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/_data/apis.yml b/_data/apis.yml
@@ -41,3 +41,20 @@
   arch: REST
   formats:
     - json
+- title: API Guidance
+  id: sdp-api-guidance
+  tagline: CDC's Surveillance Data Platform program offers guidance on several aspects of RESTful API design and implementation.
+  docs: https://publichealthsurveillance.atlassian.net/wiki/spaces/STA/pages/478969857/REST+API+Guidance+-+Version+1.1
+  arch: REST
+  links:
+    - description: RESTful API Design Guidance
+      url: https://publichealthsurveillance.atlassian.net/wiki/spaces/STA/pages/478969857/REST+API+Guidance+-+Version+1.1
+    - description: Example RESTful API
+      url: https://publichealthsurveillance.atlassian.net/wiki/spaces/STA/pages/387710977/RESTful+API+Example+SDP-V
+    - description: API Implementation Considerations
+      url: https://publichealthsurveillance.atlassian.net/wiki/spaces/STA/pages/485425156/API+Implementation+Considerations
+    - description: Using OAuth to Secure CDC APIs
+      url: https://publichealthsurveillance.atlassian.net/wiki/spaces/STA/pages/410189825/Using+OAuth+to+Secure+CDC+APIs
+  formats:
+    - json
+    - xml
diff --git a/pages/apis.html b/pages/apis.html
@@ -21,14 +21,26 @@ <h2>
     <p class="tagline">{{ section.tagline }}</p>
     <table class="opencdc-table-borderless">
       <tbody>
+        {% if section.url %}
         <tr>
           <td width="20%"><strong>Endpoint:</strong></td>
           <td><a href="{{ section.url }}" target="_blank">{{ section.url }}</a></td>
         </tr>
+        {% endif %}
         <tr>
           <td width="20%"><strong>Documentation:</strong></td>
           <td><a href="{{ section.docs }}" target="_blank">{{ section.docs }}</a></td>
         </tr>
+        {% if section.links %}
+        <tr>
+          <td width="20%"><strong>Additional Links:</strong></td>
+          <td>
+          {% for link in section.links %}
+          <a href="{{ link.url }}" target="_blank">{{ link.description }}</a><br/>
+          {% endfor %}
+          </td>
+        </tr>
+        {% endif %}
         <tr>
           <td width="20%"><strong>Architecture:</strong></td>
           <td>{{ section.arch }}</td>
@@ -45,4 +57,4 @@ <h2>
     </table>
   </div>
 </section>
-{% endfor %}
+{% endfor %}