@@ -6,19 +6,41 @@ import { restRoutes } from "./routes/rest-routes";
66import { zodSchemaAdapter } from "@aklinker1/zeta/adapters/zod-schema-adapter" ;
77import { version } from "../package.json" ;
88import { z } from "zod" ;
9- import API_REFERENCE_DESCRIPTION from "./assets/api-reference-description.md" with { type : "text" } ;
10- import GRAPHQL_DESCRIPTION from "./assets/graphql-description.md" with { type : "text" } ;
9+ import dedent from "dedent" ;
1110
1211const app = createApp ( {
1312 schemaAdapter : zodSchemaAdapter ,
1413 openApi : {
1514 info : {
1615 title : "WXT Queue API Reference" ,
1716 version,
18- description : API_REFERENCE_DESCRIPTION ,
17+ description : dedent `
18+ # Overview
19+
20+ As of right now, the WXT Queue API is free to use with no authentication
21+ requirements.
22+
23+ > [!IMPORTANT]
24+ > If you want to keep it this way, **be respectful of how you use it**.
25+ > Do not spam or abuse it.
26+
27+ <br/>
28+
29+ ## REST vs GraphQL
30+
31+ The WXT Queue API is mostly a GraphQL API, with a few REST endpoints.
32+ This document covers all the REST endpoints, including the one used to
33+ make GraphQL requests.
34+ ` ,
1935 } ,
2036 tags : [
21- { name : "GraphQL" , description : GRAPHQL_DESCRIPTION } ,
37+ {
38+ name : "GraphQL" ,
39+ description : dedent `
40+ To play around with the GraphQL API, checkout the
41+ [GraphiQL Playground](/playground).
42+ ` ,
43+ } ,
2244 { name : "Chrome Extensions" } ,
2345 { name : "Firefox Addons" } ,
2446 { name : "System" } ,
0 commit comments