Created
September 5, 2021 17:37
-
-
Save harshith-venkatesh/9d3da89fd5c8a4854146462a5bec3421 to your computer and use it in GitHub Desktop.
The response to create Slider component is agreed upon with below contract
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Slider | |
## Slider Metadata Object | |
``` | |
{ | |
title: <string>, | |
description: <string>, | |
image:<string>, | |
button:<string> | |
} | |
``` | |
## **Requests** | |
| Route | Description | | |
|:----------------------------------------:|:------------------------------------ | | |
| [GET /slider](#get-slider) | Returns all available slider metadata | | |
## **GET /slider** | |
Returns | |
- **Params** | |
None | |
- **Query** | |
None | |
- **Body** | |
None | |
- **Headers** | |
Content-Type: application/json | |
- **Cookie** | |
None | |
- **Success Response:** | |
- **Code:** 200 | |
- **Content:** | |
``` | |
{ | |
message: 'Slider Data Returned Successfully' | |
data: [ | |
{Slider Metadata Object } , | |
{Slider Metadata Object } | |
] | |
} | |
``` | |
- **Error Response:** | |
- **Code:** 500 | |
- **Content:** `{ 'statusCode': 500, 'error': 'Internal Server Error', 'message': 'An internal server error occurred' }` | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment