feat: add OpenAPI schema (#100)

.github/labeler.yml

@@ -39,4 +39,8 @@ github:
   - changed-files:
     - any-glob-to-any-file:
       - '.github/*'
-      - '.github/**'
+      - '.github/**'
+openapi:
+ - changed-files:
+    - any-glob-to-any-file:
+      - 'openapi.json'

.github/workflows/openapi.yml

@@ -0,0 +1,20 @@
+name: OpenAPI
+on: 
+  workflow_dispatch:
+  push:
+    paths:
+      - '**/schemas/v2/api'
+      - '**/schemas/v2/resources'
+      - '**/scripts/v2/openapi'
+    branches: main
+jobs:
+  update:
+    name: Update specs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.PAT }}
+          repository: ghostrider-05/patreon-api-spec
+          event-type: spec_update

.gitignore

@@ -145,6 +145,3 @@ dist
 
 # Test file for example
 example.ts
-
-# Generated by scripts
-src/schemas/v2/generated

apps/worker-docs/src/index.ts

@@ -9,17 +9,33 @@ import {
     Type,
 } from 'patreon-api.ts'
 
-import routes from './routes'
+interface LibraryData {
+    version: number
+    base: string
+    headers: {
+        userAgent: string
+        response: Record<'id' | 'sha', string>
+    }
 
-import type { LibraryData } from '../../../docs/.vitepress/components/data'
+    relationships: Record<string, {
+        resourceKey: string;
+        includeKey: string;
+        isArray: boolean;
+        isRelated: boolean;
+    }[]>
+    schemas: Record<string, string[] | readonly string[]>
+    webhook: {
+        triggers: string[]
+    }
+}
 
 export default <ExportedHandler>{
     async fetch(request) {
         const { pathname } = new URL(request.url)
 
         const corsHeaders = {
             'Access-Control-Allow-Origin': '*',
-            'Access-Control-Allow-Methods': 'GET,HEAD,POST,OPTIONS',
+            'Access-Control-Allow-Methods': 'DELETE,GET,HEAD,POST,PATCH,OPTIONS',
             'Access-Control-Max-Age': '86400',
         }
 
@@ -34,7 +50,6 @@ export default <ExportedHandler>{
                         sha: PATREON_RESPONSE_HEADERS.Sha,
                     }
                 },
-                routes,
                 schemas: {
                     ...Object.keys(SchemaKeys).reduce((obj, key) => ({ ...obj, [key.toLowerCase()]: SchemaKeys[key] }), {}),
                     [Type.PledgeEvent]: SchemaKeys.PledgeEvent,

docs/.vitepress/components/GitHubStat.vue

@@ -0,0 +1,62 @@
+<script setup lang="ts">
+import { onMounted, ref } from 'vue';
+import { VPLink } from 'vitepress/theme'
+
+const stat = ref(0)
+
+const props = defineProps<{
+    repo: string
+    keyName: string
+    iconClass: string
+    label: string
+}>()
+
+onMounted(async () => {
+    const res = await fetch('https://api.github.com/repos/' + props.repo)
+        .then(res => res.json() as Promise<Record<string, number>>)
+        .then(res => res[props.keyName])
+
+    if (res) stat.value = res
+})
+</script>
+
+<template>
+    <p>
+        <VPLink :href="'https://github.com/' + repo"><span :class="iconClass"></span> {{ stat }} {{ label }}</VPLink>
+    </p>
+</template>
+
+<style scoped>
+.VPNavScreenMenu p {
+    margin-top: 20px;
+}
+
+p {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+a:hover {
+    cursor: pointer;
+}
+
+a {
+    line-height: 20px;
+    border-radius: 3px;
+    padding: 0px 4px;
+    background-color: var(--vp-c-bg-soft);
+    color: var(--vp-c-brand-1) !important;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+a span {
+    background-color: var(--vp-c-white);
+    border-color: var(--vp-c-white);
+    width: 20px !important;
+    height: 20px !important;
+    margin: 5px;
+}
+</style>

docs/.vitepress/components/LibraryTable.vue

@@ -1,16 +1,23 @@
 <script setup lang="ts">
-const greenColor = 'green'
-const redColor = 'red'
+const greenColor = 'var(--vp-c-green-3)'
+const redColor = 'var(--vp-c-red-3)'
 
 const officialText = 'Official'
 
-function getColor (key, value) {
+interface Key {
+    id: string
+    name: string
+    title: string
+    colors?: 'boolean' | Record<number, 'green' | 'red'>
+}
+
+function getColor (key: Key, value: number | boolean) {
     if (!key.colors) return undefined
     else if (key.colors === 'boolean') return value === true ? greenColor : redColor
-    else return { red: redColor, green: greenColor }[key.colors[value]]
+    else return { red: redColor, green: greenColor }[key.colors[<number>value]]
 }
 
-function getStyle (key, value) {
+function getStyle (key: Key, value: number | boolean) {
     const color = getColor(key, value)
     if (color) return { backgroundColor: color, color: 'var(--vp-c-neutral-inverse)', textAlign: 'center' }
     else return {}