Support for optional headers in Reslang (#267)

* supporting optional http headers * feat: Support for optional headers in Reslang * feat: update httpheader test * feat: update doc * feat: update reference.md * feat: update reference.md * feat: update reference.md --------- Co-authored-by: Yanan Xu <yanan.xu@liveramp.com>
LiveRamp · Feb 27, 2023 · 124dd41 · 124dd41
1 parent f5bfead
commit 124dd41
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 5 deletions.
diff --git a/docs/reference.md b/docs/reference.md
@@ -134,13 +134,17 @@ In order to require a specific HTTP header on requests, you must first add an
 "The standard header for passing bearer tokens. e.g. `Bearer $ACCESS_TOKEN`"
 http-header AuthHeader {
   name: Authorization
+  required: true //it's optional and will give true if not provided
 }
 ```
 
 In this example, `AuthHeader` is the name of the `http-header` definition,
 `"The standard header...` is the description that will appear with the header
 parameter in the generated Swagger, and `Authorization` is the header name.
 
+The `required` attribute indicates if the header is required when calling the API.
+And the attribute itself is optional, the default value is `true`.
+
 Now, the `AuthHeader` header can be referenced in the `/request-headers`
 section in a resource, subresource, or action definition. For example:
 

diff --git a/docs/releases.md b/docs/releases.md
@@ -1,3 +1,6 @@
+## 6.2.5 2/23/2023
+- Add `required` attribute to httpHeader. Support optional HTTP request headers.
+
 ## 6.2.4 12/30/2021
 
 - Include flag `--oneof-polymorphism` to translate `union` reslang definitions into swagger `oneOf` field instead of `allOf`

diff --git a/models/authorization/testdata/parsed.expected b/models/authorization/testdata/parsed.expected
@@ -607,6 +607,7 @@
         "comment": "for your access token, ya know?",
         "headerName": "Authorization",
         "name": "AuthnHeader",
+        "required": true,
         "parentShort": "",
         "parentName": "",
         "secondary": false,
@@ -621,6 +622,7 @@
         "comment": "for your org ID, ya know?",
         "headerName": "LR-Org-ID",
         "name": "OrgIDHeader",
+        "required": true,
         "parentShort": "",
         "parentName": "",
         "secondary": false,

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@liveramp/reslang",
-    "version": "6.2.4",
+    "version": "6.2.5",
     "main": "index.js",
     "license": "Apache-2.0",
     "engines": {

diff --git a/src/grammar/rest.pegjs b/src/grammar/rest.pegjs
@@ -267,6 +267,7 @@ bool = b: ("true" / "false") {
 
 httpHeader = _ comment:description? _ type:("http-header")  _ name:name  _ "{" _
     "name:" _ headerName:[a-zA-Z0-9\-]+ _
+    required:("required:" _ bool _)?
 "}" _ ";"? _ {
-    return {category: "definition", kind: type, "type": type, parents: [], "short": name, "comment": comment, "headerName": headerName.join("")}
+    return {category: "definition", kind: type, "type": type, parents: [], "short": name, "comment": comment, "headerName": headerName.join(""), "required": required?required[2]:true}
 }
diff --git a/src/main.ts b/src/main.ts
@@ -18,7 +18,7 @@ import JsonSchemaGen from "./genjsonschema"
 const RULES = "rules.json"
 const LOCAL_RULES = lpath.join(__dirname, "library", RULES)
 
-export const VERSION = "v6.2.4"
+export const VERSION = "v6.2.5"
 
 // parse the cmd line
 const args = yargs

diff --git a/src/swagger/http-headers/index.test.ts b/src/swagger/http-headers/index.test.ts
@@ -182,7 +182,8 @@ const sampleReslangDefinitions = [
         kind: "http-header",
         name: "MyCoolHeaderDef",
         headerName: "MyCoolHeader",
-        comment: "This is the header you use for cool things"
+        comment: "This is the header you use for cool things",
+        required: true,
     } as IHTTPHeader
 ] as AnyKind[]
 

diff --git a/src/swagger/http-headers/index.ts b/src/swagger/http-headers/index.ts
@@ -78,7 +78,7 @@ function addHeaderParamToSwaggerPath(
         description: headerDef.comment,
         in: "header",
         name: headerDef.headerName,
-        required: true,
+        required: headerDef.required,
         schema: {
             type: "string"
         }

diff --git a/src/treetypes.ts b/src/treetypes.ts
@@ -164,6 +164,7 @@ export interface IResourceLike extends IDefinition {
 export interface IHTTPHeader extends IDefinition {
     kind: "http-header"
     headerName: string
+    required: boolean
 }
 
 export interface IEnum extends IDefinition {