Add API description in tspec.config.json

ts-spec / tspec

Type-driven API Documentation library. Auto-generating REST API document based on TypeScript types.

https://ts-spec.github.io/tspec/

MIT License

108 stars 5 forks source link

Add API description in tspec.config.json #56

Closed programatix closed 3 weeks ago

programatix commented 1 month ago

Is your feature request related to a problem? Please describe. The API description is currently missing.

It would be great if it can be added like this,

Describe the solution you'd like

{
    "specVersion": 3,
    "openapi": {
        "title": "My API",
        "version": "1.0.0",
        "description": "My API description." // <== Add this
    }
}

hyeonss0417 commented 3 weeks ago

Hello, @programatix

Thank you very much for taking the time to report the bug and for your interest in our project. We have reviewed the issue you suggested regarding OpenAPI description , and we have implemented it. To apply this featuer on your end, please update tspec version to latest(=v0.1.116).

Once again, thank you for your valuable feedback. Your contributions help us improve the project significantly.

Best regards, Hyeonsoneg Jeon.