JacobLinCool / JacobLinCool/sveltekit-api

Summary & Description for each path in OpenAPI

Open
#55 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
56
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Hello,

Bravo for your idea and your implementation. I will adopt sveltekit-api.

I have a suggestion:
Be able to enter a summary and a description in each path. This will allow for more explanation in Swagger or PostMan.

I made an implementation, but I'm not up to the standard with TypeScript to publish it.
Sorry for the quality of the code, it's just to give an idea of possible implementation.
If someone better at TypeScrip than me could finish the job, that would be great.

Good day.
[Archive.zip](https://github.com/JacobLinCool/sveltekit-api/files/14570923/Archive.zip)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the proposed implementation in Archive.zip and the repository's existing OpenAPI documentation generation. Verify that each path can carry a summary and description, and that the generated Swagger or Postman output includes both. Done means the feature is integrated with the project's TypeScript standards and its output is correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, postman, typescript
Domain
api, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.