OData cast paths should follow the same naming convention for tags and operationIds as non-OData cast paths #324

Activity

1. Carol Kigoonya (CarolKigoonya)

   added this to the OData:1.3 milestone on Jan 24, 2023
2. Peter Ombwa (peombwa)

   added

   priority:p1High priority but not blocking. Causes major but not critical loss of functionality SLA <=7daysHigh priority but not blocking. Causes major but not critical loss of functionality SLA <=7days

   on Jan 24, 2023
3. Irvine Sunday (irvinesunday)

   self-assigned this

   on Jan 30, 2023
4. irvinesunday commented on Feb 1, 2023

   

   Irvine Sunday (irvinesunday)

   on Feb 1, 2023

   Contributor

   More actions

   How about operation ids of $count segments appended to OData cast paths? Example:

    /directoryRoles/{directoryRole-id}/members/microsoft.graph.device/$count':
     description: Provides operations to count the resources in the collection.
     get:
       summary: Get the number of the resource
       operationId: Get.Count.microsoft.graph.device-e712

   Would the operation id: Get.Count.microsoft.graph.device-e712 also need to be updated as Get.Count.AsDevice-e712?
5. irvinesunday commented on Feb 1, 2023

   

   Irvine Sunday (irvinesunday)

   on Feb 1, 2023

   Contributor

   More actions

   Currently, we don't generate tag names for $count and complex property paths.
   What tag naming convention do you think will be most appropriate for:

   1. $count paths. Example is the one mentioned above
   2. Complex property paths. Example:

   '/admin/serviceAnnouncement/issues/{serviceHealthIssue-id}/posts':
       get:
         summary: Get posts property value
         description: Collection of historical posts for the service issue.
         operationId: posts.serviceHealthIssuePost.ListServiceHealthIssuePost
         parameters:

   Peter Ombwa (@peombwa) Vincent Biret (@baywet) Millicent Achieng (@millicentachieng)
6. baywet commented on Feb 1, 2023

   

   Vincent Biret (baywet)

   on Feb 1, 2023

   Member

   More actions

   I don't have an opinion on the matter either way, kiota doesn't make use of tags or operation IDs. I think Peter's opinion is probably the most relevant here.

   👍React with 👍1Reacted by Irvine Sunday
7. peombwa commented on Feb 6, 2023

   

   Peter Ombwa (peombwa)

   on Feb 6, 2023

   ContributorAuthor

   More actions

   Irvine Sunday (@irvinesunday), good question. We currently don't support /$count in PowerShell. However, we can use the following operationIds and tags for:

   1. /$count paths:

   /directoryRoles/{directoryRole-id}/members/$count':
   description: Provides operations to count the resources in the collection.
   get:
     tags:
       - directoryRoles.directoryObject
     summary: Get the number of the resource
     operationId: directoryRoles.Members.GetCount

   2. /$count on OData cast paths:

   /directoryRoles/{directoryRole-id}/members/microsoft.graph.device/$count':
     description: Provides operations to count the resources in the collection.
     get:
       tags:
         - directoryRoles.directoryObject
       summary: Get the number of the resource
       operationId: directoryRoles.Members.GetCount.AsDevice

   3. Complex property paths (if supported):

   '/admin/serviceAnnouncement/issues/{serviceHealthIssue-id}/posts':
     get:
       tags:
         - admin.serviceAnnouncement
       summary: Get posts property value
       description: Collection of historical posts for the service issue.
       operationId: admin.serviceAnnouncement.issues.ListPosts

   Do we currently generate paths for collection of complex property types? I couldn't find /admin/serviceAnnouncement/issues/{serviceHealthIssue-id}/posts in https://github.com/microsoftgraph/msgraph-metadata/tree/master/openapi/v1.0.

   tags should ideally maintain the current naming convention of regular paths for consitency when slicing the API i.e., [EntitySet]/[Singleton].[EntityType/Actions/Functions].

   👍React with 👍1Reacted by Irvine Sunday
8. peombwa commented on Feb 6, 2023

   

   Peter Ombwa (peombwa)

   on Feb 6, 2023

   ContributorAuthor

   More actions

   Irvine Sunday (@irvinesunday) , since OperationIds are not used by Kiota, can we standardize the naming of operationIds at the OData -> OpenAPI conversion layer instead of modifying them in DevX API at PowershellFormatter.cs?
9. irvinesunday commented on Mar 14, 2023

   

   Irvine Sunday (irvinesunday)

   on Mar 14, 2023

   Contributor

   More actions

   Irvine Sunday (@irvinesunday) , since OperationIds are not used by Kiota, can we standardize the naming of operationIds at the OData -> OpenAPI conversion layer instead of modifying them in DevX API at PowershellFormatter.cs?

   There are other clients who rely on the operation ids. See this issue for example: It is better to have them standardized as they currently in the conversion layer.
10. vivian (adhiambovivian)

    added

    type:enhancementEnhancement request targeting an existing experience.Enhancement request targeting an existing experience.

    on Mar 24, 2023
11. Irvine Sunday (irvinesunday)

    closed this as completedin #338on Mar 29, 2023