Weekly OpenApiDocs Download (#1373)

* Add option to skip force refresh.

* Add option to set base branch.

* Weekly OpenApiDocs Download. [run ci]

Co-authored-by: Peter Ombwa <[email protected]>
Co-authored-by: Microsoft Graph DevX Tooling <[email protected]>
Co-authored-by: Peter Ombwa <[email protected]>

Author: 3 people

.azure-pipelines/common-templates/download-openapi-docs.yml

@@ -8,6 +8,8 @@ parameters:
     type: string
   - name: BuildAgent
     displayName: Build Agent
+  - name: SkipForceRefresh
+    type: string
 
 jobs:
   - job: GetLatestDocs
@@ -45,14 +47,15 @@ jobs:
         continueOnError: false
         inputs:
           filePath: "$(System.DefaultWorkingDirectory)/tools/UpdateOpenApi.ps1"
+          arguments: -SkipForceRefresh:$$(SkipForceRefresh)
           pwsh: true
 
       - task: PowerShell@2
         displayName: Download beta OpenApi docs
         continueOnError: false
         inputs:
           filePath: "$(System.DefaultWorkingDirectory)/tools/UpdateOpenApi.ps1"
-          arguments: "-BetaGraphVersion"
+          arguments: -BetaGraphVersion -SkipForceRefresh:$$(SkipForceRefresh)
           pwsh: true
 
       - task: PowerShell@2

.azure-pipelines/weekly-generation.yml

@@ -5,13 +5,21 @@ name: $(BuildDefinitionName)_$(SourceBranchName)_$(Date:yyyyMMdd)$(Rev:.r)
 
 parameters:
   - name: BuildAgent
-    default: 1es-windows-ps-compute
     displayName: Build Agent
+    default: 1es-windows-ps-compute
+  - name: BaseBranch
+    displayName: Base Branch
+    default: dev
+  - name: SkipForceRefresh
+    displayName: Skip Force Refresh
+    default: false
+    type: boolean
 
 variables:
   Branch: "WeeklyOpenApiDocsDownload"
-  BaseBranch: "dev"
+  BaseBranch: ${{ parameters.BaseBranch }}
   BuildAgent: ${{ parameters.BuildAgent }}
+  SkipForceRefresh: ${{ parameters.SkipForceRefresh }}
 
 pool: $(BuildAgent)
 trigger: none
@@ -33,6 +41,7 @@ stages:
           Branch: $(Branch)
           BaseBranch: $(BaseBranch)
           BuildAgent: $(BuildAgent)
+          SkipForceRefresh: $(SkipForceRefresh)
 
   - stage: GenerateServiceModules
     displayName: Generate service modules

openApiDocs/beta/CloudCommunications.yml

@@ -8595,11 +8595,11 @@ components:
       properties:
         displayName:
           type: string
-          description: 'The identity''s display name. Note that this may not always be available or up to date. For example, if a user changes their display name, the API may show the new value in a future response, but the items associated with the user won''t show up as having changed when using delta.'
+          description: The display name of the identity. This property is read-only.
           nullable: true
         id:
           type: string
-          description: Unique identifier for the identity.
+          description: The identifier of the identity. This property is read-only.
           nullable: true
       additionalProperties:
         type: object
@@ -9036,7 +9036,7 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/microsoft.graph.callRecords.traceRouteHop'
-          description: List of network trace route hops collected for this media stream.*
+          description: List of network trace route hops collected for this media stream.
         wifiBand:
           $ref: '#/components/schemas/microsoft.graph.callRecords.wifiBand'
         wifiBatteryCharge:
@@ -9396,7 +9396,7 @@ components:
           maximum: 2147483647
           minimum: -2147483648
           type: integer
-          description: The network path count of this hop that was used to compute the round-trip time.
+          description: The network path count of this hop that was used to compute the RTT.
           format: int32
           nullable: true
         ipAddress:

openApiDocs/beta/DeviceManagement.Enrolment.yml

@@ -22056,7 +22056,7 @@ components:
           properties:
             memberType:
               type: string
-              description: 'Membership type of the eligible assignment. It can either be Inherited, Direct, or Group.'
+              description: 'Membership type of the eligible assignment. It can either be Inherited, Direct, or Group. Supports $filter (eq).'
               nullable: true
             scheduleInfo:
               $ref: '#/components/schemas/microsoft.graph.requestSchedule'
@@ -22110,37 +22110,37 @@ components:
           properties:
             action:
               type: string
-              description: 'Represents the type of the operation on the role eligibility assignment. The possible values are: AdminAssign: For administrators to assign role eligibility to users or groups to roles.AdminExtend: For administrators to extend expiring assignments.AdminUpdate: For administrators to change existing role assignments.AdminRenew: For administrators to renew expired assignments.AdminRemove: For administrators to remove users or groups from eligible roles.UserAdd: For users to activate their eligible assignments.UserExtend: For users to request to extend their expiring eligible assignments.UserRemove: For users to deactivate their active eligible assignments.UserRenew: For users to request to renew their expired eligible assignments.'
+              description: 'Represents the type of operation on the role eligibility request. The possible values are: AdminAssign: For administrators to assign eligible roles to principals.AdminRemove: For administrators to remove eligible roles from principals. AdminUpdate: For administrators to change existing role eligibilities.AdminExtend: For administrators to extend expiring role eligibilities.AdminRenew: For administrators to renew expired eligibilities.UserAdd: For users to activate their eligible assignments.UserRemove: For users to deactivate their active eligible assignments.UserExtend: For users to request to extend their expiring eligible assignments.UserRenew: For users to request to renew their expired eligible assignments.'
               nullable: true
             appScopeId:
               type: string
-              description: 'Identifier of the app-specific scope when the assignment scope is app-specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units.'
+              description: 'Identifier of the app-specific scope when the role eligibility is scoped to an app. The scope of a role eligibility determines the set of resources for which the principal is eligible to access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, ne, and on null values).'
               nullable: true
             directoryScopeId:
               type: string
-              description: Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only.
+              description: 'Identifier of the directory object representing the scope of the role eligibility. The scope of a role eligibility determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, ne, and on null values).'
               nullable: true
             isValidationOnly:
               type: boolean
-              description: A boolean that determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
+              description: Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request.
               nullable: true
             justification:
               type: string
-              description: A message provided by users and administrators when create the request about why it is needed.
+              description: A message provided by users and administrators when create they create the unifiedRoleEligibilityScheduleRequest object.
               nullable: true
             principalId:
               type: string
-              description: 'Identifier of the principal to which the assignment is being granted to. For example, a user or a group. For groups, they must be assignable to roles, that is, the isAssignableToRole of the group property set to true.'
+              description: 'Identifier of the principal that has been granted the role eligibility. Supports $filter (eq, ne).'
               nullable: true
             roleDefinitionId:
               type: string
-              description: Identifier of the unifiedRoleDefinition the assignment is for. Read only.
+              description: 'Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports $filter (eq, ne).'
               nullable: true
             scheduleInfo:
               $ref: '#/components/schemas/microsoft.graph.requestSchedule'
             targetScheduleId:
               type: string
-              description: The time period for which the eligibility assignment is valid.
+              description: 'Identifier of the schedule object that''s linked to the eligibility request. Supports $filter (eq, ne).'
               nullable: true
             ticketInfo:
               $ref: '#/components/schemas/microsoft.graph.ticketInfo'
@@ -22979,11 +22979,11 @@ components:
       properties:
         displayName:
           type: string
-          description: The display name of the identity. This property is read-only.
+          description: 'The identity''s display name. Note that this may not always be available or up to date. For example, if a user changes their display name, the API may show the new value in a future response, but the items associated with the user won''t show up as having changed when using delta.'
           nullable: true
         id:
           type: string
-          description: The identifier of the identity. This property is read-only.
+          description: Unique identifier for the identity.
           nullable: true
       additionalProperties:
         type: object

openApiDocs/beta/DeviceManagement.yml

@@ -56511,7 +56511,7 @@ components:
               description: State of license assignments for this user. Read-only. Returned only on $select.
             mail:
               type: string
-              description: 'The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user''s proxyAddresses collection to include the value as an SMTP address. This property cannot contain accent characters.  NOTE: We do not recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead.  Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
+              description: 'The SMTP address for the user, for example, [email protected]. Changes to this property will also update the user''s proxyAddresses collection to include the value as an SMTP address. For Azure AD B2C accounts, this property can be updated up to only ten times with unique SMTP addresses. This property cannot contain accent characters.  Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values).'
               nullable: true
             mailNickname:
               type: string
@@ -69160,11 +69160,11 @@ components:
       properties:
         displayName:
           type: string
-          description: 'The identity''s display name. Note that this may not always be available or up to date. For example, if a user changes their display name, the API may show the new value in a future response, but the items associated with the user won''t show up as having changed when using delta.'
+          description: The display name of the identity. This property is read-only.
           nullable: true
         id:
           type: string
-          description: Unique identifier for the identity.
+          description: The identifier of the identity. This property is read-only.
           nullable: true
       additionalProperties:
         type: object

openApiDocs/beta/Devices.CloudPrint.yml

@@ -14902,7 +14902,7 @@ components:
               type: array
               items:
                 type: string
-              description: 'A list of additional email addresses for the user; for example: [''[email protected]'', ''[email protected]''].NOTE: This property cannot contain accent characters.Supports $filter (eq, not, ge, le, in, startsWith, and counting empty collections).'
+              description: 'A list of additional email addresses for the user; for example: [''[email protected]'', ''[email protected]''].NOTE: This property cannot contain accent characters.Supports $filter (eq, not, ge, le, in, startsWith, endsWith, and counting empty collections).'
             passwordPolicies:
               type: string
               description: 'Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two may be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. For more information on the default password policies, see Azure AD pasword policies. Supports $filter (ne, not, and eq on null values).'
@@ -15179,7 +15179,7 @@ components:
               type: array
               items:
                 $ref: '#/components/schemas/microsoft.graph.extension'
-              description: The collection of open extensions defined for the user. Nullable.
+              description: The collection of open extensions defined for the user. Supports $expand. Nullable.
             appConsentRequestsForApproval:
               type: array
               items:
@@ -16078,6 +16078,7 @@ components:
           properties:
             onPremisesGroupType:
               type: string
+              description: 'Indicates the target on-premise group type the cloud object will be written back as. Nullable. The possible values are: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup. + If the cloud group is a unified (Microsoft 365) group, this property can be one of the following: universalDistributionGroup, universalSecurityGroup, universalMailEnabledSecurityGroup.  + Azure AD security groups can be written back as universalSecurityGroup.  + If isEnabled or the NewUnifiedGroupWritebackDefault group setting is true but this property is not explicitly configured:    + Microsoft 365 groups will be written back as universalDistributionGroup by default    + Security groups will be written back as universalSecurityGroup by default'
               nullable: true
           additionalProperties:
             type: object
@@ -19223,6 +19224,10 @@ components:
               description: The content stream of the alternative recording of a Microsoft Teams live event. Read-only.
               format: base64url
               nullable: true
+            anonymizeIdentityForRoles:
+              type: array
+              items:
+                $ref: '#/components/schemas/microsoft.graph.onlineMeetingRole'
             attendeeReport:
               type: string
               description: The content stream of the attendee report of a Teams live event. Read-only.
@@ -20595,6 +20600,7 @@ components:
       properties:
         isEnabled:
           type: boolean
+          description: Indicates whether writeback of cloud groups to on-premise Active Directory is enabled. Default value is true for Microsoft 365 groups and false for security groups.
           nullable: true
       additionalProperties:
         type: object
@@ -26117,6 +26123,15 @@ components:
         - limited
         - unknownFutureValue
       type: string
+    microsoft.graph.onlineMeetingRole:
+      title: onlineMeetingRole
+      enum:
+        - attendee
+        - presenter
+        - unknownFutureValue
+        - producer
+        - coorganizer
+      type: string
     microsoft.graph.audioConferencing:
       title: audioConferencing
       type: object
@@ -31748,6 +31763,8 @@ components:
               $ref: '#/components/schemas/microsoft.graph.patternedRecurrence'
             reminderDateTime:
               $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
+            startDateTime:
+              $ref: '#/components/schemas/microsoft.graph.dateTimeTimeZone'
             status:
               $ref: '#/components/schemas/microsoft.graph.taskStatus'
             title:
@@ -33647,15 +33664,6 @@ components:
         - other
         - unknownFutureValue
       type: string
-    microsoft.graph.onlineMeetingRole:
-      title: onlineMeetingRole
-      enum:
-        - attendee
-        - presenter
-        - unknownFutureValue
-        - producer
-        - coorganizer
-      type: string
     microsoft.graph.attendanceInterval:
       title: attendanceInterval
       type: object