Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the documentation links from Links annotations in CSDL to OpenAPI Operations #260

Merged
merged 20 commits into from
Aug 23, 2022

Conversation

millicentachieng
Copy link
Member

@millicentachieng millicentachieng commented Aug 3, 2022

Closes #230

Example:

  /admin/serviceAnnouncement/healthOverviews:
    description: Provides operations to manage the healthOverviews property of the microsoft.graph.serviceAnnouncement entity.
    get:
      tags:
        - admin.serviceAnnouncement.serviceHealth
      summary: Get healthOverviews from admin
      description: 'A collection of service health information for tenant. This property is a contained navigation property, it is nullable and readonly.'
      externalDocs:
        description: Find more info here
        url: https://docs.microsoft.com/graph/api/serviceannouncement-list-healthoverviews?view=graph-rest-1.0
      operationId: admin.serviceAnnouncement.ListHealthOverviews
      parameters:
         #truncated
      responses:
        '200':
          $ref: '#/components/responses/microsoft.graph.serviceHealthCollectionResponse'
        4XX:
          $ref: '#/components/responses/error'
        5XX:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation

@millicentachieng millicentachieng force-pushed the ma/add-documentation-links-annotations branch from 45b16dc to f458088 Compare August 16, 2022 17:30
@millicentachieng millicentachieng marked this pull request as ready for review August 16, 2022 17:39
baywet
baywet previously approved these changes Aug 23, 2022
Copy link
Member

@baywet baywet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for taking in the changes

@millicentachieng millicentachieng merged commit 7439ab5 into master Aug 23, 2022
@millicentachieng millicentachieng deleted the ma/add-documentation-links-annotations branch August 23, 2022 14:49
@millicentachieng millicentachieng self-assigned this Jan 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the documentation links from Links annotations in CSDL to OpenAPI Operations
3 participants