Merge pull request #106 from polyphony-chat/typespec

TypeSpec

Author: bitfl0wer

.gitattributes

@@ -1,3 +1,4 @@
 *.md linguist-detectable
 styles/* linguist-vendored
-styles/config linguist-detectable
+styles/config linguist-detectable
+*.tsp linguist-language=TypeSpec

.github/dependabot.yml

@@ -9,4 +9,10 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
-      
+  - package-ecosystem: "npm"
+    directories:
+      - "/api/core"
+      - "/api/auth"
+      - "/api/chat"
+    schedule:
+      interval: "weekly"

.github/workflows/deploy.yml .github/workflows/deploy-docs-site.yml.github/workflows/deploy.yml renamed to .github/workflows/deploy-docs-site.yml

@@ -0,0 +1,37 @@
+name: Build and Deploy OpenAPI configuration
+on:
+    push:
+      branches:
+        - main
+    workflow_dispatch: 
+permissions:
+  contents: write
+jobs:
+    build_and_deploy:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+            with:
+              fetch-depth: 0
+          - name: Configure git Credentials
+            run: |
+                git config user.name github-actions[bot]
+                git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          - uses: actions/setup-node@v4
+            with:
+              node-version: "lts/*"
+              cache: "npm"
+              cache-dependency-path: "./api/core/package-lock.json"
+          - name: Install TypeSpec and compile project
+            run: |
+              cd ./api/src/core/
+              npm install -g @typespec/compiler
+              npm install
+              tsp compile .
+          - name: Commit OpenAPI specification to repository
+            run: |
+              cd ../../
+              mv ./src/core/tsp-output/@typespec/openapi3/openapi.v1.0.yaml ./build/core-openapi3.yaml
+              git add ./build/*
+              git commit -m "[bot]update openapi3 schema"
+              git push

.github/workflows/deploy-openapi-spec.yml

@@ -1,3 +1,11 @@
+# typespec
+
+# Default TypeSpec output
+dist/
+
+# Dependency directories
+node_modules/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -8,7 +16,6 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-build/
 develop-eggs/
 dist/
 downloads/

.gitignore

@@ -3,6 +3,7 @@
         "davidanson.vscode-markdownlint",
         "chrischinchilla.vale-vscode",
         "valentjn.vscode-ltex",
-        "gruntfuggly.todo-tree"
+        "gruntfuggly.todo-tree",
+        "typespec.typespec-vscode"
     ]
 }

.vscode/extensions.json

@@ -19,3 +19,6 @@ polyproto-auth
 CAs
 TTLs
 NLnet
+OpenAPI
+TypeSpec
+Protobuf

.vscode/ltex.dictionary.en-US.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 polyphony
+Copyright (c) 2023 The "polyphony-chat" GitHub Organization and all "docs" repository contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -5,10 +5,15 @@ Built with mkdocs-material and python3.12
 
 ## File structure
 
-The `/docs` folder has the specification documents for the polyproto protocol. The `docs/APIs` folder houses the API documentation for the polyproto-core and polyphony-chat reference implementation.
+The `/docs` folder has the specification documents for the polyproto protocol.
 
 The `/snippets` folder has snippets of text used in many places in the documentation. This is to ensure consistency across the documentation. Error messages appearing in many places are also stored in the `/snippets/errors` folder.
 
+API documentation in form of [TypeSpec](https://typespec.io) files can be found in the `/api` directory.
+TypeSpec can compile to OpenAPI3, JSON Schema and Protobuf. Our TypeSpec project is targeting OpenAPI3
+output. Read the TypeSpec documentation for information on how to compile TypeSpec or use a pre-compiled
+version of the OpenAPI schema if you'd like.
+
 ## Contributing
 
 The best way to contribute is to open an issue if you find any problems with the documentation. Creating an issue is generally the best way to contribute to any open source project. Issues allow for an exchange between contributors and maintainers to discuss the viability of implementing an issue, usually minimizing frustration.

README.md

@@ -0,0 +1,3 @@
+# polyproto OpenAPI3 specification
+
+This folder contains pre-compiled OpenAPI3 specification documents for polyproto.