isabella232 / microsoft-graph-openapi

OpenAPI v3 description for Microsoft Graph

Microsoft Graph OpenAPI v3.0.1 description (preview)

OpenAPI description for Microsoft Graph

This repo has the OpenAPI representation for the resources and level 1 relationships in Microsoft Graph, for /v1.0 and /beta. Given the size of the Microsoft Graph API, this is not a full representation, but a starting point that works for most interoperability scenarios. At this point in time we can’t make it much bigger without breaking tools or usability. Our plans are to expose the OpenAPI descriptions for Microsoft Graph as part of the service itself, in a similar way that we expose the EDM at https://graph.microsoft.com/v1.0/$metadata endpoint. In the meantime we are making this preview version available in this repo for you to evaluate it and share feedback.

Microsoft Graph

Microsoft Graph is made up of resources connected by relationships. For example, a user can be connected to a group through a memberOf relationship, and to another user through a manager relationship. Your app can traverse these relationships to access these connected resources and perform actions on them through the API. You can also get valuable insights and intelligence about the data from Microsoft Graph. For example, you can get the popular files trending around a user or get the most relevant people around a user. Find more information at Microsoft Graph site.

OpenAPI specification

OpenAPI specification is an API description standard by the OpenAPI initiative. It allows an API to be described in a human and computer readable format. Find more information at OpenAPI Specification GitHub site.

Mapping (OData -> OpenAPI mapping)

The OpenAPI representation for OData based Microsoft Graph has been done with the help of the OpenAPI.Net.OData library. Based on the OASIS conventions defined for converting OData => OpenAPI, we used the openapi.net.odata lib to create the description for MS Graph.

Documentation and resources

Detailed documentation and other learning resources for Microsoft Graph can be found on the Microsoft Graph site.

Contribute

We value your feedback and contribution. Please report any issues at Microsoft Graph OpenAPI issues

TermsOfUse

When you use the Microsoft Graph API, you agree to the Microsoft Graph Terms of Use and the Microsoft Privacy Statement.

Issues

To view or log issues, see issues.

License

Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT license.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.