update optic.yml

opticdev · Oct 15, 2023 · 2efdc88 · 2efdc88
1 parent d7c7d3f
commit 2efdc88
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ optic capture openapi.yml --update interactive
 
 Optic's `diff` command tests that API changes are backwards compatible, and that new and existing API endpoints follow your style guide. The style guide is configured in the `optic.yml` file. 
 
-Run: 
+Compute a diff:
 
 ```
 optic diff openapi.yml --check --web

diff --git a/optic.yml b/optic.yml
@@ -1,15 +1,15 @@
 ruleset:
   - breaking-changes
-  # - naming:
-  # required_on: added
-  # properties: snake_case
-  # pathComponents:  snake_case
-  # queryParameters: snake_case
+  - naming:
+      required_on: always
+      properties: camelCase
+      pathComponents:  snake_case
+      queryParameters: snake_case
 capture:
   openapi.yml:
     # 🔧 Runnable example with simple get requests. 
     # Run with "optic capture openapi.yml --update interactive" 
-    # You can change the server and the 'requests' section to experiment
+    # You can run your actual tests through the Optic proxy with the `command` option (next example)
     server:
       url: https://api.useoptic.com/
     requests: