Show format of request parameter enums correctly

Addresses: #349
ConsumerDataStandardsAustralia · Dec 18, 2023 · ddee2d7 · ddee2d7
1 parent 3a6a594
commit ddee2d7
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/slate/source/includes/releasenotes/releasenotes.1.29.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.29.0.html.md
@@ -17,7 +17,7 @@ Release notes for version v1.29.0 of the [CDR Standards](../../index.html).
 
 This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues):
 
-- [Staging Issue xxx - Description](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/xxx)
+- [Staging Issue 349 - Enum parameters in endpoints are not reflected correctly](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/349)
 
 This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
 
@@ -32,6 +32,7 @@ This release addresses the following Decision Proposals published on [Standards]
 ## General Changes
 |Change|Description|Link|
 |------|-----------|----|
+| Enum property type | **[Standards Staging #349](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/349):** Request parameters defined with enumerated values will now show the type as 'Enum' instead of 'string' | Request Parameters tables |
 
 
 ## Introduction

diff --git a/slate/source/includes/standards/_types.md b/slate/source/includes/standards/_types.md
@@ -1,6 +1,8 @@
 ## Common Field Types
 
-
+```diff
+Properties defined in request parameters with enumerated values will now correctly show the type as 'Enum' instead of 'string'
+```
 
 The following table outlines the common data types for fields used in the standard.
 

diff --git a/swagger-gen/widdershins-cdr/openapi3.js b/swagger-gen/widdershins-cdr/openapi3.js
@@ -247,6 +247,10 @@ function getParameters(data) {
         if (typeof param['x-conditional'] === 'boolean') {
           param.cdrConditional = param['x-conditional'];
         }
+
+        if (param.schema && param.schema.enum) {
+          param.cdrType = '[Enum](#common-field-types)';
+        }
     }
 
     let effSecurity;