Define a tempalte for Rest API

[ghassanmas]

We want to come up with a template that we or/and the owners/maintainers of an MFEs would use as a reference for documenting the usage of the Rest API.

What should the template have or indicate:

• Indicating if the API is a (backend for frontend) or is general-purpose API:
  • If it's a general-purpose API, does the doc for it exist? e.g. swagger/API if yes link to them...
• All possible usage scenarios:
  • What are the different ways or combinations to use the API
  • How does the MFE respond to each scenario
  • Indicating all metadata of each request: [method, status code, URL headers]
    • Indicating as well if any of the metadata is optional or required.