Update PIM specs for Documentation changes (Azure#12815)

* PIM API Specs * update readme * Update * Update readme * operation id fix * name fix * Name changes * fix * Fix * Changes based on docs generated * Scope fix in example * Updates for documentation * Change operation name Co-authored-by: Aman Swaika <amansw@microsoft.com>
AzureSDKAutomation · Feb 9, 2021 · 17d5cbc · 17d5cbc
1 parent 2a6cde4
commit 17d5cbc
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 25 deletions.
diff --git a/...ce-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentSchedule.json b/...ce-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentSchedule.json
@@ -39,7 +39,7 @@
         "tags": [
           "roleAssignmentSchedules"
         ],
-        "operationId": "roleAssignmentSchedules_Get",
+        "operationId": "RoleAssignmentSchedules_Get",
         "description": "Get the specified role assignment schedule for a resource scope",
         "parameters": [
           {
@@ -87,7 +87,7 @@
         "tags": [
           "roleAssignmentSchedules"
         ],
-        "operationId": "roleAssignmentSchedules_ListForScope",
+        "operationId": "RoleAssignmentSchedules_ListForScope",
         "description": "Gets role assignment schedules for a resource scope.",
         "parameters": [
           {
@@ -103,7 +103,7 @@
             "in": "query",
             "required": false,
             "type": "string",
-            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role assignment schedules requested by the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user."
+            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role assignment schedules for the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user."
           },
           {
             "$ref": "#/parameters/ApiVersionParameter"

diff --git a/...er/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentScheduleInstance.json b/...er/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentScheduleInstance.json
@@ -39,7 +39,7 @@
         "tags": [
           "roleAssignmentScheduleInstances"
         ],
-        "operationId": "roleAssignmentScheduleInstances_ListForScope",
+        "operationId": "RoleAssignmentScheduleInstances_ListForScope",
         "description": "Gets role assignment schedule instances of a role assignment schedule.",
         "parameters": [
           {
@@ -55,7 +55,7 @@
             "in": "query",
             "required": false,
             "type": "string",
-            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal.  Use $filter=asRequestor() to return all role assignment schedules requested by the current user. Use $filter=asTarget() to return all role assignment schedules created for the current user."
+            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal.  Use $filter=assignedTo('{userId}') to return all role assignment schedule instances for the user. Use $filter=asTarget() to return all role assignment schedule instances created for the current user."
           },
           {
             "$ref": "#/parameters/ApiVersionParameter"
@@ -91,7 +91,7 @@
         "tags": [
           "roleAssignmentScheduleInstances"
         ],
-        "operationId": "roleAssignmentScheduleInstances_Get",
+        "operationId": "RoleAssignmentScheduleInstances_Get",
         "description": "Gets the specified role assignment schedule instance.",
         "parameters": [
           {

diff --git a/...ger/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentScheduleRequest.json b/...ger/Microsoft.Authorization/preview/2020-10-01-preview/RoleAssignmentScheduleRequest.json
@@ -404,7 +404,7 @@
             },
             "ticketSystem": {
               "type": "string",
-              "description": "Ticket number for the role assignment"
+              "description": "Ticket system name for the role assignment"
             }
           },
           "description": "Ticket Info of the role assignment"

diff --git a/...e-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilitySchedule.json b/...e-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilitySchedule.json
@@ -39,7 +39,7 @@
         "tags": [
           "roleEligibilitySchedules"
         ],
-        "operationId": "roleEligibilitySchedules_Get",
+        "operationId": "RoleEligibilitySchedules_Get",
         "description": "Get the specified role eligibility schedule for a resource scope",
         "parameters": [
           {
@@ -87,7 +87,7 @@
         "tags": [
           "roleEligibilitySchedules"
         ],
-        "operationId": "roleEligibilitySchedules_ListForScope",
+        "operationId": "RoleEligibilitySchedules_ListForScope",
         "description": "Gets role eligibility schedules for a resource scope.",
         "parameters": [
           {
@@ -103,7 +103,7 @@
             "in": "query",
             "required": false,
             "type": "string",
-            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedules requested by the current user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
+            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role eligibility schedules at or above the scope. Use $filter=principalId eq {id} to return all role eligibility schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
           },
           {
             "$ref": "#/parameters/ApiVersionParameter"

diff --git a/...r/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilityScheduleInstance.json b/...r/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilityScheduleInstance.json
@@ -39,7 +39,7 @@
         "tags": [
           "roleEligibilityScheduleInstances"
         ],
-        "operationId": "roleEligibilityScheduleInstances_ListForScope",
+        "operationId": "RoleEligibilityScheduleInstances_ListForScope",
         "description": "Gets role eligibility schedule instances of a role eligibility schedule.",
         "parameters": [
           {
@@ -55,7 +55,7 @@
             "in": "query",
             "required": false,
             "type": "string",
-            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=asRequestor() to return all role eligibility schedules requested by the current user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
+            "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignment schedules at or above the scope. Use $filter=principalId eq {id} to return all role assignment schedules at, above or below the scope for the specified principal. Use $filter=assignedTo('{userId}') to return all role eligibility schedules for the user. Use $filter=asTarget() to return all role eligibility schedules created for the current user."
           },
           {
             "$ref": "#/parameters/ApiVersionParameter"
@@ -91,7 +91,7 @@
         "tags": [
           "roleEligibilityScheduleInstances"
         ],
-        "operationId": "roleEligibilityScheduleInstances_Get",
+        "operationId": "RoleEligibilityScheduleInstances_Get",
         "description": "Gets the specified role eligibility schedule instance.",
         "parameters": [
           {

diff --git a/...er/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilityScheduleRequest.json b/...er/Microsoft.Authorization/preview/2020-10-01-preview/RoleEligibilityScheduleRequest.json
@@ -400,7 +400,7 @@
             },
             "ticketSystem": {
               "type": "string",
-              "description": "Ticket number for the role eligibility"
+              "description": "Ticket system name for the role eligibility"
             }
           },
           "description": "Ticket Info of the role eligibility"

diff --git a/...urce-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json b/...urce-manager/Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicy.json
@@ -39,7 +39,7 @@
         "tags": [
           "roleManagementPolicies"
         ],
-        "operationId": "roleManagementPolicies_Get",
+        "operationId": "RoleManagementPolicies_Get",
         "description": "Get the specified role management policy for a resource scope",
         "parameters": [
           {
@@ -85,7 +85,7 @@
         "tags": [
           "roleManagementPolicies"
         ],
-        "operationId": "roleManagementPolicies_Create",
+        "operationId": "RoleManagementPolicies_Update",
         "description": "Update or create a role management policy",
         "parameters": [
           {
@@ -140,7 +140,7 @@
         "tags": [
           "roleManagementPolicies"
         ],
-        "operationId": "roleManagementPolicies_Delete",
+        "operationId": "RoleManagementPolicies_Delete",
         "description": "Delete a role management policy",
         "parameters": [
           {
@@ -188,7 +188,7 @@
         "tags": [
           "roleManagementPolicies"
         ],
-        "operationId": "roleManagementPolicies_ListForScope",
+        "operationId": "RoleManagementPolicies_ListForScope",
         "description": "Gets role management policies for a resource scope.",
         "parameters": [
           {

diff --git a/...er/Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicyAssignment.json b/...er/Microsoft.Authorization/preview/2020-10-01-preview/RoleManagementPolicyAssignment.json
@@ -39,7 +39,7 @@
         "tags": [
           "roleManagementPolicyAssignments"
         ],
-        "operationId": "roleManagementPolicyAssignments_Get",
+        "operationId": "RoleManagementPolicyAssignments_Get",
         "description": "Get the specified role management policy assignment for a resource scope",
         "parameters": [
           {
@@ -85,7 +85,7 @@
         "tags": [
           "roleManagementPolicyAssignments"
         ],
-        "operationId": "roleManagementPolicyAssignments_Create",
+        "operationId": "RoleManagementPolicyAssignments_Create",
         "description": "Create a role management policy assignment",
         "parameters": [
           {
@@ -140,7 +140,7 @@
         "tags": [
           "roleManagementPolicyAssignments"
         ],
-        "operationId": "roleManagementPolicyAssignments_Delete",
+        "operationId": "RoleManagementPolicyAssignments_Delete",
         "description": "Delete a role management policy assignment",
         "parameters": [
           {
@@ -188,7 +188,7 @@
         "tags": [
           "roleManagementPolicyAssignments"
         ],
-        "operationId": "roleManagementPolicyAssignments_ListForScope",
+        "operationId": "RoleManagementPolicyAssignments_ListForScope",
         "description": "Gets role management assignment policies for a resource scope.",
         "parameters": [
           {

diff --git a/...oft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyByScope.json b/...oft.Authorization/preview/2020-10-01-preview/examples/GetRoleManagementPolicyByScope.json
@@ -1,6 +1,6 @@
 {
   "parameters": {
-    "scope": "subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f",
+    "scope": "subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3",
     "api-version": "2020-10-01-preview"
   },
   "responses": {

diff --git a/....Authorization/preview/2020-10-01-preview/examples/PutRoleManagementPolicyAssignment.json b/....Authorization/preview/2020-10-01-preview/examples/PutRoleManagementPolicyAssignment.json
@@ -6,7 +6,7 @@
     "parameters": {
       "properties": {
         "scope": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3",
-        "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
+        "roleDefinitionId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
         "policyId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/RoleManagementPolicies/477f2d04-0fdc-417f-ab1b-d9fff8137134"
       }
     }
@@ -16,7 +16,7 @@
       "body": {
         "properties": {
           "scope": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3",
-          "roleDefinitionId": "/subscriptions/dfa2a084-766f-4003-8ae1-c4aeb893a99f/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
+          "roleDefinitionId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/roleDefinitions/a37489be-9462-48fb-a3b6-7b9bc2debbad",
           "policyId": "/subscriptions/892f85f0-fd69-4fe8-8ee2-bda821252ac3/providers/Microsoft.Authorization/RoleManagementPolicies/477f2d04-0fdc-417f-ab1b-d9fff8137134"
         },
         "name": "477f2d04-0fdc-417f-ab1b-d9fff8137134_a37489be-9462-48fb-a3b6-7b9bc2debbad",