@readme/oas-examples - npm Package Compare versions

Comparing version 5.6.1 to 5.7.0

3.0/json/readme-extensions.json

@@ -33,2 +33,6 @@ {
       "description": "https://docs.readme.com/docs/openapi-extensions#cors-proxy-enabled"
+    },
+    {
+      "name": "Toggling API Metrics",
+      "description": "https://docs.readme.com/docs/openapi-extensions#disable-api-metrics"
     }
@@ -215,3 +219,3 @@ ],
         "summary": "Disable funneling requests through our CORS proxy with the \"x-readme.proxy-enabled\" extension",
-        "description": "When `x-readme.proxy-enabled` is set to `false` all requests from the interactive will be funneled directly to the configured server URL, otherwise they will be piped through our proxy to allow [CORS-enabled](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests for you.\n\nhttps://docs.readme.com/docs/openapi-extensions#cors-proxy-enabled",
+        "description": "When `x-readme.proxy-enabled` is set to `false` all requests from the interactive API Explorer will be funneled directly to the configured server URL, otherwise they will be piped through our proxy to allow [CORS-enabled](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests for you.\n\nhttps://docs.readme.com/docs/openapi-extensions#cors-proxy-enabled",
         "tags": ["Toggling our CORS proxy"],
@@ -230,3 +234,3 @@ "responses": {
         "summary": "Disable funneling requests through our CORS proxy with the \"x-proxy-enabled\" extension",
-        "description": "When `x-readme.proxy-enabled` is set to `false` all requests from the interactive will be funneled directly to the configured server URL, otherwise they will be piped through our proxy to allow [CORS-enabled](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests for you.\n\n> If this is present alongside `x-readme.proxy-enabled` then the `x-readme.proxy-enabled` extension will take precedence over this extension.\n\nhttps://docs.readme.com/docs/openapi-extensions#cors-proxy-enabled",
+        "description": "When `x-proxy-enabled` is set to `false` all requests from the interactive API Explorer will be funneled directly to the configured server URL, otherwise they will be piped through our proxy to allow [CORS-enabled](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests for you.\n\n> If this is present alongside `x-readme.proxy-enabled` then the `x-readme.proxy-enabled` extension will take precedence over this extension.\n\nhttps://docs.readme.com/docs/openapi-extensions#cors-proxy-enabled",
         "tags": ["Toggling our CORS proxy"],
@@ -240,2 +244,30 @@ "responses": {
       }
+    },
+    "/x-metrics-enabled": {
+      "post": {
+        "operationId": "x-readme_metrics-enabled",
+        "summary": "Disable tracking requests through our API Metrics product with the \"x-readme.metrics-enabled\" extension",
+        "description": "When `x-readme.metrics-enabled` is set to `false` all requests from the interactive API Explorer will not be tracked for you within our [API Metrics product](https://readme.com/metrics) and you will not see any requests on that operations reference page that may have been logged to API Metrics through one of our many SDKs.\n\nhttps://docs.readme.com/docs/openapi-extensions#disable-api-metrics",
+        "tags": ["Toggling API Metrics"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "x-readme": {
+          "metrics-enabled": false
+        }
+      },
+      "patch": {
+        "operationId": "x-metrics-enabled",
+        "summary": "Disable tracking requests through our API Metrics product with the \"x-metrics-enabled\" extension",
+        "description": "When `x-metrics-enabled` is set to `false` all requests from the interactive API Explorer will not be tracked for you within our [API Metrics product](https://readme.com/metrics) and you will not see any requests on that operations reference page that may have been logged to API Metrics through one of our many SDKs.\n\nhttps://docs.readme.com/docs/openapi-extensions#disable-api-metrics",
+        "tags": ["Toggling API Metrics"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "x-metrics-enabled": false
+      }
     }
@@ -242,0 +274,0 @@ },

package.json

@@ -12,3 +12,3 @@ {
   ],
-  "version": "5.6.1",
+  "version": "5.7.0",
   "repository": {
@@ -15,0 +15,0 @@ "type": "git",

No alert changes

Improved metrics

Total package byte prevSize

2041919

increased by0.17%

Lines of code

38546

increased by0.09%

No dependency changes