keinsell / neuronek

🧬 Intelligent dosage tracker application with purpose to monitor supplements, nootropics and psychoactive substances along with their long-term influence on one's mind and body.
https://neuronek.up.railway.app/reference
Do What The F*ck You Want To Public License
11 stars 2 forks source link

docs: πŸ“ use `tsoa` for openapi documentation #376

Closed keinsell closed 1 year ago

height[bot] commented 1 year ago

Link Height tasks by mentioning a task ID in the pull request title or commit messages, or description and comments with the keyword link (e.g. "Link T-123").

πŸ’‘Tip: You can also use "Close T-X" to automatically close a task when the pull request is merged.

linear[bot] commented 1 year ago
ENG-11 Add OpenAPI 3.0 Documentation

The goal of this task is to add OpenAPI 3.0 documentation to an existing system. OpenAPI documentation provides a standardized way to describe the API, its endpoints, expected inputs, and expected outputs. This will make it easier for developers to integrate with the system and provide documentation to external consumers. System Requirements: * Existing system must use a framework that supports OpenAPI 3.0 documentation. * All API endpoints must be defined with their respective input and output schema. * The OpenAPI specification must be generated automatically and be up-to-date. Success Criteria: * All API endpoints are documented using the OpenAPI 3.0 specification. * The generated OpenAPI specification is up-to-date and automatically reflects any changes made to the API. * The documentation is easily accessible for internal and external developers.

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Updated (UTC)
neuronek ❌ Failed (Inspect) May 23, 2023 7:41pm
pulumi[bot] commented 1 year ago

:tropical_drink: The Update (preview) for keinsell/neuronek/dev was successful.

Resource Changes

    Name          Type                           Operation
~   digitalocean  pulumi:providers:digitalocean  update
-   k8s-provider  pulumi:providers:kubernetes    delete