chore: initialize repository

.github/workflows/automerge.yml

@@ -17,7 +17,6 @@ on:
   pull_request_review:
     types:
       - submitted
-
 jobs:
 
   autoapprove:
@@ -56,4 +55,4 @@ jobs:
       env:
         APPROVALS: "1"
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        ADD_LABEL: "autoapproved"
+        ADD_LABEL: "autoapproved"

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+.vscode
+coverage
+lib
+*.DS_Store

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright The Linux Foundation
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -0,0 +1,41 @@
+<h5 align="center">
+  <br>
+  <a href="https://www.asyncapi.org"><img src="https://github.com/asyncapi/parser-nodejs/raw/master/assets/logo.png" alt="AsyncAPI logo" width="200"></a>
+  <br>
+  <em><b>Server API</b></em>
+</h5>
+<p align="center">
+  <em>Server API providing official AsyncAPI tools</em>
+</p>
+
+---
+
+## :loudspeaker: ATTENTION:
+
+This package is still under development and has not published and reached version 1.0.0 yet. This means that its API may contain breaking changes until we're able to deploy the first stable version and begin semantic versioning.
+
+---
+
+<!-- toc is generated with GitHub Actions do not remove toc markers -->
+
+<!-- toc -->
+
+- [Requirements](#requirements)
+- [Development](#development)
+- [Contributing](#contributing)
+
+<!-- tocstop -->
+
+## Requirements
+
+- [NodeJS](https://nodejs.org/en/) >= 14
+
+## Development
+
+1. Setup project by installing dependencies `npm install`
+2. Write code and tests.
+3. Make sure all tests pass `npm test`
+
+## Contributing
+
+Read [CONTRIBUTING](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) guide.

openapi.yaml

@@ -0,0 +1,132 @@
+openapi: 3.1.0
+
+info:
+  version: 0.1.0
+  title: AsyncAPI Server API
+  description: Server API providing official AsyncAPI tools
+  contact:
+    name: AsyncAPI Initiative
+    email: [email protected]
+    url: https://asyncapi.com/
+  license:
+    name: Apache 2.0
+    url: https://www.apache.org/licenses/LICENSE-2.0.html
+
+servers:
+  - url: https://api.asyncapi.com/v1
+
+paths:
+  /generator:
+    post:
+      summary: Generate the given AsyncAPI template.
+      operationId: generateTemplate
+      tags:
+        - generator
+        - template
+      externalDocs:
+        name: Website for the AsyncAPI Generator
+        url: https://www.asyncapi.com/tools/generator
+      requestBody:
+        description: Template details to be generated.
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Template'
+      responses:
+        '200':
+          description: Template succesfully generated.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Template'
+        '400':
+          description: Failed to generate the given template due to invalid AsyncAPI document.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Problem'
+        '422':
+          description: Failed to generate the given template due to invalid parameters.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Problem'
+        default:
+          description: Unexpected problem.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Problem'
+
+components:
+  schemas:
+    AsyncAPIDocument:
+      description: AsyncAPI document in JSON or YAML
+      type: # can be sent as normal JSON or stringified JSON/YAML
+        - string 
+        - object
+      minLength: 1
+      minProperties: 1
+      additionalProperties: true
+    Template:
+      type: object
+      required:
+        - asyncapi
+        - template
+      properties:
+        asyncapi:
+          $ref: '#/components/schemas/AsyncAPIDocument'
+        template:
+          type: string
+          description: Template name to be generated.
+          enum:
+            - 'html'
+            - 'markdown'
+        parameters:
+          type: object
+          description: |
+            Template parameters to be generated. Each template has different parameters that you should check in the documentation, 
+            which is usually located in the template's repository.
+            This field is optional but may be required for some templates.
+          minProperties: 1
+          additionalProperties: true
+    Problem:
+      type: object
+      properties:
+        type:
+          type: string
+          format: uri
+          description: |
+            An absolute URI that identifies the problem type. When dereferenced,
+            it SHOULD provide human-readable documentation for the problem type
+            (e.g., using HTML).
+          default: 'about:blank'
+          example: 'https://api.asyncapi.com/problem/invalid-template-parameters'
+        title:
+          type: string
+          description: |
+            A short, summary of the problem type. Written in english and readable.
+          example: Invalid AsyncAPI document.
+        status:
+          type: integer
+          format: int32
+          description: |
+            The HTTP status code generated by the origin server for this occurrence
+            of the problem.
+          minimum: 100
+          maximum: 600
+          exclusiveMaximum: true
+          example: 422
+        detail:
+          type: string
+          description: |
+            A human readable explanation specific to this occurrence of the problem.
+          example: Connection to database timed out
+        instance:
+          type: string
+          format: uri
+          description: |
+            An absolute URI that identifies the specific occurrence of the problem.
+            It may or may not yield further information if dereferenced.
+      additionalProperties: true