Test AutoTypeTable

carrismetropolitana · Jan 2, 2025 · bab6e2b · bab6e2b
1 parent 633ccd0
commit bab6e2b
Show file tree

Hide file tree

Showing 26 changed files with 361 additions and 9 deletions.
diff --git a/app/[[...slug]]/page.tsx b/app/[[...slug]]/page.tsx
@@ -1,6 +1,7 @@
 /* * */
 
 import { source } from '@/lib/source';
+import { createTypeTable } from 'fumadocs-typescript/ui';
 import defaultMdxComponents from 'fumadocs-ui/mdx';
 import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/page';
 import { notFound } from 'next/navigation';
@@ -33,6 +34,8 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }>
 
 	const MDX = page.data.body;
 
+	const { AutoTypeTable } = createTypeTable();
+
 	return (
 		<DocsPage
 			full={page.data.full}
@@ -43,7 +46,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }>
 			<DocsTitle>{page.data.title}</DocsTitle>
 			<DocsDescription>{page.data.description}</DocsDescription>
 			<DocsBody>
-				<MDX components={{ ...defaultMdxComponents }} />
+				<MDX components={{ ...defaultMdxComponents, AutoTypeTable }} />
 			</DocsBody>
 		</DocsPage>
 	);

diff --git a/content/api/meta.json b/content/api/meta.json
@@ -1,9 +1,7 @@
 {
 	"pages": [
 		"index",
-		"network",
-		"facilities",
-		"locations",
-		"metrics"
+		"v2",
+		"v1"
 	]
 }
diff --git a/content/api/facilities/index.mdx → content/api/v1/facilities/index.mdx b/content/api/facilities/index.mdx → content/api/v1/facilities/index.mdx
diff --git a/content/api/facilities/patterns.mdx → content/api/v1/facilities/patterns.mdx b/content/api/facilities/patterns.mdx → content/api/v1/facilities/patterns.mdx
diff --git a/content/api/facilities/stops.mdx → content/api/v1/facilities/stops.mdx b/content/api/facilities/stops.mdx → content/api/v1/facilities/stops.mdx
diff --git a/content/api/v1/index.mdx b/content/api/v1/index.mdx
@@ -0,0 +1,21 @@
+---
+title: Version 1
+description: Administrative divisions of amL.
+---
+
+## Data source
+
+Locations are fetched from the GTFS and are not georeferenced. We plan to improve this in the future.
+
+
+## Available locations
+
+The API provides in JSON format the following locations:
+
+| Type           | Description                                                                                                                                                                                                                                     |
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Regions        | Regions are the top-level division in the API. At the moment there are 3 regions: `amL`, `Àlentejo Central` and `Oeste`. Regions are identified by their NUTS-III code.                                                                         |
+| Districts      | Districts belong to a region and are identified by their DICOFRE code.                                                                                                                                                                          |
+| Municipalities | Municipalities belong to a district and are identified by their DICOFRE code. All geographical data points in the API are identified by at least one Municipality. It is the "primary key" for the location types.                              |
+| Parishes       | Parishes are optional and represent the administrative division known as "freguesia". They are identified by their DICOFRE code. At the moment, not many objects are identified with this location type. We plan to improve this in the future. |
+| Localities     | Localities are informal places known to local populations. We use this to diferentiate the location of similarly named objects. Objects may not have localities.                                                                                |
diff --git a/content/api/locations.mdx → content/api/v1/locations.mdx b/content/api/locations.mdx → content/api/v1/locations.mdx
diff --git a/content/api/metrics/index.mdx → content/api/v1/metrics/index.mdx b/content/api/metrics/index.mdx → content/api/v1/metrics/index.mdx
diff --git a/content/api/metrics/patterns.mdx → content/api/v1/metrics/patterns.mdx b/content/api/metrics/patterns.mdx → content/api/v1/metrics/patterns.mdx
diff --git a/content/api/metrics/stops.mdx → content/api/v1/metrics/stops.mdx b/content/api/metrics/stops.mdx → content/api/v1/metrics/stops.mdx
diff --git a/content/api/network/index.mdx → content/api/v1/network/index.mdx b/content/api/network/index.mdx → content/api/v1/network/index.mdx
diff --git a/content/api/network/patterns.mdx → content/api/v1/network/patterns.mdx b/content/api/network/patterns.mdx → content/api/v1/network/patterns.mdx
diff --git a/content/api/network/stops.mdx → content/api/v1/network/stops.mdx b/content/api/network/stops.mdx → content/api/v1/network/stops.mdx
diff --git a/content/api/v2/facilities/index.mdx b/content/api/v2/facilities/index.mdx
@@ -0,0 +1,24 @@
+---
+title: facilities
+description: Places Carris Metropolitana serves.
+---
+
+## Data sources
+
+The data source for all endpoints in this collection is the [datasets repo](https://github.com/carrismetropolitana/datasets), where we provide georeferenced data in CSV format. [Learn more about Datasets](/datasets)
+
+
+## Available facilities
+
+The API provides the following facilities in JSON format. The facility name links to its dataset page with more information.
+
+| Facility                                                        | Description                                                                                                                                                                                                      |
+|-----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [stores](/datasets/facilities/stores)                           | navegante® stores where you can take care of any public transit related matter, such as buying a card, recharding, activate discounts, etc. This endpoint also returns how many people are queueing in realtime. |
+| [helpdesks](/datasets/facilities/helpdesks)                     | All help points for all public transit operators in amL.                                                                                                                                                         |
+| [schools](/datasets/facilities/schools)                         | All schools in amL, georeferenced. Updated regularly.                                                                                                                                                            |
+| [boat_station](/datasets/facilities/boat_stations)              | All public transit boat stations in amL.                                                                                                                                                                         |
+| [light_rail_stations](/datasets/facilities/light_rail_stations) | All public transit light rail stations in amL.                                                                                                                                                                   |
+| [subway_stations](/datasets/facilities/subway_stations)         | All public transit subway stations in amL.                                                                                                                                                                       |
+| [train_stations](/datasets/facilities/train_stations)           | All public transit train stations in amL.                                                                                                                                                                        |
+| [pips](/datasets/facilities/pips)                               | All Carris Metropolitana public information panels and their status.                                                                                                                                             |
diff --git a/content/api/v2/facilities/patterns.mdx b/content/api/v2/facilities/patterns.mdx
@@ -0,0 +1,17 @@
+---
+title: Lines, Routes & Patterns
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/facilities/stops.mdx b/content/api/v2/facilities/stops.mdx
@@ -0,0 +1,17 @@
+---
+title: Stops
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/index.mdx b/content/api/v2/index.mdx
@@ -0,0 +1,21 @@
+---
+title: Version 2 (latest)
+description: Administrative divisions of amL.
+---
+
+## Data source
+
+<AutoTypeTable path="./node_modules/@carrismetropolitana/api-types/src/api/alerts.ts" name="Alert" />
+
+
+## Available locations
+
+The API provides in JSON format the following locations:
+
+| Type           | Description                                                                                                                                                                                                                                     |
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Regions        | Regions are the top-level division in the API. At the moment there are 3 regions: `amL`, `Àlentejo Central` and `Oeste`. Regions are identified by their NUTS-III code.                                                                         |
+| Districts      | Districts belong to a region and are identified by their DICOFRE code.                                                                                                                                                                          |
+| Municipalities | Municipalities belong to a district and are identified by their DICOFRE code. All geographical data points in the API are identified by at least one Municipality. It is the "primary key" for the location types.                              |
+| Parishes       | Parishes are optional and represent the administrative division known as "freguesia". They are identified by their DICOFRE code. At the moment, not many objects are identified with this location type. We plan to improve this in the future. |
+| Localities     | Localities are informal places known to local populations. We use this to diferentiate the location of similarly named objects. Objects may not have localities.                                                                                |
diff --git a/content/api/v2/locations.mdx b/content/api/v2/locations.mdx
@@ -0,0 +1,21 @@
+---
+title: locations
+description: Administrative divisions of amL.
+---
+
+## Data source
+
+Locations are fetched from the GTFS and are not georeferenced. We plan to improve this in the future.
+
+
+## Available locations
+
+The API provides in JSON format the following locations:
+
+| Type           | Description                                                                                                                                                                                                                                     |
+|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Regions        | Regions are the top-level division in the API. At the moment there are 3 regions: `amL`, `Àlentejo Central` and `Oeste`. Regions are identified by their NUTS-III code.                                                                         |
+| Districts      | Districts belong to a region and are identified by their DICOFRE code.                                                                                                                                                                          |
+| Municipalities | Municipalities belong to a district and are identified by their DICOFRE code. All geographical data points in the API are identified by at least one Municipality. It is the "primary key" for the location types.                              |
+| Parishes       | Parishes are optional and represent the administrative division known as "freguesia". They are identified by their DICOFRE code. At the moment, not many objects are identified with this location type. We plan to improve this in the future. |
+| Localities     | Localities are informal places known to local populations. We use this to diferentiate the location of similarly named objects. Objects may not have localities.                                                                                |
diff --git a/content/api/v2/metrics/index.mdx b/content/api/v2/metrics/index.mdx
@@ -0,0 +1,17 @@
+---
+title: metrics
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/metrics/patterns.mdx b/content/api/v2/metrics/patterns.mdx
@@ -0,0 +1,17 @@
+---
+title: Lines, Routes & Patterns
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/metrics/stops.mdx b/content/api/v2/metrics/stops.mdx
@@ -0,0 +1,17 @@
+---
+title: Stops
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/network/index.mdx b/content/api/v2/network/index.mdx
@@ -0,0 +1,17 @@
+---
+title: network
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/network/patterns.mdx b/content/api/v2/network/patterns.mdx
@@ -0,0 +1,17 @@
+---
+title: Lines, Routes & Patterns
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>
diff --git a/content/api/v2/network/stops.mdx b/content/api/v2/network/stops.mdx
@@ -0,0 +1,17 @@
+---
+title: Stops
+description: Carris Metropolitana bus network endpoints.
+---
+
+## Code Block
+
+```js
+console.log('Hello World');
+```
+
+## Cards
+
+<Cards>
+  <Card title="Learn more about Next.js" href="https://nextjs.org/docs" />
+  <Card title="Learn more about Fumadocs" href="https://fumadocs.vercel.app" />
+</Cards>