Fix redocly linting errors and warnings

- Create a redocly config - Turn off license rule - Add a security policy - Add tag descriptions closes #207 closes #206 closes #205
NYCPlanning · Jul 25, 2024 · 9e4f074 · 9e4f074
1 parent b406a69
commit 9e4f074
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -6,12 +6,18 @@ info:
   version: 0.1.0
 servers:
   - url: https://zoning.planningdigital.com/api 
+security: []
 tags:
   - name: Boroughs
+    description: An endpoint that returns or is otherwise related to NYC boroughs
   - name: Land Uses
+    description: An endpoint that returns or is otherwise related to land uses
   - name: Tax Lots
+    description: An endpoint that returns or is otherwise related to tax lots
   - name: Zoning Districts
+    description: An endpoint that returns or is otherwise related to zoning districts
   - name: GeoJSON
+    description: An endpoint that returns spatial data in a geojson format
 paths:
   /agencies:
     get:

diff --git a/redocly.yaml b/redocly.yaml
@@ -0,0 +1,5 @@
+extends:
+  - recommended
+
+rules:
+  info-license: off