I am in the process of documenting an API and have limited technical knowledge. The API performs operations such as include, update and exclude components of a resource and it is implemented with a POST method.
The API URI looks as below: *POST: Office/employees *[include, exclude and modify employee data pertaining to employee of Office resource. The API supports adding new employees, removing employees and modifying employees in a single call] I wanted to know few points regarding my API design 1. An API with above kind of definition is right or not [ when we from the angle that the design is *REST*]. Also this type of definition is recommended or not? 2. Please share the examples or though on how multi- record APIs are documented. -- You received this message because you are subscribed to the Google Groups "Swagger" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
