Merge pull request #132 from OAI/specification

PR to set up infra for publishing a respec version of moonwalk
OAI · Jun 10, 2024 · 14cc1e6 · 14cc1e6
2 parents 3123a9f + da486ca
commit 14cc1e6
Show file tree

Hide file tree

Showing 8 changed files with 2,209 additions and 0 deletions.
diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml
@@ -22,12 +22,20 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
+
   # Build job
   build:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm install respec        
+      - name: Generate Editors draft
+        shell: powershell
+        run: ./scripts/generate.ps1
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Build with Jekyll

diff --git a/doc/index.md b/doc/index.md
@@ -0,0 +1,6 @@
+# Moonwalk
+
+The OpenAPI Moonwalk [Special Interest Group](https://learn.openapis.org/glossary.html) (SIG) is working on the next major release of the OpenAPI Specification (OAS), version 4.0, with a goal of [publishing by the end of 2024](https://www.openapis.org/blog/2023/12/06/openapi-moonwalk-2024).
+
+
+[Editors Draft](moonwalk.html)
diff --git a/doc/initial-proposals/examples/FlatOperations/OperationList.yaml b/doc/initial-proposals/examples/FlatOperations/OperationList.yaml
@@ -0,0 +1,15 @@
+openapi: 4.0.0
+operations:
+  - id: GetFlat
+    name: Get
+    method: GET
+    uriTemplate: /api/v1/flat
+    description: Get a list of flat objects
+    responses:
+      - status: 200
+        description: OK
+        contentType: application/json
+        schema: 
+          type: array
+          items:
+            $ref: '#/components/schemas/Flat'
diff --git a/doc/moonwalk.html b/doc/moonwalk.html
diff --git a/scripts/Generate.ps1 b/scripts/Generate.ps1
@@ -0,0 +1,27 @@
+# Usage: .\Generate.ps1 
+
+$SpecName = "moonwalk"
+# get the folder of the script
+$ScriptFolder = Split-Path -Path $MyInvocation.MyCommand.Definition -Parent
+$SpecFolder = Join-Path -Path $ScriptFolder -ChildPath "..\specification"
+$OutputFolder = Join-Path -Path $ScriptFolder -ChildPath "..\doc"
+
+$HostFile = Join-Path -Path $SpecFolder -ChildPath ($SpecName + "-host.html")
+$SourceFile = Join-Path -Path $SpecFolder -ChildPath ($SpecName + "-source.md")
+$MergedFile = Join-Path -Path $SpecFolder -ChildPath ($SpecName + "-merged.html")
+$OutputFile = Join-Path -Path $OutputFolder -ChildPath ($SpecName + ".html")
+
+# Outer HTML template
+$template = Get-Content $HostFile
+
+# Core Markdown content
+$content = Get-Content $SourceFile -raw
+
+# Replace the content in the template
+$template = $template -replace "<!-- CONTENT -->", $content
+$template | Set-Content $MergedFile
+
+# Do Respec processing on the merged file
+& respec --src $MergedFile --out $OutputFile
+
+Remove-Item $MergedFile
diff --git a/specification/moonwalk-host.html b/specification/moonwalk-host.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<title>Moonwalk</title>
+
+<head>
+  <script src="https://www.w3.org/Tools/respec/respec-w3c" class="remove" defer></script>
+  <script class="remove" src="respecConfig.js"></script>
+</head>
+
+<body>
+<!-- CONTENT -->
+
+</body>
+
+</html>
diff --git a/specification/moonwalk-source.md b/specification/moonwalk-source.md
diff --git a/specification/respecConfig.js b/specification/respecConfig.js
@@ -0,0 +1,35 @@
+// Need to figure out how to make this https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/yaml.min.js
+// work with the example here https://github.com/speced/respec/wiki/pre-and-code-elements
+
+var respecConfig = {
+    //preProcess: [loadYaml],
+ //   isPreview: true,
+    format: "markdown",
+    noTOC: false,
+    maxTocLevel: 3,
+//    additionalCopyrightHolders: "the Linux Foundation",
+//    includePermalinks: true,
+    latestVersion: "https://spec.openapis.org/oas/v3.1.0",
+    github: {
+        repoURL: "https://github.com/OAI/sig-moonwalk/",
+        branch: "main"
+    },
+    logos:[{src:"https://raw.githubusercontent.com/OAI/OpenAPI-Style-Guide/master/graphics/bitmap/OpenAPI_Logo_Pantone.png",alt:"OpenAPI Initiative",height:48,url:"https://openapis.org/"}],
+    specStatus: "unofficial", //Use "unofficial" for unofficial drafts
+    shortName: "moonwalk-draft",  // This should become part of the latestVersion URL
+    editors: [
+      {
+        name: "TBD"
+      }
+    ],
+    localBiblio: {
+        "CommonMark": {
+            "title": "CommonMark syntax",
+            "href": "https://spec.commonmark.org/",
+            "status": "Living Standard",
+            "publisher": "John MacFarlane"
+        }
+    }
+
+  }
+