Merge pull request #683 from softlayer/20240823

20240823 release
softlayer · Aug 23, 2024 · 9cacaef · 9cacaef
2 parents afbf870 + 77fd4f9
commit 9cacaef
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 23 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -18,4 +18,4 @@ repos:
         # when "--baseline" without "--use-all-plugins", pre-commit scan with just plugins in baseline file
         # when "--baseline" with "--use-all-plugins", pre-commit scan with all available plugins
         # add "--fail-on-unaudited" to fail pre-commit for unaudited potential secrets
-        args: [--baseline, .secrets.baseline, --use-all-plugins, --exclude-files "static/*|content/reference/*|data/sldn_metadata\.json"]
+        args: [-v, --baseline, .secrets.baseline, --use-all-plugins, --exclude-files "static/*|content/reference/*|data/sldn_metadata\.json"]
diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getBandwidthGraph.md
@@ -1,6 +1,6 @@
 ---
 title: "getBandwidthGraph"
-description: "Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. "
+description: "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. "
 date: "2018-02-12"
 tags:
     - "method"

diff --git a/content/reference/services/SoftLayer_Metric_Tracking_Object/getGraph.md b/content/reference/services/SoftLayer_Metric_Tracking_Object/getGraph.md
@@ -1,6 +1,6 @@
 ---
 title: "getGraph"
-description: "Retrieve a PNG image of a metric in graph form. "
+description: "[DEPRECATED] Retrieve a PNG image of a metric in graph form. "
 date: "2018-02-12"
 tags:
     - "method"

diff --git a/content/release_notes/2024/20240823.md b/content/release_notes/2024/20240823.md
@@ -0,0 +1,10 @@
+---
+title: "Release notes: August 23, 2024"
+date: "2024-08-23"
+tags:
+    - "release notes"
+---
+
+#### API
+
+- Deprecated specific tracking object API endpoints that intended to return usage graph images. Add deprecation tag to Metric Tracking Object graphing API endpoints NETWORK-14559
diff --git a/data/sldn_metadata.json b/data/sldn_metadata.json
@@ -119088,8 +119088,8 @@
             "getBandwidthGraph": {
                 "name": "getBandwidthGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
-                "docOverview": "Retrieve a bandwidth graph.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
+                "docOverview": "[DEPRECATED] Retrieve a bandwidth graph.",
                 "docAssociatedMethods": [
                     {
                         "service": "SoftLayer_Metric_Tracking_Object",
@@ -119100,6 +119100,7 @@
                         "method": "getBandwidthTotal"
                     }
                 ],
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -119222,8 +119223,9 @@
             "getGraph": {
                 "name": "getGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a metric in graph form. ",
-                "docOverview": "Retrieve a graph of a virtual hosting platform's per instance use.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a metric in graph form. ",
+                "docOverview": "[DEPRECATED] Retrieve a graph of a virtual hosting platform's per instance use.",
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -119421,8 +119423,8 @@
             "getBandwidthGraph": {
                 "name": "getBandwidthGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
-                "docOverview": "Retrieve a bandwidth graph.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
+                "docOverview": "[DEPRECATED] Retrieve a bandwidth graph.",
                 "docAssociatedMethods": [
                     {
                         "service": "SoftLayer_Metric_Tracking_Object",
@@ -119433,6 +119435,7 @@
                         "method": "getBandwidthTotal"
                     }
                 ],
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -119555,8 +119558,9 @@
             "getGraph": {
                 "name": "getGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a metric in graph form. ",
-                "docOverview": "Retrieve a graph of a virtual hosting platform's per instance use.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a metric in graph form. ",
+                "docOverview": "[DEPRECATED] Retrieve a graph of a virtual hosting platform's per instance use.",
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -119957,8 +119961,8 @@
             "getBandwidthGraph": {
                 "name": "getBandwidthGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
-                "docOverview": "Retrieve a bandwidth graph.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
+                "docOverview": "[DEPRECATED] Retrieve a bandwidth graph.",
                 "docAssociatedMethods": [
                     {
                         "service": "SoftLayer_Metric_Tracking_Object",
@@ -119969,6 +119973,7 @@
                         "method": "getBandwidthTotal"
                     }
                 ],
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -120091,8 +120096,9 @@
             "getGraph": {
                 "name": "getGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a metric in graph form. ",
-                "docOverview": "Retrieve a graph of a virtual hosting platform's per instance use.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a metric in graph form. ",
+                "docOverview": "[DEPRECATED] Retrieve a graph of a virtual hosting platform's per instance use.",
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -120304,8 +120310,8 @@
             "getBandwidthGraph": {
                 "name": "getBandwidthGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
-                "docOverview": "Retrieve a bandwidth graph.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
+                "docOverview": "[DEPRECATED] Retrieve a bandwidth graph.",
                 "docAssociatedMethods": [
                     {
                         "service": "SoftLayer_Metric_Tracking_Object",
@@ -120316,6 +120322,7 @@
                         "method": "getBandwidthTotal"
                     }
                 ],
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -120438,8 +120445,9 @@
             "getGraph": {
                 "name": "getGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a metric in graph form. ",
-                "docOverview": "Retrieve a graph of a virtual hosting platform's per instance use.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a metric in graph form. ",
+                "docOverview": "[DEPRECATED] Retrieve a graph of a virtual hosting platform's per instance use.",
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -120699,8 +120707,8 @@
             "getBandwidthGraph": {
                 "name": "getBandwidthGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
-                "docOverview": "Retrieve a bandwidth graph.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers. ",
+                "docOverview": "[DEPRECATED] Retrieve a bandwidth graph.",
                 "docAssociatedMethods": [
                     {
                         "service": "SoftLayer_Metric_Tracking_Object",
@@ -120711,6 +120719,7 @@
                         "method": "getBandwidthTotal"
                     }
                 ],
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",
@@ -120833,8 +120842,9 @@
             "getGraph": {
                 "name": "getGraph",
                 "type": "SoftLayer_Container_Bandwidth_GraphOutputs",
-                "doc": "Retrieve a PNG image of a metric in graph form. ",
-                "docOverview": "Retrieve a graph of a virtual hosting platform's per instance use.",
+                "doc": "[DEPRECATED] Retrieve a PNG image of a metric in graph form. ",
+                "docOverview": "[DEPRECATED] Retrieve a graph of a virtual hosting platform's per instance use.",
+                "deprecated": true,
                 "parameters": [
                     {
                         "name": "startDateTime",