search

microsoftgraph / microsoft-graph-devx-api

Services API for Graph Explorer
MIT License
88 stars 31 forks source link

Generate code snippets for examples in conceptual articles #880

Closed FaithOmbongi closed 1 year ago

FaithOmbongi commented 2 years ago

Is your feature request related to a problem? Please describe. Describe the solution you'd like Currently, code snippets are generated only for examples in reference page types. We have several examples in conceptual page content (LEARN node) and these too need code snippets so that they shouldn't be manually created. Example: https://docs.microsoft.com/en-us/graph/tutorial-accessreviews-securitygroup

Describe alternatives you've considered Manually creating code snippets. Not feasible.

Additional context A while back, we had code snippets generated for conceptual pages. I don't know how they disappeared. But it would be great for the end-to-end developer guidance if we can have the feature re-implemeneted.

FaithOmbongi commented 2 years ago

Gentle ping @maisarissi, @zengin - do we have an ETA for this request? We're publishing a number of conceptual docs with examples and would love it if we can have the code snippets for those examples.

andrueastman commented 2 years ago

It looks like this page is a conceptual doc and has code snippets generated.

https://docs.microsoft.com/en-us/graph/outlook-calendar-online-meetings?tabs=http

This shows that APIDoctor does indeed scan and pick http examples from conceptual articles but for some reason some other conceptual pages are not picked up.

This could be potentially due to either different formatting across the conceptual docs pages causing APIDoctor not to pick up the examples or a bug (or feature? 😅 ) in APIDoctor that makes the other pages get skipped. This would need some investigation to get to the cause.

FaithOmbongi commented 2 years ago

Hi @andrueastman, an investigation will be super helpful to find the root cause and see if we can resolve it through the structure of the conceptual doc. Thanks.

maisarissi commented 2 years ago

Hello everyone.

I created an issue on the APIDoctor repo requesting further investigation based on @andrueastman comment.

FaithOmbongi commented 2 years ago

Hi @maisarissi, any update resolving this issue?

andrueastman commented 1 year ago

Looks like the code was updated to only process snippets in the /api-reference/beta or /api-reference/v1.0 folders of the docs repo.

https://github.com/OneDrive/apidoctor/pull/155 has been authored to resolve.