[Backend] Design Backend API Model

[nbnw-org]

Description

• As a Developer, I want to have a well thought out design for API development so that we have a scalable 3P EPortal API.

Requirements

• Design Smithy Model for API that defines all the API paths, functionalities and requirements for 3p EPortal.
• Support for - Editing, Drafts, Profile, Sponsored, Published Articles fetching, Reviewing.

Acceptance

• Reviewed by Swanand
• Reviewed by Himanshu

[nbnw-org]

Created basic User Profile API design (Note that it might change as currently just in progress to define how things might look like) - https://github.com/nbnworg/nbnw-3p-eportal-model/pull/1

This is mainly for guiding purposes of how to work on implementing/modeling API's when creating it from scratch.

[nbnw-org]

Added Draft API's - https://github.com/nbnworg/nbnw-3p-eportal-model/pull/2

[nbnw-org]

Analytics API - https://github.com/nbnworg/nbnw-3p-eportal-model/pull/3

Note : We might need to go back to analytics api based on design document for analytics.

[nbnw-org]

Carousel support for article published by other business users - https://github.com/nbnworg/nbnw-3p-eportal-model/pull/4

[nbnw-org]

All the PR's have been merged, @SwanandBhuskute and @hv65616 should review the model to ensure all use cases are being satisfied by the smithy model.

[nbnw-org]

Some comments from offline by Swanand-

• in common/datamodels.smithy structure DraftMetadata - id should be required and subcategory: SubCategory?

• in common/enums.smithy - maybe WORLD category is missing and also DraftStateType - in_review is same as "submit"?

• DELETE draft for user/owner ho skti hai? same for unsubmitted drafts...

• GET /drafts, usme kuch input diya to nahi hai, to InvalidInputException kaise

[nbnw-org]

Reviewed by Tisha offline~.

[nbnw-org]

Reviewed by Himanshu, closing it.