Merge pull request #3 from ConsumerDataStandardsAustralia/experimenta…

…l/super_product Updated Docs and html
ConsumerDataStandardsAustralia · Aug 3, 2023 · 7f4768f · 7f4768f
2 parents cb8113a + d259685
commit 7f4768f
Show file tree

Hide file tree

Showing 4 changed files with 5,248 additions and 811 deletions.
diff --git a/docs/Standards/Super-Product.md b/docs/Standards/Super-Product.md
@@ -12,9 +12,19 @@ This standards provides a product API set for publicly available superannuation
 
 <Introduction>
 
+The API covers retail superannuation products. Product data includes:
+
+* Name of fund
+* Provider
+* Status
+* Investment Types
+* Fees 
+* Performance
+* Links - PDS, Fund and Provider details
+
 The product API contains two API's
 
-| API | Method | Path |  Description |
+| API | Method | Path |  Description | 
 |-|-|-|-|
 |Get Products | GET | {ProviderURI} **/super/products**| Returns a list of Super Funds offered to the market |
 |Get ProductDetail | GET | {ProviderURI} **/super/products{productId}**| Returns a specific Fund details  offered to the market |

diff --git a/docs/Standards/cds_super_product.html b/docs/Standards/cds_super_product.html
diff --git a/docs/Standards/cds_super_product.json b/docs/Standards/cds_super_product.json
@@ -458,12 +458,27 @@
             "description": "The name of the super fund provider",
             "type": "string"             
           },
-          "investmentType": {
-            "description": "The type of fund type.",
-            "enum": [ "CONSERVATIVE", "BALANCED", "GROWTH", "ETHICAL", "FIXED_INCOME", "OTHER" ],
-            "default": "BALANCED",
+          "inceptionDate": {
+            "description": "Inception date of the fund.",
+            "type": "string",
+            "x-cds-type": "DateString"
+          },
+          "status": {
+            "description": "The status. PUBLIC open to any members, CLOSED not open to new members, EMPLOYER open to employee cohorts",
+            "enum": [ "PUBLIC", "CLOSED", "EMPLOYEE" ],
+            "default": "PUBLIC",
             "type": "string"
           },
+          "investmentTypes": {
+            "description": "The type of investment types supported",
+            "items": {
+              "properties": {           
+                "$ref": "#/components/schemas/SuperFundProductInvestmentType"
+              }
+            },
+            "type": "array",
+            "required": "investmentType"
+          },
           "fees": {
             "description": "A list of fees that apply to the fund",
             "items": {
@@ -482,6 +497,11 @@
             "description": "A link to the fund web page",
             "type": "string",
             "x-cds-type": "URIString"
+          },          
+          "pdsUri": {
+            "description": "A link to the product disclosure statement",
+            "type": "string",
+            "x-cds-type": "URIString"
           },
           "providerUri": {
             "description": "A link to the fund providers web page",
@@ -492,9 +512,9 @@
             "$ref": "#/components/schemas/SuperAdditionalInformation"
           }
         },
-        "required": [ "provider", "displayName", "description", "fees", "performance", "productId", "type", "investmentType" ],
+        "required": [ "provider", "displayName", "description", "investmentTypes", "fees", "performance", "productId", "type", "investmentType" ],
         "type": "object",
-        "x-conditional": [ "contract" ]
+        "x-conditional": [ "" ]
       },
       "Links": {
         "properties": {
@@ -571,6 +591,16 @@
         "required": [ "funds" ],
         "type": "object"
       },
+      "SuperFundProductInvestmentType": {        
+        "properties": {
+          "investmentType": {
+            "enum": [ "CONSERVATIVE", "BALANCED", "GROWTH", "ETHICAL", "FIXED_INCOME", "OTHER" ],
+            "default": "BALANCED",
+            "type": "string"      
+          }
+        }
+      },
+
       "SuperFundProductFees": {
         "properties": {
           "name": {
@@ -616,7 +646,7 @@
             "x-cds-type": "ExternalRef"
           },
           "value": {
-            "description": "The percent value of the performance over the given time frame e.g 5%",
+            "description": "The percent value of the performance over the given time frame e.g 5.1%",
             "type": "string",
             "x-cds-type": "RateString"
           }

diff --git a/docs/Standards/cfg/default.cfg b/docs/Standards/cfg/default.cfg
@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<!-- This file is autogenerated; comments and unknown tags will be stripped -->
+<mameconfig version="10">
+    <system name="default" />
+</mameconfig>