Apim 2019 12 01 preview

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimanagement.json

@@ -635,6 +635,17 @@
       "pattern": "^[^*#&+:<>?]+$",
       "x-ms-parameter-location": "method"
     },
+    "TagDescriptionIdParameter": {
+      "name": "tagDescriptionId",
+      "in": "path",
+      "required": true,
+      "type": "string",
+      "description": "Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.",
+      "minLength": 1,
+      "maxLength": 80,
+      "pattern": "^[^*#&+:<>?]+$",
+      "x-ms-parameter-location": "method"
+    },
     "TemplateNameParameter": {
       "name": "templateName",
       "in": "path",

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimapis.json

@@ -2305,7 +2305,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "./definitions.json#/definitions/SchemaCreateOrUpdateContract"
+              "$ref": "./definitions.json#/definitions/SchemaContract"
             },
             "description": "The schema contents to apply."
           },
@@ -3794,7 +3794,7 @@
         "x-ms-odata": "./definitions.json#/definitions/TagDescriptionContract"
       }
     },
-    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagId}": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}": {
       "head": {
         "tags": [
           "ApiTagDescription"
@@ -3817,7 +3817,7 @@
             "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
           },
           {
-            "$ref": "./apimanagement.json#/parameters/TagIdParameter"
+            "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
           },
           {
             "$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
@@ -3866,7 +3866,7 @@
             "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
           },
           {
-            "$ref": "./apimanagement.json#/parameters/TagIdParameter"
+            "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
           },
           {
             "$ref": "./apimanagement.json#/parameters/ApiVersionParameter"
@@ -3918,7 +3918,7 @@
             "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
           },
           {
-            "$ref": "./apimanagement.json#/parameters/TagIdParameter"
+            "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
           },
           {
             "name": "parameters",
@@ -3994,7 +3994,7 @@
             "$ref": "./apimanagement.json#/parameters/ApiIdRevParameter"
           },
           {
-            "$ref": "./apimanagement.json#/parameters/TagIdParameter"
+            "$ref": "./apimanagement.json#/parameters/TagDescriptionIdParameter"
           },
           {
             "$ref": "./apimanagement.json#/parameters/IfMatchRequiredParameter"

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimpolicysnippets.json → specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimpolicydescriptions.json

@@ -34,16 +34,16 @@
     }
   },
   "paths": {
-    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets": {
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyDescriptions": {
       "get": {
         "tags": [
-          "PolicySnippet"
+          "PolicyDescription"
         ],
-        "operationId": "PolicySnippet_ListByService",
-        "description": "Lists all policy snippets.",
+        "operationId": "PolicyDescription_ListByService",
+        "description": "Lists all policy descriptions.",
         "x-ms-examples": {
-          "ApiManagementListPolicySnippets": {
-            "$ref": "./examples/ApiManagementListPolicySnippets.json"
+          "ApiManagementListPolicyDescriptions": {
+            "$ref": "./examples/ApiManagementListPolicyDescriptions.json"
           }
         },
         "parameters": [
@@ -80,9 +80,9 @@
         ],
         "responses": {
           "200": {
-            "description": "Returns an array of Policy Snippets.",
+            "description": "Returns an array of policy descriptions.",
             "schema": {
-              "$ref": "./definitions.json#/definitions/PolicySnippetsCollection"
+              "$ref": "./definitions.json#/definitions/PolicyDescriptionCollection"
             }
           },
           "default": {

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/definitions.json

@@ -484,6 +484,11 @@
     },
     "ApiRevisionContract": {
       "properties": {
+        "id": {
+          "readOnly": true,
+          "type": "string",
+          "description": "Resource ID."
+        },
         "apiId": {
           "type": "string",
           "readOnly": true,
@@ -3232,21 +3237,26 @@
       ],
       "description": "Policy contract Properties."
     },
-    "PolicySnippetContract": {
+    "PolicyDescriptionContract": {
       "properties": {
-        "name": {
-          "type": "string",
-          "description": "Snippet name.",
-          "readOnly": true
-        },
-        "content": {
-          "type": "string",
-          "description": "Snippet content.",
-          "readOnly": true
-        },
-        "toolTip": {
+        "properties": {
+          "x-ms-client-flatten": true,
+          "$ref": "#/definitions/PolicyDescriptionContractProperties",
+          "description": "Policy description contract properties."
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "./apimanagement.json#/definitions/Resource"
+        }
+      ],
+      "description": "Policy description details."
+    },
+    "PolicyDescriptionContractProperties": {
+      "properties": {
+        "description": {
           "type": "string",
-          "description": "Snippet toolTip.",
+          "description": "Policy description.",
           "readOnly": true
         },
         "scope": {
@@ -3255,19 +3265,24 @@
           "readOnly": true
         }
       },
-      "description": "Policy snippet."
+      "description": "Policy description properties."
     },
-    "PolicySnippetsCollection": {
+    "PolicyDescriptionCollection": {
       "properties": {
         "value": {
           "type": "array",
           "items": {
-            "$ref": "#/definitions/PolicySnippetContract"
+            "$ref": "#/definitions/PolicyDescriptionContract"
           },
-          "description": "Policy snippet value."
+          "description": "Descriptions of APIM policies."
+        },
+        "count": {
+          "type": "integer",
+          "format": "int64",
+          "description": "Total record count number."
         }
       },
-      "description": "The response of the list policy snippets operation."
+      "description": "Descriptions of APIM policies."
     },
     "PortalDelegationSettings": {
       "properties": {
@@ -4208,21 +4223,6 @@
       },
       "description": "The response of the list schema operation."
     },
-    "SchemaCreateOrUpdateContract": {
-      "properties": {
-        "properties": {
-          "x-ms-client-flatten": true,
-          "$ref": "#/definitions/SchemaCreateOrUpdateProperties",
-          "description": "Properties of the Schema."
-        }
-      },
-      "allOf": [
-        {
-          "$ref": "./apimanagement.json#/definitions/Resource"
-        }
-      ],
-      "description": "Schema Contract details."
-    },
     "SchemaContract": {
       "properties": {
         "properties": {
@@ -4239,22 +4239,6 @@
       "description": "Schema Contract details."
     },
     "SchemaContractProperties": {
-      "properties": {
-        "contentType": {
-          "type": "string",
-          "description": "Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). </br> - `Swagger` Schema use `application/vnd.ms-azure-apim.swagger.definitions+json` </br> - `WSDL` Schema use `application/vnd.ms-azure-apim.xsd+xml` </br> - `OpenApi` Schema use `application/vnd.oai.openapi.components+json` </br> - `WADL Schema` use `application/vnd.ms-azure-apim.wadl.grammars+xml`. "
-        },
-        "document": {
-          "type": "object",
-          "description": "Properties of the Schema Document."
-        }
-      },
-      "required": [
-        "contentType"
-      ],
-      "description": "Schema contract Properties."
-    },
-    "SchemaCreateOrUpdateProperties": {
       "properties": {
         "contentType": {
           "type": "string",
@@ -4275,7 +4259,11 @@
       "properties": {
         "value": {
           "type": "string",
-          "description": "Json escaped string defining the document representing the Schema."
+          "description": "Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI."
+        },
+        "definitions": {
+          "type": "object",
+          "description": "Types definitions. Used for Swagger/OpenAPI schemas only, null otherwise."
         }
       },
       "description": "Schema Document Properties."
@@ -4664,6 +4652,10 @@
     },
     "TagDescriptionContractProperties": {
       "properties": {
+        "tagId": {
+          "type": "string",
+          "description": "Identifier of the tag in the form of /tags/{tagId}"
+        },
         "displayName": {
           "type": "string",
           "description": "Tag name.",

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementCreateApiTagDescription.json

@@ -5,7 +5,7 @@
     "api-version": "2019-12-01-preview",
     "subscriptionId": "subid",
     "apiId": "5931a75ae4bbd512a88c680b",
-    "tagId": "tagId1",
+    "tagDescriptionId": "tagId1",
     "parameters": {
       "properties": {
         "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
@@ -17,25 +17,27 @@
   "responses": {
     "201": {
       "body": {
-        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
-        "type": "Microsoft.ApiManagement/service/tags",
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
+        "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
         "name": "tagId1",
         "properties": {
+          "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
           "displayName": "tag1",
-          "description": null,
+          "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
           "externalDocsDescription": "some additional info",
           "externalDocsUrl": "http://some_url.com"
         }
       }
     },
     "200": {
       "body": {
-        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
-        "type": "Microsoft.ApiManagement/service/tags",
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
+        "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
         "name": "tagId1",
         "properties": {
+          "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
           "displayName": "tag1",
-          "description": null,
+          "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
           "externalDocsDescription": "some additional info",
           "externalDocsUrl": "http://some_url.com"
         }

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementDeleteApiTagDescription.json

@@ -5,7 +5,7 @@
     "api-version": "2019-12-01-preview",
     "subscriptionId": "subid",
     "apiId": "59d5b28d1f7fab116c282650",
-    "tagId": "59d5b28e1f7fab116402044e",
+    "tagDescriptionId": "59d5b28e1f7fab116402044e",
     "If-Match": "*"
   },
   "responses": {

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementGetApiTagDescription.json

@@ -5,15 +5,16 @@
     "api-version": "2019-12-01-preview",
     "subscriptionId": "subid",
     "apiId": "59d6bb8f1f7fab13dc67ec9b",
-    "tagId": "59306a29e4bbd510dc24e5f9"
+    "tagDescriptionId": "59306a29e4bbd510dc24e5f9"
   },
   "responses": {
     "200": {
       "body": {
-        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9",
-        "type": "Microsoft.ApiManagement/service/tags",
+        "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/59d6bb8f1f7fab13dc67ec9b/tagDescriptions/59306a29e4bbd510dc24e5f9",
+        "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
         "name": "59306a29e4bbd510dc24e5f9",
         "properties": {
+          "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9",
           "displayName": "tag1",
           "description": null,
           "externalDocsDescription": "some additional info",

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementHeadApiTagDescription.json

@@ -5,7 +5,7 @@
     "api-version": "2019-12-01-preview",
     "subscriptionId": "subid",
     "apiId": "59d6bb8f1f7fab13dc67ec9b",
-    "tagId": "59306a29e4bbd510dc24e5f9"
+    "tagDescriptionId": "59306a29e4bbd510dc24e5f9"
   },
   "responses": {
     "200": {

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementListApiRevisions.json

@@ -11,6 +11,7 @@
       "body": {
         "value": [
           {
+            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1/revisions/a1;rev=1",
             "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1;rev=1",
             "apiRevision": "1",
             "createdDateTime": "2018-02-01T22:21:20.467Z",

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementListApiTagDescriptions.json

@@ -11,10 +11,11 @@
       "body": {
         "value": [
           {
-            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
+            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002",
             "type": "Microsoft.ApiManagement/service/tags",
             "name": "5600b539c53f5b0062060002",
             "properties": {
+              "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
               "displayName": "tag1",
               "externalDocsDescription": "some additional info",
               "externalDocsUrl": "http://some_url.com"

specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/examples/ApiManagementListPolicyDescriptions.json

@@ -0,0 +1,36 @@
+{
+  "parameters": {
+    "serviceName": "apimService1",
+    "resourceGroupName": "rg1",
+    "api-version": "2019-12-01-preview",
+    "subscriptionId": "subid",
+    "scope": "Api"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-basic",
+            "type": "Microsoft.ApiManagement/service/policyDescriptions",
+            "name": "authentication-basic",
+            "properties": {
+              "description": "Authenticate with the backend service using Basic authentication. Use in the inbound section at API scope.",
+              "scope": 268435471
+            }
+          },
+          {
+            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyDescriptions/authentication-certificate",
+            "type": "Microsoft.ApiManagement/service/policyDescriptions",
+            "name": "authentication-certificate",
+            "properties": {
+              "description": "Authenticate with the backend service using a client certificate. Use in the inbound section at API scope.",
+              "scope": 268435471
+            }
+          }
+        ],
+        "count": 2
+      }
+    }
+  }
+}