fix(cli): validate example endpoint calls when there are base-path ov…

…errides (#4815)
fern-api · Oct 6, 2024 · 20ce0ba · 20ce0ba
1 parent 98533a9
commit 20ce0ba
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 5 deletions.
diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,10 @@
+- changelogEntry:
+    - summary: |
+        The Fern Definition respects endpoint level base-path overrides when validating examples.
+      type: fix
+  irVersion: 53
+  version: 0.44.6
+
 - changelogEntry:
     - summary: |
         The Fern Definition now supports overriding `base-path` at the endpoint level. 

diff --git a/...valid-example-endpoint-call/__test__/fixtures/endpoint-level-base-path/definition/api.yml b/...valid-example-endpoint-call/__test__/fixtures/endpoint-level-base-path/definition/api.yml
@@ -0,0 +1,4 @@
+name: endpoint-level-base-path
+base-path: /{version}
+path-parameters: 
+  version: string
diff --git a/...e-endpoint-call/__test__/fixtures/endpoint-level-base-path/definition/path-parameters.yml b/...e-endpoint-call/__test__/fixtures/endpoint-level-base-path/definition/path-parameters.yml
@@ -0,0 +1,13 @@
+service:
+  auth: false
+  base-path: "/servicePath"
+  endpoints:
+    get:
+      method: GET
+      base-path: "/latest"
+      path: /{endpointPathParam}
+      path-parameters:
+        endpointPathParam: string
+      examples:
+        - path-parameters:
+            endpointPathParam: hello
diff --git a/...les/valid-example-endpoint-call/__test__/fixtures/endpoint-level-base-path/generators.yml b/...les/valid-example-endpoint-call/__test__/fixtures/endpoint-level-base-path/generators.yml
@@ -0,0 +1 @@
+{}
diff --git a/...idator/src/rules/valid-example-endpoint-call/__test__/valid-example-endpoint-call.test.ts b/...idator/src/rules/valid-example-endpoint-call/__test__/valid-example-endpoint-call.test.ts
@@ -495,4 +495,19 @@ describe("valid-example-endpoint-call", () => {
 
         expect(violations).toEqual(expectedViolations);
     });
+
+    it("endpoint-level-base-path", async () => {
+        const violations = await getViolationsForRule({
+            rule: ValidExampleEndpointCallRule,
+            absolutePathToWorkspace: join(
+                AbsoluteFilePath.of(__dirname),
+                RelativeFilePath.of("fixtures"),
+                RelativeFilePath.of("endpoint-level-base-path")
+            )
+        });
+
+        const expectedViolations: ValidationViolation[] = [];
+
+        expect(violations).toEqual(expectedViolations);
+    });
 });
diff --git a/...definition/validator/src/rules/valid-example-endpoint-call/valid-example-endpoint-call.ts b/...definition/validator/src/rules/valid-example-endpoint-call/valid-example-endpoint-call.ts
@@ -50,11 +50,14 @@ export const ValidExampleEndpointCallRule: Rule = {
                     { relativeFilepath, contents: definitionFile }
                 ) => {
                     return validateExampleEndpointCallParameters({
-                        allDeclarations: {
-                            ...workspace.definition.rootApiFile.contents["path-parameters"],
-                            ...service["path-parameters"],
-                            ...endpoint["path-parameters"]
-                        },
+                        allDeclarations:
+                            endpoint["base-path"] != null
+                                ? { ...endpoint["path-parameters"] }
+                                : {
+                                      ...workspace.definition.rootApiFile.contents["path-parameters"],
+                                      ...service["path-parameters"],
+                                      ...endpoint["path-parameters"]
+                                  },
                         examples,
                         parameterDisplayName: "path parameter",
                         typeResolver,