501Fun-feature-cards/docs/openapi/cms-api.json at master · Hum2a/501Fun-feature-cards · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
{
  "openapi": "3.1.0",
  "info": {
    "title": "feature-cards mock CMS API",
    "version": "1.0.1",
    "description": "OpenAPI contract for the mock Cloudflare Worker CMS used by the feature-cards demo.",
    "license": { "name": "AGPL-3.0-only" }
  },
  "servers": [
    {
      "url": "https://cms.501fun.humza-butt.space",
      "description": "Production mock CMS"
    },
    { "url": "http://localhost:8787", "description": "Local wrangler dev" }
  ],
  "paths": {
    "/api/cards": {
      "get": {
        "operationId": "getCards",
        "summary": "Fetch canonical feature card payload",
        "responses": {
          "200": {
            "description": "Card section JSON matching the feature-cards canonical schema",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/FeatureCardsData" }
              }
            },
            "headers": {
              "Cache-Control": {
                "schema": { "type": "string" },
                "example": "public, max-age=60, stale-while-revalidate=300"
              }
            }
          }
        }
      },
      "options": {
        "summary": "CORS preflight",
        "responses": { "204": { "description": "No content" } }
      }
    },
    "/openapi.json": {
      "get": {
        "operationId": "getOpenApi",
        "summary": "This OpenAPI document",
        "responses": {
          "200": {
            "description": "OpenAPI 3.1 JSON",
            "content": { "application/json": { "schema": { "type": "object" } } }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "FeatureCardsData": {
        "type": "object",
        "required": ["cards"],
        "properties": {
          "heading": { "type": "string" },
          "cards": {
            "type": "array",
            "minItems": 1,
            "items": { "$ref": "#/components/schemas/Card" }
          }
        }
      },
      "Card": {
        "type": "object",
        "required": ["id", "title"],
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "eyebrow": { "type": "string" },
          "title": { "type": "string", "minLength": 1 },
          "description": { "type": "string" },
          "figure": { "$ref": "#/components/schemas/Figure" },
          "cta": { "$ref": "#/components/schemas/Cta" },
          "theme": { "type": "string" }
        }
      },
      "Figure": {
        "type": "object",
        "required": ["value", "label"],
        "properties": {
          "value": { "type": "string" },
          "label": { "type": "string" },
          "trend": { "type": "string", "enum": ["up", "down", "flat"] }
        }
      },
      "Cta": {
        "type": "object",
        "required": ["label", "href"],
        "properties": {
          "label": { "type": "string" },
          "href": { "type": "string" },
          "ariaLabel": { "type": "string" }
        }
      }
    }
  }
}