Skip to content

Commit 5cb7c51

Browse files
Merge pull request #54 from BrenekH/api-docs-use-jsonc-md-sections
[API Docs] Use JSONC code blocks to avoid red background around comments
2 parents bb88e9c + 36e2bab commit 5cb7c51

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

backend/standard/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ Key characteristics of the authentication system:
3232
### Coupon
3333
The Coupon structure represents a single coupon code and its metadata. Each field serves a specific purpose:
3434

35-
```json
35+
```jsonc
3636
{
37-
"id": "string", // Unique identifier for the coupon
38-
"title": "string", // Display title with discount amount
39-
"description": "string", // Detailed coupon information
40-
"code": "string", // The actual coupon code
41-
"score": number, // Relevance/reliability score
37+
"id": "string", // Unique identifier for the coupon
38+
"title": "string", // Display title with discount amount
39+
"description": "string", // Detailed coupon information
40+
"code": "string", // The actual coupon code
41+
"score": number, // Relevance/reliability score
4242
"merchant_name": "string" // Store/website name
4343
}
4444
```
@@ -63,7 +63,7 @@ Field Details:
6363
### VersionInfo
6464
The VersionInfo structure helps track API compatibility:
6565

66-
```json
66+
```jsonc
6767
{
6868
"version": "string", // Semantic versioning recommended
6969
"provider": "string" // Provider's name or identifier
@@ -80,7 +80,7 @@ GET /syrup/version
8080
```
8181

8282
#### Response
83-
```json
83+
```jsonc
8484
{
8585
"version": "1.0.0",
8686
"provider": "ExampleProvider"
@@ -109,7 +109,7 @@ GET /syrup/coupons
109109
| X-RateLimit-Reset | The time when the rate limit window resets (Unix timestamp)|
110110

111111
#### Response Body
112-
```json
112+
```jsonc
113113
{
114114
"coupons": [
115115
{
@@ -188,7 +188,7 @@ The API uses standard HTTP status codes with specific meanings in the context of
188188
- System failures
189189

190190
Error responses should include a descriptive message when possible:
191-
```json
191+
```jsonc
192192
{
193193
"error": "Invalid domain format",
194194
"message": "Domain must be a valid hostname without protocol or path"

0 commit comments

Comments
 (0)