refactor: merging all docs into a single repository

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '21 7 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/deployment.yml

@@ -13,13 +13,8 @@ on:
       - main
 jobs:
   test_linux:
-    name: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-20.04]
-        # os: [ubuntu-18.04, ubuntu-20.04]
-    runs-on: ${{ matrix.os }}
+    name: Ubuntu
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1

.gitignore

@@ -59,7 +59,6 @@ coverage
 demo/vendor.js
 
 # AMF models
-/demo/*.json
-!demo/apis.json
+demo/models/
 
-.idea/
+.idea/

.vscode/settings.json

@@ -1,11 +1,19 @@
 {
   "cSpell.words": [
-    "Applian",
-    "Nexmo",
-    "Tryit",
     "apiserverchanged",
+    "Applian",
+    "contentinfo",
+    "dompurify",
+    "fasttext",
+    "mimechange",
     "monostate",
+    "Nexmo",
     "notryit",
-    "serverscountchanged"
+    "serverscountchanged",
+    "signedup",
+    "stevetest",
+    "Tryit",
+    "Unionable",
+    "xone"
   ]
-}
+}

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 7.0.0
+
+### ApiResourceDocumentationElement (former api-endpoint-documentation)
+
+The `api-resource-document` element has the following properties changes compared to deprecated `api-endpoint-documentation`
+
+- `noTryIt` is renamed to `tryItButton`. When `tryItButton` is set then the try it button in operations is rendered.
+- `inlineMethods` is renamed to `tryItPanel`. Has the same function.
+- `noUrlEditor` is now renamed to `urlEditor`. When `urlEditor` is set then the HTTP request editor renders the URL editor input field.
+
+### ApiOperationDocumentElement (former api-operation-documentation)
+
+- `tryIt` is renamed to `tryItButton`
+- `tryItButton` is always set to `false` when `tryItPanel` is set on the resource document element.

TODO.md

@@ -0,0 +1,16 @@
+
+# TODO
+
+- ~~Add "try it" button~~
+- ~~Sync the Operation template~~
+- ~~Sync the Endpoint template~~
+- ~~Sync the Schema template~~
+- ~~Sync the Response template~~
+- ~~Sync the Payload template~~
+- ~~Render the request editor side-by-side~~
+- ~~Fix the `(unknown path)` in the operation~~
+- ~~Rendering of fragments and the partial model~~
+- ~~main `api-documentation` element~~
+- ~~replace body content type selector with radio buttons like in the request editor~~
+- ~~move the `api-summary` element~~
+- Tests

api-annotation-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiAnnotationDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-annotation-document": Element;
+  }
+}

api-annotation-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiAnnotationDocumentElement.js';
+
+window.customElements.define('api-annotation-document', Element);

api-channel-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiChannelDocumentationElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-channel-document": Element;
+  }
+}

api-channel-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiChannelDocumentationElement.js';
+
+window.customElements.define('api-channel-document', Element);

api-documentation-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiDocumentationDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-documentation-document": Element;
+  }
+}

api-documentation-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiDocumentationDocumentElement.js';
+
+window.customElements.define('api-documentation-document', Element);

api-documentation.d.ts

@@ -1,7 +1,7 @@
-import { ApiDocumentationElement } from './src/ApiDocumentationElement';
+import Element from './src/elements/ApiDocumentationElement';
 
 declare global {
   interface HTMLElementTagNameMap {
-    "api-documentation": ApiDocumentationElement;
+    "api-documentation": Element;
   }
 }

api-documentation.js

@@ -1,3 +1,3 @@
-import { ApiDocumentationElement } from './src/ApiDocumentationElement.js';
+import Element from './src/elements/ApiDocumentationElement.js';
 
-window.customElements.define('api-documentation', ApiDocumentationElement);
+window.customElements.define('api-documentation', Element);

api-operation-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiOperationDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-operation-document": Element;
+  }
+}

api-operation-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiOperationDocumentElement.js';
+
+window.customElements.define('api-operation-document', Element);

api-parameter-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiParameterDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-parameter-document": Element;
+  }
+}

api-parameter-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiParameterDocumentElement.js';
+
+window.customElements.define('api-parameter-document', Element);

api-parametrized-security-scheme.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiParametrizedSecuritySchemeElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-parametrized-security-scheme": Element;
+  }
+}

api-parametrized-security-scheme.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiParametrizedSecuritySchemeElement.js';
+
+window.customElements.define('api-parametrized-security-scheme', Element);

api-payload-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiPayloadDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-payload-document": Element;
+  }
+}

api-payload-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiPayloadDocumentElement.js';
+
+window.customElements.define('api-payload-document', Element);

api-request-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiRequestDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-request-document": Element;
+  }
+}

api-request-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiRequestDocumentElement.js';
+
+window.customElements.define('api-request-document', Element);

api-resource-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiResourceDocumentationElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-resource-document": Element;
+  }
+}

api-resource-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiResourceDocumentationElement.js';
+
+window.customElements.define('api-resource-document', Element);

api-response-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiResponseDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-response-document": Element;
+  }
+}

api-response-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiResponseDocumentElement.js';
+
+window.customElements.define('api-response-document', Element);

api-schema-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiSchemaDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-schema-document": Element;
+  }
+}

api-schema-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiSchemaDocumentElement.js';
+
+window.customElements.define('api-schema-document', Element);

api-security-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiSecurityDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-security-document": Element;
+  }
+}

api-security-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiSecurityDocumentElement.js';
+
+window.customElements.define('api-security-document', Element);

api-security-requirement-document.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiSecurityRequirementDocumentElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-security-requirement-document": Element;
+  }
+}

api-security-requirement-document.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiSecurityRequirementDocumentElement.js';
+
+window.customElements.define('api-security-requirement-document', Element);

api-summary.d.ts

@@ -0,0 +1,7 @@
+import Element from './src/elements/ApiSummaryElement';
+
+declare global {
+  interface HTMLElementTagNameMap {
+    "api-summary": Element;
+  }
+}

api-summary.js

@@ -0,0 +1,3 @@
+import Element from './src/elements/ApiSummaryElement.js';
+
+window.customElements.define('api-summary', Element);

demo/api-annotation.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, minimum-scale=1, initial-scale=1, user-scalable=yes">
+  <title>API Annotation</title>
+  <link rel="stylesheet" href="./demo.css" />
+</head>
+
+<body class="demo styled">
+  <div id="demo"></div>
+  <script type="module" src="api-annotation.js"></script>
+</body>
+
+</html>