Merge pull request #1137 from nextcloud/feature/dynamite/petstore-exa…

…mple

.cspell/tools.txt

@@ -21,6 +21,7 @@ enduml
 euxo
 exiftool
 extglob
+fehguy
 freedesktop
 fullpath
 gboolean
@@ -45,9 +46,12 @@ libsqlite
 mipmap
 ndebug
 nodoc
+nonintegers
 nproc
 openrelay
 openrelayprojectsecret
+palo
+petstore
 plantuml
 precache
 puml

.github/workflows/generate.yaml

@@ -34,6 +34,8 @@ jobs:
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
         with:
           fetch-depth: 0
+      - name: Submodules
+        run: git submodule update --init --depth 0
 
       - name: Install dart
         uses: dart-lang/setup-dart@b64355ae6ca0b5d484f0106a033dd1388965d06d # v1
@@ -48,6 +50,14 @@ jobs:
             exit 1
           fi
 
+      - name: Generate dynamite petstore example
+        run: |
+          ./tool/generate-dynamite-petstore-example.sh
+          if [ -n "$(git status --porcelain)" ]; then
+            git --no-pager diff
+            exit 1
+          fi
+
       - name: Generate nextcloud
         run: |
           ./tool/generate-nextcloud.sh

.gitmodules

@@ -19,3 +19,6 @@
 [submodule "external/nextcloud-notes"]
 	path = external/nextcloud-notes
 	url = https://github.com/nextcloud/notes
+[submodule "external/openapi-specification"]
+	path = external/openapi-specification
+	url = https://github.com/OAI/OpenAPI-Specification.git

commitlint.yaml

@@ -13,6 +13,7 @@ rules:
       - tool
       - app
       - dynamite
+      - dynamite_petstore_example
       - dynamite_runtime
       - dynamite_end_to_end_test
       - file_icons

cspell.json

@@ -11,6 +11,7 @@
     "**/assets",
     "**/l10n/!(en.arb)",
     "external",
+    "packages/dynamite/dynamite_petstore_example/lib",
     "packages/file_icons/lib/src/data.dart",
     "packages/neon_lints/lib",
     "tool/dev/static"

packages/dynamite/dynamite_petstore_example/LICENSE

@@ -0,0 +1 @@
+../../../assets/AGPL-3.0.txt

packages/dynamite/dynamite_petstore_example/README.md

@@ -0,0 +1,5 @@
+# dynamite petstore example
+
+An example showcasing the [dynamite generator](../dynamite) for OpenAPI using the [Swagger Petstore](https://github.com/swagger-api/swagger-petstore).
+
+Because dynamite does not support dynamic authentication yet a [patch](patch.json) is applied to the specification to make it work. It will be removed once dynamite supports API key and Oauth 2.0 authentication.

packages/dynamite/dynamite_petstore_example/build.yaml

@@ -0,0 +1,18 @@
+targets:
+  $default:
+    builders:
+      built_value_generator|built_value:
+        enabled: true
+      dynamite:
+        options:
+          pageWidth: 120
+          analyzer_ignores:
+            - camel_case_types
+            - discarded_futures
+            - public_member_api_docs
+            - unreachable_switch_case
+          coverage_ignores:
+            - 'const .*\._\(\);'
+            - 'factory .*\.fromJson\(Map<String, dynamic> json\) => _jsonSerializers\.deserializeWith\(serializer, json\)!;'
+            - 'Map<String, dynamic> toJson\(\) => _jsonSerializers\.serializeWith\(serializer, this\)! as Map<String, dynamic>;'
+            - 'static BuiltSet<.*> get values => _\$.*Values;'