@readme/oas-examples - npm Package Compare versions

Comparing version 5.18.1 to 5.18.2

3.0/json/security.json

@@ -129,3 +129,3 @@ {
       "post": {
-        "summary": "General support",
+        "summary": "General support (all flow types)",
         "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
@@ -143,2 +143,62 @@ "tags": ["OAuth 2"],
         ]
+      },
+      "get": {
+        "summary": "General support (authorizationCode flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_authorizationCode": ["write:things"]
+          }
+        ]
+      },
+      "put": {
+        "summary": "General support (clientCredentials flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_clientCredentials": ["write:things"]
+          }
+        ]
+      },
+      "patch": {
+        "summary": "General support (implicit flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_implicit": ["write:things"]
+          }
+        ]
+      },
+      "delete": {
+        "summary": "General support (password flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_password": ["write:things"]
+          }
+        ]
       }
@@ -278,6 +338,31 @@ },
       },
-      "oauth2_alternate": {
+      "oauth2_authorizationCode": {
         "type": "oauth2",
-        "description": "An alternate OAuth 2 security flow. Functions identially to the other `oauth2` scheme, just with alternate URLs to authenticate against. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
+        "description": "An OAuth 2 security flow that only supports the `authorizationCode` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
         "flows": {
+          "authorizationCode": {
+            "authorizationUrl": "http://alt.example.com/oauth/dialog",
+            "tokenUrl": "http://alt.example.com/oauth/token",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      },
+      "oauth2_clientCredentials": {
+        "type": "oauth2",
+        "description": "An OAuth 2 security flow that only supports the `clientCredentials` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
+        "flows": {
+          "clientCredentials": {
+            "tokenUrl": "http://alt.example.com/oauth/token",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      },
+      "oauth2_implicit": {
+        "type": "oauth2",
+        "description": "An OAuth 2 security flow that only supports the `implicit` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
+        "flows": {
           "implicit": {
@@ -291,2 +376,14 @@ "authorizationUrl": "http://alt.example.com/oauth/dialog",
       },
+      "oauth2_password": {
+        "type": "oauth2",
+        "description": "An OAuth 2 security flow that only supports the `password` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#oauth-flows-object",
+        "flows": {
+          "password": {
+            "tokenUrl": "http://alt.example.com/oauth/token",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      },
       "openIdConnect": {
@@ -293,0 +390,0 @@ "type": "openIdConnect",

3.1/json/security.json

@@ -148,4 +148,4 @@ {
       "post": {
-        "summary": "General support",
-        "description": ">ℹ️We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-23",
+        "summary": "General support (all flow types)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23",
         "tags": ["OAuth 2"],
@@ -162,2 +162,62 @@ "responses": {
         ]
+      },
+      "get": {
+        "summary": "General support (authorizationCode flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_authorizationCode": ["write:things"]
+          }
+        ]
+      },
+      "put": {
+        "summary": "General support (clientCredentials flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_clientCredentials": ["write:things"]
+          }
+        ]
+      },
+      "patch": {
+        "summary": "General support (implicit flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_implicit": ["write:things"]
+          }
+        ]
+      },
+      "delete": {
+        "summary": "General support (password flow type)",
+        "description": "> ℹ️\n> We currently do not handle OAuth 2 authentication flows so if an operation has an `oauth2` requirement we assume that the user, or the projects JWT, has a qualified `bearer` token and will use that.\n\nhttps://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23",
+        "tags": ["OAuth 2"],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "security": [
+          {
+            "oauth2_password": ["write:things"]
+          }
+        ]
       }
@@ -283,6 +343,31 @@ },
       },
-      "oauth2_alternate": {
+      "oauth2_authorizationCode": {
         "type": "oauth2",
-        "description": "An alternate OAuth 2 security flow. Functions identially to the other `oauth2` scheme, just with alternate URLs to authenticate against. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields-23",
+        "description": "An OAuth 2 security flow that only supports the `authorizationCode` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object",
         "flows": {
+          "authorizationCode": {
+            "authorizationUrl": "http://alt.example.com/oauth/dialog",
+            "tokenUrl": "http://alt.example.com/oauth/token",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      },
+      "oauth2_clientCredentials": {
+        "type": "oauth2",
+        "description": "An OAuth 2 security flow that only supports the `clientCredentials` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object",
+        "flows": {
+          "clientCredentials": {
+            "tokenUrl": "http://alt.example.com/oauth/token",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      },
+      "oauth2_implicit": {
+        "type": "oauth2",
+        "description": "An OAuth 2 security flow that only supports the `implicit` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object",
+        "flows": {
           "implicit": {
@@ -296,2 +381,14 @@ "authorizationUrl": "http://alt.example.com/oauth/dialog",
       },
+      "oauth2_password": {
+        "type": "oauth2",
+        "description": "An OAuth 2 security flow that only supports the `password` flow type. https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#oauth-flows-object",
+        "flows": {
+          "password": {
+            "tokenUrl": "http://alt.example.com/oauth/token",
+            "scopes": {
+              "write:things": "Add things to your account"
+            }
+          }
+        }
+      },
       "openIdConnect": {
@@ -298,0 +395,0 @@ "type": "openIdConnect",

package.json

 {
   "name": "@readme/oas-examples",
-  "version": "5.18.1",
+  "version": "5.18.2",
   "description": "A collection of example OpenAPI 3.x and Swagger 2.0 documents.",
@@ -5,0 +5,0 @@ "license": "MIT",

No alert changes

Improved metrics

Total package byte prevSize

2239834

0.69%

Lines of code

41722

0.49%

No dependency changes