From df821b8190e74999458aecac3aa6231252e4777d Mon Sep 17 00:00:00 2001 From: pratishta Date: Thu, 30 May 2024 10:19:30 -0400 Subject: [PATCH] Update Readme documentation and add emojis Fix typo --- README.md | 2 +- openapi/openapi.yaml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3120c3a8..e2842140 100644 --- 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 index 760bbfbb..74948b39 100644 --- 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