fix(openapi): add parameter level examples for global path parameters (…

…#4814)
fern-api · Oct 6, 2024 · 98533a9 · 98533a9
1 parent afc0fef
commit 98533a9
Show file tree

Hide file tree

Showing 14 changed files with 414 additions and 3 deletions.
diff --git a/fern/pages/changelogs/openapi/2024-10-06.mdx b/fern/pages/changelogs/openapi/2024-10-06.mdx
@@ -0,0 +1,4 @@
+## 0.1.5
+**`(fix):`** The generator now adds paraemter level examples for global parameters.
+
+
diff --git a/generators/openapi/src/converters/servicesConverter.ts b/generators/openapi/src/converters/servicesConverter.ts
@@ -601,9 +601,11 @@ function convertPathParameter({
 
     const openapiExamples: OpenAPIV3.ParameterObject["examples"] = {};
     for (const example of examples) {
-        const pathParameterExample = [...example.servicePathParameters, ...example.endpointPathParameters].find(
-            (param) => param.name.originalName === pathParameter.name.originalName
-        );
+        const pathParameterExample = [
+            ...example.rootPathParameters,
+            ...example.servicePathParameters,
+            ...example.endpointPathParameters
+        ].find((param) => param.name.originalName === pathParameter.name.originalName);
         if (pathParameterExample != null) {
             if (example.name && example.name.originalName !== "") {
                 openapiExamples[example.name.originalName] = {

diff --git a/generators/openapi/versions.yml b/generators/openapi/versions.yml
@@ -1,3 +1,11 @@
+- version: 0.1.5
+  createdAt: '2024-10-06'
+  changelogEntry:
+    - type: fix
+      summary: | 
+        The generator now adds paraemter level examples for global parameters.
+  irVersion: 53
+
 - version: 0.1.4
   createdAt: '2024-09-25'
   changelogEntry:

diff --git a/seed/openapi/imdb/custom-overrides/openapi.yml b/seed/openapi/imdb/custom-overrides/openapi.yml
diff --git a/seed/openapi/imdb/json-format/openapi.json b/seed/openapi/imdb/json-format/openapi.json
diff --git a/seed/openapi/imdb/override/openapi.yml b/seed/openapi/imdb/override/openapi.yml
diff --git a/seed/openapi/package-yml/openapi.yml b/seed/openapi/package-yml/openapi.yml
diff --git a/seed/openapi/server-sent-event-examples/.mock/definition/api.yml b/seed/openapi/server-sent-event-examples/.mock/definition/api.yml
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		## 0.1.5
		`(fix):` The generator now adds paraemter level examples for global parameters.