Update Readme documentation and add emojis

Fix typo
NYCPlanning · May 30, 2024 · df821b8 · df821b8
1 parent 07175cf
commit df821b8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -67,7 +67,7 @@ To check validity of OpenAPI documentation:
 
 ### API development
 The API integrates with the OpenAPI documentation by implementing its endpoints. 
-The OpenAPI documentation defines schemas for the API to interact with. 
+The OpenAPI documentation defines schemas for the API to interact with. If an endpoint description is preceded by 🚧, it indicates that the endpoint has not yet been implemented and cannot be used on the frontend. 
 
 The API uses [Kubb](https://www.kubb.dev) to automatically generate 
 Typescript definitions and zod schemas from the OpenAPI documentation.

diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml
@@ -63,7 +63,7 @@ paths:
           $ref: "#/components/responses/InternalServerError"
   /boroughs/{boroughId}/community-districts:
     get:
-      summary: Find community districts within a borough
+      summary: 🚧 Find community districts within a borough
       operationId: findCommunityDistrictsByBoroughId
       tags:
       - Community Districts
@@ -91,7 +91,7 @@ paths:
           $ref: "#/components/responses/InternalServerError"
   /boroughs/{boroughId}/community-districts/{communityDistrictId}/capital-projects:
     get:
-      summary: Find paginated capital projects within a specified community district
+      summary: 🚧 Find paginated capital projects within a specified community district
       operationId: findCapitalProjectsByBoroughIdCommunityDistrictId
       tags:
       - Capital Projects