@team-supercharge/oasg 16.1.0 → 16.3.0-feature-aspdotnetcore-generator-f6a57a17.0

package/README.md

@@ -121,6 +121,7 @@ The table below gives an overview of the changes (breaking, non-breaking, bug fi
 | `flutter`                    |➖  |➖  |➖  |🆕  |
 | `ios`                        |➖  |➖  |➖  |💥  |🐛  |➖  |➖  |➖  |✨  |➖  |💥  |➖  |➖  |✨  |🆕  |
 | `kmp`                        |➖  |➖  |🆕  |
+| `python`                     |🆕  |
 | `python-legacy`              |💥  |➖  |🐛  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
 | `react`                      |➖  |🐛  |➖  |💥  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |➖  |🆕  |
 | `typescript-axios`           |🆕  |
@@ -724,6 +725,25 @@ TBD
 | formatterCustomArgs | Custom arguments of the `ktlint` formatter | N | --disabled_rules=no-wildcard-imports,max-line-length,enum-entry-name-case |
 | repository | URL of the Maven Repository | N | - |
 
+#### `python`
+
+```json
+{
+  "id": "client-python",
+  "type": "python",
+  "source": "source-merged",
+  "packageName": "oasg_example",
+  "repositoryUrl": "https://gitlab.supercharge.io/api/v4/projects/1226/packages/pypi"
+}
+```
+
+|Parameter| Description| Required | Default |
+|-|-|-|-|
+| packageName | Package nem for the project (convention: snake_case) | Y | - |
+| repositoryUrl | URL of the PyPI repository | Y | - |
+
+Publishing the PyPI packages is done with Twine. For authentication against the PiPI repository you need to set the `TWINE_USERNAME` and `TWINE_PASSWORD` environment variables.
+
 #### `python-legacy`
 
 ```json
@@ -986,6 +1006,27 @@ Validations from OpenAPI spec:
 | packageName | Name of the generated package | Y | - |
 | generatorCustomArgs | Custom arguments of the generator (--global-property, --additional-properties) | N | - |
 
+#### `dotnet-webapi`
+
+```json
+{
+  "id": "dotnet-webapi",
+  "type": "dotnet-webapi",
+  "source": "source-merged",
+  "sourceUrl": "https://api.nuget.org/v3/index.json",
+  "apiKey": "apiKey",
+  "packageName": "packageName",
+  "generatorCustomArgs": "--global-property=supportingFiles,modelDocs --additional-properties=nullableReferenceTypes=false"
+}
+```
+
+| Parameter           | Description                                                                    | Required | Default |
+| ------------------- | ------------------------------------------------------------------------------ | -------- | ------- |
+| sourceUrl           | Url to where the package will be published                                     | Y        | -       |
+| apiKey              | Api key of nuget source                                                        | Y        | -       |
+| packageName         | Name of the generated package                                                  | Y        | -       |
+| generatorCustomArgs | Custom arguments of the generator (--global-property, --additional-properties) | N        | -       |
+
 #### `postman`
 
 ```json

package/bin/merger.js

@@ -181,12 +181,16 @@ function updateReferences(document, oldValue, newValue) {
 
 function mergeDocument(leftDoc, rightDoc) {
   // not overriding: info, externalDocs (always from first file)
-  // not merging: servers, webhooks, security
+  // not merging: servers, security
 
   // paths
   const mergedPaths = { ...leftDoc.paths, ...rightDoc.paths };
   leftDoc.paths = mergedPaths;
 
+  // webhooks
+  const mergedWebhooks = { ...leftDoc.webhooks, ...rightDoc.webhooks };
+  leftDoc.webhooks = mergedWebhooks;
+
   // components
   const mergedSchemas = { ...leftDoc.components.schemas, ...rightDoc.components.schemas };
   const mergedResponses = { ...leftDoc.components.responses, ...rightDoc.components.responses };

package/bin/oasg

@@ -36,12 +36,13 @@ const PROXY_PORT = '9999';
 const DEFAULT_GENERATOR_MAPPING = {
   // client targets
   "android":                      { version: '7.0.1',   generator: 'kotlin' },
-  "angular":                      { version: '7.0.1',   generator: 'typescript-angular' },
+  "angular":                      { version: '7.11.0',  generator: 'typescript-angular' },
   "feign":                        { version: '7.0.1',   generator: 'spring' },
   "feign-kotlin":                 { version: '7.0.1',   generator: 'kotlin-spring' },
   "flutter":                      { version: '7.0.1',   generator: 'dart-dio' },
   "ios":                          { version: '7.0.1',   generator: 'swift5' },
   "kmp":                          { version: '7.8.0',   generator: 'kotlin' },
+  "python":                       { version: '7.11.0',  generator: 'python' },
   "python-legacy":                { version: '7.11.0',  generator: 'python-pydantic-v1' },
   "react":                        { version: '7.0.1',   generator: 'typescript-fetch' },
   "typescript-axios":             { version: '7.11.0',  generator: 'typescript-axios' },
@@ -53,6 +54,7 @@ const DEFAULT_GENERATOR_MAPPING = {
   "python-fastapi":               { version: '7.8.0',   generator: 'python-fastapi' },
   "python-fastapi-raw-request":   { version: '7.0.1',   generator: 'python-fastapi' },
   "dotnet":                       { version: '7.8.0',   generator: 'csharp-functions' },
+  "dotnet-webapi":                { version: '7.8.0',   generator: 'aspnetcore' },
   // misc targets
   "contract-testing":             { version: '4.3.1',   generator: 'typescript-node' },
   "openapi":                      { version: undefined, generator: undefined },

package/bin/process-source.js

@@ -69,13 +69,14 @@ async function processSource(source, sourceFile, version) {
   // clean up unused things
   if (source.cleanup) {
     const removedPaths = [];
+    const removedWebhooks = [];
     const removedTags = [];
     const usedTags = [];
 
     // remove empty paths & gather tags
     const paths = document.paths || {};
     for (const pathKey in paths) {
-      const path = document.paths[pathKey];
+      const path = paths[pathKey];
 
       if (Object.keys(path).length === 0) {
         removedPaths.push(pathKey);
@@ -97,10 +98,39 @@ async function processSource(source, sourceFile, version) {
       }
     }
 
+    // remove empty webhooks & gather tags
+    const webhooks = document.webhooks || {};
+    for (const webhookKey in webhooks) {
+      const webhook = webhooks[webhookKey];
+
+      if (Object.keys(webhook).length === 0) {
+        removedWebhooks.push(webhookKey);
+        delete webhooks[webhookKey];
+      }
+
+      for (const methodKey in webhook) {
+        const maybeOperation = webhook[methodKey];
+
+        if (!maybeOperation.tags) {
+          continue;
+        }
+
+        maybeOperation.tags.forEach(tag => {
+          if (!usedTags.includes(tag)) {
+            usedTags.push(tag);
+          }
+        });
+      }
+    }
+
     if (removedPaths.length !== 0) {
       console.log(`cleaned up unused paths:\n  ${removedPaths.join('\n  ')}`);
     }
 
+    if (removedWebhooks.length !== 0) {
+      console.log(`cleaned up unused webhooks:\n  ${removedWebhooks.join('\n  ')}`);
+    }
+
     // remouve unused tags
     const tags = [...document.tags];
     tags.forEach(tag => {

package/config.schema.yml

@@ -19,6 +19,7 @@ properties:
         - $ref: '#/targets/Stubby'
         - $ref: '#/targets/Android'
         - $ref: '#/targets/ios'
+        - $ref: '#/targets/Python'
         - $ref: '#/targets/PythonLegacy'
         - $ref: '#/targets/PythonFastApi'
         - $ref: '#/targets/PythonFastApiRawRequest'
@@ -28,6 +29,7 @@ properties:
         - $ref: '#/targets/Flutter'
         - $ref: '#/targets/Kmp'
         - $ref: '#/targets/Dotnet'
+        - $ref: '#/targets/DotnetWebApi'
         - $ref: '#/targets/Postman'
         - $ref: '#/targets/TypeScriptAxios'
         - $ref: '#/targets/TypeScriptFetch'
@@ -288,6 +290,20 @@ targets:
         - repository
         - interfaceType
 
+  Python:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: "^python$"
+          packageName:
+            type: string
+          repositoryUrl:
+            type: string
+        required:
+        - packageName
+        - repositoryUrl
+
   PythonLegacy:
     allOf:
       - $ref: '#/targets/Base'
@@ -398,6 +414,23 @@ targets:
           - apiKey
           - packageName
 
+  DotnetWebApi:
+    allOf:
+      - $ref: '#/targets/Base'
+      - properties:
+          type:
+            pattern: '^dotnet-webapi$'
+          sourceUrl:
+            type: string
+          apiKey:
+            type: string
+          packageName:
+            type: string
+        required:
+          - sourceUrl
+          - apiKey
+          - packageName    
+
   Kmp:
     allOf:
       - $ref: '#/targets/Base'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@team-supercharge/oasg",
-  "version": "16.1.0",
+  "version": "16.3.0-feature-aspdotnetcore-generator-f6a57a17.0",
   "description": "Node-based tool to lint OpenAPI documents and generate clients, servers and documentation from them",
   "author": "Supercharge",
   "license": "MIT",

package/targets/aspdotnetcore/generate.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+java -jar $binary generate \
+  -g $generatorId \
+  -i $openApiFile \
+  -t $templateDir \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -p "packageVersion=$version,packageName=$packageName" \
+  $generatorCustomArgs

package/targets/aspdotnetcore/generator-config.json

@@ -0,0 +1,23 @@
+{
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  },
+  "globalProperties": {
+    "models": "",
+    "supportingFiles": "",
+    "modelDocs": ""
+  },
+  "additionalProperties": {
+    "aspnetCoreVersion": "8.0",
+    "operationIsAsync": true,
+    "buildTarget": "library",
+    "generateBody": false,
+    "useDateTimeOffset": true,
+    "nullableReferenceTypes": true,
+    "operationResultTask": true,
+    "enumNameSuffix": "",
+    "enumValueSuffix": ""
+  }
+}

package/targets/aspdotnetcore/publish.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+
+# pack
+dotnet restore
+dotnet build -c Release
+dotnet pack -c Release -p:Version=$version -p:IsPackable=true
+
+isWindows=false
+if [[ "$OSTYPE" == "cygwin"* ]] || [[ "$OSTYPE" == "msys"* ]]; then
+    isWindows=true
+fi
+storePasswordOption=$([[ $isWindows == true ]] && echo "" || echo "--store-password-in-clear-text")
+
+# publish
+echo "<?xml version=\"1.0\" encoding=\"utf-8\"?><configuration></configuration>" > nuget.config
+dotnet nuget add source "${sourceUrl}" -n Feed -u User -p "${apiKey}" --configfile nuget.config $storePasswordOption
+dotnet nuget push "src/**/bin/Release/*.nupkg" -s ${sourceUrl} -k AZ
+
+cd ../..

package/targets/python/generate.sh

@@ -0,0 +1,25 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+# if the version contains a `-` character, then use PEP 440 beta version syntax
+# example: 1.0.0-beta.1 -> 1.0.0b0+beta.1
+if [[ $version == *"-"* ]]; then
+  version=$(echo $version | sed 's/-/b0+/')
+  echo "[NOTE] version updated to: ${version}"
+fi
+
+rm -rf out/$targetId
+mkdir -p out/$targetId
+
+java -jar $binary generate \
+  -g $generatorId \
+  -i $openApiFile \
+  -t $templateDir \
+  -o out/$targetId \
+  -c $(dirname "$0")/generator-config.json \
+  -p "packageVersion=$version,packageName=$packageName" $generatorCustomArgs
+
+cd out/$targetId
+python3 setup.py sdist bdist_wheel
+cd ../../

package/targets/python/generator-config.json

@@ -0,0 +1,8 @@
+{
+  "library": "urllib3",
+  "inlineSchemaOptions": {
+    "ARRAY_ITEM_SUFFIX": "",
+    "MAP_ITEM_SUFFIX": "",
+    "SKIP_SCHEMA_REUSE": "true"
+  }
+}

package/targets/python/publish.sh

@@ -0,0 +1,7 @@
+#/bin/bash
+
+source $(dirname "$0")/../common.sh
+
+cd out/$targetId
+python3 -m twine upload --repository-url $repositoryUrl dist/*
+cd ../..