[IGNITE-21319] Review REST API

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: rest
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Unassigned
• Reporter: Aleksandr
• Created: 20/Jan/24 14:23
• Updated: 20/Jan/24 14:23

Description

I think it is time to review every endpoint we have and say if it can be simplified/improved.

Key points to take a look at:

• paths consistency (versioning, nouns, verbs, etc)
• parameters
• problems
• error codes
• Open API documentation

Also, the UX with swagger UI should be checked. Swagger UI should be self-descriptive and allow a user to play around with the API easily.