Adds OSEG for example generation from JSON

Author: jtreminio-dropbox

oseg/.editorconfig

@@ -0,0 +1,5 @@
+[{*.yml,*.yaml,*.md}]
+indent_style = space
+indent_size = 2
+[*.py]
+indent_size = 4

oseg/.gitignore

@@ -0,0 +1,65 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

oseg/Dockerfile

@@ -0,0 +1,36 @@
+FROM ghcr.io/astral-sh/uv:python3.13-alpine
+LABEL maintainer="Dropbox Sign <apisupport@hellosign.com>"
+
+# Install the project into `/app`
+WORKDIR /app
+
+# Enable bytecode compilation
+ENV UV_COMPILE_BYTECODE=1
+
+# Copy from the cache instead of linking since it's a mounted volume
+ENV UV_LINK_MODE=copy
+
+# Install the project's dependencies using the lockfile and settings
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --frozen --no-install-project --no-dev
+
+# Then, add the rest of the project source code and install it
+# Installing separately from its dependencies allows optimal layer caching
+ADD ./pyproject.toml /app/pyproject.toml
+ADD ./uv.lock /app/uv.lock
+ADD ./oseg /app/oseg
+ADD ./static /app/static
+ADD ./LICENSE /app/LICENSE
+ADD ./README.md /app/README.md
+ADD ./run.py /app/run.py
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --frozen --no-dev
+
+# Place executables in the environment at the front of the path
+ENV PATH="/app/.venv/bin:$PATH"
+
+# Reset the entrypoint, don't invoke `uv`
+ENTRYPOINT ["python", "/app/run.py"]

oseg/README.md

@@ -0,0 +1,69 @@
+# OSEG - OpenAPI SDK Example Generator
+
+Create (almost) ready to use SDK snippets for SDKs generated using [openapi-generator](https://openapi-generator.tech/) using example data from your OpenAPI spec.
+
+## Where does the example data come from?
+
+Example data used to generate the code snippets can come from a number of places:
+
+* example or examples values in schema
+* default values in schema
+* Externally referenced JSON files defined in schema
+* You can also create a JSON file with examples for all the endpoints you want
+
+OSEG currently generates one code snippet file per `requestBody` definition, but only a single example per `parameters` definition.
+
+In other words, you can generate multiple examples of the same operation/endpoint by having multiple `requestBody` definitions. Each generate example will have different data embedded within it. However, since `parameters` is tied to a single operation, the same data will apply to any and all `requestBody` definitions.
+
+If you use a custom JSON file with examples you can define as many examples per endpoint as you want, since you can define each data source separately (`query`, `path`, `header`, `cookie`, and `body`) per endpoint.
+
+## How to run
+
+The entrypoint to this project is `run.py`. It currently supports two commands:
+
+### config-help
+
+Prints all config options available to a given generator.
+
+Run `python3 run.py config-help --help` for more details.
+
+Show config options for the `python` generator:
+
+```bash
+python3 run.py config-help -g python
+```
+
+## Tests
+
+See [tests directory](tests).
+
+## Feature support
+
+The aim of this project is to cover the most common use-cases in an OpenAPI spec. 
+
+### Supported 
+
+* Requests with and without formdata: `openapi-generator` will create a different interface if an endpoint's `content-type` has formdata (`multipart/form-data` or `application/x-www-form-urlencoded`) and everything else
+* Discriminators with `allOf`
+
+### Issues
+
+The following are issues with the SDK code generated by `openapi-generator`.
+
+* `allOf` without a discriminator: Depending on the `openapi-generator` generator used, the generated SDK may be completely broken
+  * `typescript-node` SDK code is generated broken by `openapi-generator` 
+  * Other SDKs currently supported by OSEG will usually just use a generic `object` type
+* `anyOf`
+  * `typescript-node` generated SDK does not set data
+  * `php` generated SDK does not set data
+  * Other SDKs currently supported by OSEG generate a class
+* `oneOf`
+  * `typescript-node` generated SDK does not set data
+  * `php` generated SDK does not set data
+  * Other SDKs currently supported by OSEG generate a class
+* Multiple values in `type` definition. New in OpenAPI 3.1 `type` can now be an array of supported types
+  * `c#`, `java`, `ruby` Generate a class
+  * `python` generates a class but does not use it, types property as the first value in `type`
+  * `php` generates a class, data not set
+  * `typescript-node` generates a class, data not set
+* `openapi-generator` generates a class for inline schema with `type=object`. If two or more Operations share identical inline schema definitions, `openapi-generator` will only generate a class for one of the Operations, and all Operations will reference this class. The name of the class depends on which Operation is read first by `openapi-generator`, but it may not reflect the first definition within the OAS file and thus is impossible for OSEG to know the name of the class ahead of time.

oseg/bin/build

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+BASE_DIR="${DIR}/.."
+
+pushd "${BASE_DIR}"
+uv build
+popd

oseg/bin/code-cov

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+BASE_DIR="${DIR}/.."
+
+pushd "${BASE_DIR}"
+uv run coverage run -m unittest discover -s tests
+uv run coverage html --omit=tests/*
+popd

oseg/bin/docker-build

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -e
+
+DIR=$(cd `dirname $0` && pwd)
+VERSION=$1
+
+if [[ -z "${VERSION-}" ]]; then
+  echo "Must provide version"
+  exit 1
+fi
+
+pushd "${DIR}/.."
+
+docker image build \
+  -f Dockerfile \
+  -t dropbox/oseg:${VERSION} .
+
+popd

oseg/oseg/__init__.py

@@ -0,0 +1,16 @@
+import os
+
+# coding: utf-8
+
+"""
+    oseg
+"""
+
+__version__ = "0.3-dev"
+__ROOT_DIR__ = os.path.dirname(os.path.abspath(__file__)) + "/.."
+
+from .jinja_extension import *
+from .generator import *
+from .model import *
+from .parser import *
+from .oseg import *

oseg/oseg/generator/__init__.py

@@ -0,0 +1,18 @@
+from .base_generator import (
+    BaseConfig,
+    BaseConfigDef,
+    BaseConfigOseg,
+    BaseGenerator,
+    GeneratorFactory,
+    Project,
+    ProjectTemplateFilesDef,
+    PropsOptionalT,
+)
+from .csharp_generator import CSharpGenerator
+from .java_generator import JavaGenerator
+from .kotlin_generator import KotlinGenerator
+from .php_generator import PhpGenerator
+from .python_generator import PythonGenerator
+from .ruby_generator import RubyGenerator
+from .typescript_axios_generator import TypescriptAxiosGenerator
+from .typescript_node_generator import TypescriptNodeGenerator