DRG Graph parameters description definition

[William-Francillette]

Do you know a way to retrieve the description of a parameter to automate the generation in the DRG?

I can retrieve it for Intune parameters using the devicemanagement/settingDefinition Graph query but can't find anything for the rest of the commands

Thanks

[andikrueger]

What kind of information are you looking for? Could you share an example?

[William-Francillette]

Sure, I'm looking at retrieving this description info if that's possible

for schema file

[andikrueger]

could you share the URL to the table above?

[William-Francillette]

https://learn.microsoft.com/en-us/graph/api/resources/customaccesspackageworkflowextension?view=graph-rest-beta

I'm after something generic I could reuse for the DRG
The master schema ("https://metadataexplorerstorage.blob.core.windows.net/`$web/$($Version).js") does not return the descriptions...

[andikrueger]

I think, that I faced this challenge while creating the first version of the DRG. Back then, we skipped this part, as this kind of information was only available through parsing the documentation. Parsing the table to get the information shouldn't be that difficult though.

@peombwa Are there any new endpoints or tools available that could help with this matter?

[peombwa]

Assuming you know the entityType, you can either use; the OpenAPI document or the clean metadata with descriptions CSDL to access property descriptions. The files are available at https://github.com/microsoftgraph/msgraph-metadata and are updated on a weekly basis whenever there are API changes.

Descriptions in the OpenAPI document:

Descriptions in the metadata:

I'm not aware of a tool that currently returns descriptions other than the two above approaches. This is what we use to provide descriptions for our SDKs as well - https://github.com/microsoftgraph/msgraph-beta-sdk-dotnet/blob/master/src/Microsoft.Graph/Generated/model/CustomCalloutExtension.cs#L32-L37.

[William-Francillette]

That's exactly what I was looking for
Thanks @peombwa and @andikrueger

[andikrueger]

Thanks @William-Francillette for bringing this up. Let me know if you need any additional assistance to get the description into the schema.

[William-Francillette]

Are you ok to use PowerShell-yaml to convert the yaml to hashtable?
https://www.powershellgallery.com/packages/powershell-yaml/0.4.0
https://github.com/cloudbase/powershell-yaml

I haven't tested it so can't confirmed if it will be the right solution for the DRG but wanted to ask if you guys see any issue before I start.

[andikrueger]

Any chance to use the xml file instead of the yaml ones? I would go with a solution that would not require third party libraries

are there any functional differences between the xml and yaml files?

[William-Francillette]

Just realised the xml 🤯- no worries I'll that one instead

[ykuijs]

Fixed via #2721