Feat models

package.json

@@ -45,6 +45,7 @@
 	},
 	"type": "module",
 	"dependencies": {
+		"@apidevtools/json-schema-ref-parser": "^11.1.0",
 		"@apidevtools/swagger-parser": "^10.1.0",
 		"@appwrite.io/pink": "0.0.7-sl10.0",
 		"@appwrite.io/repo": "github:appwrite/appwrite",

src/lib/layouts/Docs.svelte

@@ -29,7 +29,7 @@
 	export let variant: DocsLayoutVariant = 'default';
 
 	const variantClasses: Record<DocsLayoutVariant, string> = {
-		default: 'aw-grid-side-nav aw-container',
+		default: 'aw-grid-side-nav',
 		expanded: 'aw-grid-huge-navs',
 		'two-side-navs': 'aw-grid-two-side-navs'
 	};

src/lib/utils/code.ts

@@ -97,7 +97,7 @@ type Args = {
 export const getCodeHtml = (args: Args) => {
 	const { content, language, withLineNumbers } = args;
 	const res = hljs.highlight(content, { language: language ?? 'sh' }).value;
-	const lines = res.split(/\n/g).slice(0, -1);
+	const lines = res.split(/\n/g);
 
 	while (lines.length > 0 && lines[lines.length - 1] === '') {
 		lines.pop();

src/lib/utils/specs.ts

@@ -1,4 +1,3 @@
-import SwaggerParser from '@apidevtools/swagger-parser';
 import { OpenAPIV3 } from 'openapi-types';
 import { Platform, type Service } from './references';
 
@@ -17,13 +16,15 @@ type SDKMethod = {
 	responses: Array<{
 		code: number;
 		contentType?: string;
-		model?: {
-			id: string;
-			name: string;
-		};
+		models?: SDKMethodModel[];
 	}>;
 };
 
+type SDKMethodModel = {
+	id: string;
+	name: string;
+};
+
 type AppwriteOperationObject = OpenAPIV3.OperationObject & {
 	'x-appwrite': {
 		method: string;
@@ -41,7 +42,7 @@ type AppwriteOperationObject = OpenAPIV3.OperationObject & {
 	};
 };
 
-type AppwriteSchemaObject = OpenAPIV3.SchemaObject & {
+export type AppwriteSchemaObject = OpenAPIV3.SchemaObject & {
 	'x-example': string;
 };
 
@@ -141,7 +142,9 @@ export function getSchema(id: string, api: OpenAPIV3.Document): OpenAPIV3.Schema
 	throw new Error("Schema doesn't exist");
 }
 
-const specs = import.meta.glob('$appwrite/app/config/specs/open-api3*-(client|server).json');
+const specs = import.meta.glob('$appwrite/app/config/specs/open-api3*-(client|server).json', {
+	as: 'raw'
+});
 async function getSpec(version: string, platform: string) {
 	const isServer = platform.startsWith('server-');
 	const target = `/node_modules/@appwrite.io/repo/app/config/specs/open-api3-${version}-${
@@ -151,10 +154,8 @@ async function getSpec(version: string, platform: string) {
 }
 
 export async function getApi(version: string, platform: string): Promise<OpenAPIV3.Document> {
-	const spec = await getSpec(version, platform);
-	const parser = new SwaggerParser();
-	const api = (await parser.bundle(spec as unknown as OpenAPIV3.Document)) as OpenAPIV3.Document;
-
+	const raw = await getSpec(version, platform);
+	const api = JSON.parse(raw);
 	return api;
 }
 
@@ -198,28 +199,41 @@ export async function getService(
 		const responses: SDKMethod['responses'] = Object.entries(operation.responses ?? {}).map(
 			(tuple) => {
 				const [code, response] = tuple as [string, OpenAPIV3.ResponseObject];
-				const id = (
-					response?.content?.['application/json']?.schema as OpenAPIV3.ReferenceObject
-				)?.$ref
-					?.split('/')
-					.pop();
-				const schema = id ? getSchema(id, api) : undefined;
+				const models: SDKMethodModel[] = [];
+				const schemas = response?.content?.['application/json']?.schema as OpenAPIV3.SchemaObject;
+				if (code !== '204') {
+					if (schemas?.oneOf) {
+						schemas.oneOf.forEach((ref) => {
+							const schema = resolveReference(ref as OpenAPIV3.ReferenceObject, api);
+							models.push({
+								id: getIdFromReference(ref as OpenAPIV3.ReferenceObject),
+								name: schema.description ?? ''
+							});
+						});
+					} else {
+						if (schemas) {
+							const id = getIdFromReference(schemas as OpenAPIV3.ReferenceObject);
+							const schema = resolveReference(schemas as OpenAPIV3.ReferenceObject, api);
+							models.push({
+								id,
+								name: schema?.description ?? ''
+							});
+						}
+					}
+				}
 
 				return {
 					code: Number(code),
 					contentType: response?.content ? Object.keys(response.content)[0] : undefined,
-					model: id
-						? {
-								id,
-								name: schema?.description ?? ''
-						  }
-						: undefined
+					models
 				};
 			}
 		);
 
 		const path = isAndroid
-			? `/node_modules/@appwrite.io/repo/docs/examples/${version}/client-android/${isAndroidJava ? 'java' : 'kotlin'}/${operation['x-appwrite'].demo}`
+			? `/node_modules/@appwrite.io/repo/docs/examples/${version}/client-android/${
+					isAndroidJava ? 'java' : 'kotlin'
+			  }/${operation['x-appwrite'].demo}`
 			: `/node_modules/@appwrite.io/repo/docs/examples/${version}/${platform}/examples/${operation['x-appwrite'].demo}`;
 		if (!(path in examples)) {
 			continue;
@@ -236,3 +250,26 @@ export async function getService(
 
 	return data;
 }
+
+export function getIdFromReference(reference: OpenAPIV3.ReferenceObject) {
+	const id = reference?.$ref?.split('/')?.pop();
+	if (!id) {
+		throw new Error('Invalid reference');
+	}
+	return id;
+}
+
+export function resolveReference(
+	reference: OpenAPIV3.ReferenceObject,
+	api: OpenAPIV3.Document
+): AppwriteSchemaObject {
+	const id = reference.$ref.split('/').pop();
+	if (!id) {
+		throw new Error('Invalid reference');
+	}
+	const schema = api.components?.schemas?.[id] as AppwriteSchemaObject;
+	if (schema) {
+		return schema;
+	}
+	throw new Error("Schema doesn't exist");
+}

src/markdoc/layouts/Article.svelte

@@ -21,8 +21,8 @@
 
 	export let title: string;
 	export let description: string;
-	export let difficulty: string;
-	export let readtime: string;
+	export let difficulty: string = '';
+	export let readtime: string = '';
 
 	setContext<LayoutContext>('headings', writable({}));
 

src/routes/docs/advanced/platform/webhooks/+page.markdoc

@@ -6,7 +6,7 @@ description: Placeholder SEO.
 
 Certainly! Below is the content converted to Markdown format:
 
-```markdown
+```md
 ```php
 <?php
 

src/routes/docs/references/+page.svelte

@@ -1 +1,5 @@
-placeholder
+<script>
+	import Layout from './Layout.svelte';
+</script>
+
+<Layout>placeholder</Layout>

src/routes/docs/references/+layout.svelte → src/routes/docs/references/Layout.svelte

@@ -4,7 +4,8 @@
 	import Sidebar, { type NavParent, type NavTree } from '$lib/layouts/Sidebar.svelte';
 	import { preferredPlatform, preferredVersion } from '$lib/utils/references';
 
-	$: expandable = $page.url.pathname.startsWith('/docs/references/');
+	export let expandable = false;
+
 	$: prefix = `/docs/references/${$preferredVersion ?? $page.params?.version ?? 'cloud'}/${
 		$preferredPlatform ?? $page.params?.platform ?? 'client-web'
 	}`;

src/routes/docs/references/[version]/[platform]/[service]/+layout.svelte

@@ -0,0 +1,7 @@
+<script lang="ts">
+	import Layout from '../../../Layout.svelte';
+</script>
+
+<Layout expandable>
+	<slot />
+</Layout>

src/routes/docs/references/[version]/[platform]/[service]/+page.svelte

@@ -181,19 +181,30 @@
 										<div class="aw-card is-transparent u-padding-16 u-margin-block-start-16">
 											<ul>
 												{#each method.responses as response}
-													<li>
-														<article>
-															<header class="u-flex u-cross-baseline u-gap-8">
-																<h3 class="aw-eyebrow aw-u-color-text-primary">
-																	{response.code}
-																</h3>
-																<span class="aw-caption-400">{response.model?.name}</span>
-															</header>
-															<p class="aw-sub-body-400 u-margin-block-start-16">
-																<a href="#">Payload <span class="icon-cheveron-right" /></a>
-															</p>
-														</article>
-													</li>
+													{#if response.models}
+														<li>
+															<article>
+																<header class="u-flex u-cross-baseline u-gap-8">
+																	<h3 class="aw-eyebrow aw-u-color-text-primary">
+																		{response.code}
+																	</h3>
+																	<span class="aw-caption-400">application/json</span>
+																</header>
+																<ul class="aw-sub-body-400 u-margin-block-start-16">
+																	{#each response.models as model}
+																		<li>
+																			<a
+																				class="aw-link"
+																				href={`/docs/references/${$page.params.version}/models/${model.id}`}
+																			>
+																				{model.name}
+																			</a>
+																		</li>
+																	{/each}
+																</ul>
+															</article>
+														</li>
+													{/if}
 												{/each}
 											</ul>
 										</div>

src/routes/docs/references/[version]/models/[model]/+layout.svelte

@@ -0,0 +1,7 @@
+<script>
+	import Layout from '../../../Layout.svelte';
+</script>
+
+<Layout>
+	<slot />
+</Layout>