search

Natixar / natixar-frontend

The static front end of the Natixar SaaS platform
0 stars 5 forks source link

[ADD] API Documentation with OpenAPI 3.0.0 #75

Closed LayBraid closed 1 month ago

render[bot] commented 1 month ago

Your Render PR Server URL is https://natixar-pr-75.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-cp14bpfsc6pc73d286b0.

render[bot] commented 1 month ago

Your Render PR Server at https://natixar-pr-75.onrender.com is now live!

View it on your dashboard at https://dashboard.render.com/static/srv-cp14bpfsc6pc73d286b0.

lepeuvedic-natixar commented 1 month ago

Where are /network-information and it's "url" path parameter coming from ? Can you explain ? It looks like hallucination and strangely happens on the only path configurable via an environment parameter. Have you used generative AI for this work ? If so, it's ok, but you must always check everything. Which AI did you use ?

  1. Rename /core as /doc - it will be useful in due time: the front-end code is sorely lacking documentation.
  2. Remove all speculative parameters - if unsure, AI-generated and not checked, state so as comments. Comments are not allowed in JSON but this file is not going to be used as JSON anyway.Use "//"
  3. We have an openapi 3.0.0 authoritative specification that's used for automatic back-end REST API configuration.
  4. Replace all mention of "spec" or "specification" with "inventory on ": this work conflicts with actual specifications.
render[bot] commented 1 month ago

Your Render PR Server at https://natixar-pr-75.onrender.com is now live!

View it on your dashboard at https://dashboard.render.com/static/srv-cp14bpfsc6pc73d286b0.