Merge pull request #2756 from SzySteve/docs/deprecated

Add deprecated key to docs renderer

Author: displague

docs/prebuild.js

@@ -128,7 +128,7 @@ function formatSchemaField(schemaField, enumMap, filterDepth, iteration = 1) {
   description = convertUlToArray(description);
 
   // eslint-disable-next-line max-len
-  const { name, seeAlso, editable, filterable, optional, type, subtype, isArray, value } = schemaField;
+  const { name, seeAlso, editable, filterable, optional, type, subtype, isArray, value, deprecated } = schemaField;
   let lowerType = type && _.isString(type) ? type.toLowerCase() : 'object';
 
   let nestedSchema = null;
@@ -188,6 +188,7 @@ function formatSchemaField(schemaField, enumMap, filterDepth, iteration = 1) {
     isArray,
     type: lowerType,
     schema: nestedSchema,
+    deprecated,
   };
 }
 

docs/scss/components/Tables/cells/FieldCell.scss

@@ -1,6 +1,9 @@
 .FieldCell {
     &-label {
         margin-top: -5px;
+        &-deprecated {
+            color: red;
+        }
     }
 }
 

docs/src/components/tables/cells/ParamFieldCell.js

@@ -20,12 +20,26 @@ export default function ParamFieldCell(props) {
     );
   }
 
+  let deprecatedWarning;
+  if (record.deprecated) {
+    deprecatedWarning = (
+      <div className="FieldCell-label-deprecated">
+        <small>
+          {record.deprecated}
+        </small>
+      </div>
+    );
+  }
+
   return (
     <td className="TableCell FieldCell">
       <div>
         {record.name}
       </div>
       {subLabel}
+      <div>
+        {deprecatedWarning}
+      </div>
     </td>
   );
 }

docs/src/data/endpoints/linodes.yaml

@@ -53,6 +53,8 @@ endpoints:
               The Distribution to deploy this Linode with.  May not be included
               if 'backup_id' or 'image' is sent.
             type: String
+            deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
+              See the changelog for more information.
           root_pass:
             optional: unless source == "distro"
             description: >
@@ -195,7 +197,9 @@ endpoints:
               Optional distribution to deploy with this disk.
               <ul><li>If no distribution is provided, a blank disk
               is created.</li></ul> You may not provide distribution if image is provided.
-            type: Distribution
+            type: String
+            deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
+              See the changelog for more information.
           image:
             optional: true
             description: >
@@ -1009,9 +1013,12 @@ endpoints:
         dangerous: true
         params:
           distribution:
+            optional: true
             description: >
-                An Distribution to deploy to this Linode.
-            type: Distribution
+                An ID of a Distribution to deploy to this Linode.
+            type: String
+            deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
+              See the changelog for more information.
           image:
             optional: true
             description: >

docs/src/data/objects/linode.yaml

@@ -77,6 +77,8 @@ schema:
     type: Distribution
     seeAlso: "/reference/endpoints/linode/distributions"
     filterable: true
+    deprecated: This parameter is deprecated and will be removed before the end of the Beta Period.
+      See the changelog for more information.
   group:
     editable: true
     type: String