docs: Add REST endpoint guidance

[kfelternv]

No description provided.

[copy-pr-bot]

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: a276fd02-f064-4bd4-ba02-2f29f109f85d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[thossain-nv]

This is great @kfelternv A few other things to add:

• FromDBModel (we want to transition from NewX to this receiver) and ToDBModel for converting between APi and DB models
• All API model attributes should be structured, we don't allow schemaless JSON exposure. JSON tags must be camel Case. All constants should be in Pascal Case.
• Implementor should seek observe all existing endpoint routes to make the best decision for a new route. Naming the route and attributes correctly is critical, once published in a release tag it must use deprecation to In general we follow REST best practices:
  • Creating new objects should be done using POST
  • Updates should be done using PATCH
  • PUT is used only if the endpoint supports both creation or update
  • Unless the resource has no unique identifier, PATCH, GET and DELETE routes must end with resource ID
  • GET requests that return multiple objects must return pagination information in designated pagination header in response