Merge pull request #214 from LiveRamp/release

Release v6.2.1
LiveRamp · Nov 5, 2021 · 0749157 · 0749157
2 parents ce23bb9 + 6e6b5ba
commit 0749157
Show file tree

Hide file tree

Showing 66 changed files with 11,649 additions and 1,424 deletions.
diff --git a/docs/bnf/railroad-for-reslang.html b/docs/bnf/railroad-for-reslang.html
diff --git a/docs/reference.md b/docs/reference.md
@@ -1,6 +1,6 @@
 # Reference Manual
 
-The reslang grammar is fully described by these [railroad diagrams](./bnf/railroad-for-reslang.pdf).
+The reslang grammar is fully described by these [railroad diagrams](./bnf/railroad-for-reslang.html).
 
 Note that we will draw heavily on the example specified [here](../models/direct2dist). This demo namespace models the complete Direct2Dist specification, which allows ids to be sent directly to a destination. This is explained in more detail [here](./direct2dist-explanation.md).
 
@@ -343,9 +343,27 @@ enum StatusEnum {
 
 Note that the literals can include the lowercase, colons, numbers etc.
 
-### 2 types of comments
+### Comments
 
-// && /\* \*/ comments are developer only comments. A comment using quotes ("this is a comment") will get transferred to the Swagger description field of the element it appears before.
+// && /\* \*/ comments are developer only comments. 
+
+### Descriptions
+
+Quoted strings (e.g. "this is a description") will get transferred to the Swagger description field of the element it appears before.
+These are applicable for most definitions including resources and operations.
+
+Descriptions for operations (e.g. quoted string preceeding `GET`, `POST`, `PUT`) may also include an optional summary which will be passed to its
+corresponding Swagger field. Summaries are usually displayed in the left sidebar in Swagger UI.
+
+e.g.
+```
+resource IntegrationConnection {
+    /operations
+        "Summary: Create a new IntegrationConnection
+        The configProperties and the configuredIdentifierTypeIDs must be consistent with the integration"
+        POST
+}
+```
 
 ### Multiget
 

diff --git a/docs/releases.md b/docs/releases.md
@@ -1,3 +1,13 @@
+## 6.2.1 11/05/2021
+
+- Add `nullable`: Added support to generate nullable attributes in schemas for swagger specs.
+- Fix event namespaces: `AdHoc` channels for events did not respect namespaces when generating topic names.
+- Add `default` modifier to enum attributes. Enum and primitves properties now can set a default value.
+- Fix verb enum: events that included a rest resource generated an invalid json schema. (specifically included empty enum array)
+- Fix env flag: it was being ignored and overriden with PROD in most places.
+- Add `Summary:` syntax for summaries in swagger generated specs for operations   
+- Reword generated swagger descriptions for paginated APIs
+
 ## 4.0.0 12/10/2020
 
 Revert generated topic name format for compatibility with topic names generated by earlier versions of Reslang.

diff --git a/models/authorization/testdata/parsed.expected b/models/authorization/testdata/parsed.expected
@@ -51,7 +51,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -78,7 +79,8 @@
               "output": false,
               "queryonly": false,
               "query": true,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -105,7 +107,8 @@
               "output": false,
               "queryonly": false,
               "query": true,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -137,7 +140,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -164,7 +168,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           }
@@ -173,17 +178,20 @@
           {
             "operation": "POST",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           },
           {
             "operation": "GET",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           },
           {
             "operation": "MULTIGET",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           }
         ],
         "requestHeaders": [
@@ -236,7 +244,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           }
@@ -245,7 +254,8 @@
           {
             "operation": "POST",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           }
         ],
         "parents": [
@@ -289,7 +299,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           }
@@ -298,7 +309,8 @@
           {
             "operation": "POST",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           }
         ],
         "requestHeaders": [
@@ -351,7 +363,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -378,7 +391,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -405,7 +419,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           }
@@ -414,17 +429,20 @@
           {
             "operation": "POST",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           },
           {
             "operation": "GET",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           },
           {
             "operation": "MULTIGET",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           }
         ],
         "parents": [],
@@ -466,7 +484,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -493,7 +512,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -520,7 +540,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           }
@@ -529,17 +550,20 @@
           {
             "operation": "POST",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           },
           {
             "operation": "GET",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           },
           {
             "operation": "MULTIGET",
             "options": [],
-            "errors": []
+            "errors": [],
+            "summary": ""
           }
         ],
         "requestHeaders": [
@@ -655,7 +679,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -683,7 +708,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           },
@@ -711,7 +737,8 @@
               "output": false,
               "queryonly": false,
               "query": false,
-              "representation": false
+              "representation": false,
+              "nullable": false
             },
             "constraints": {}
           }