Skip to content

Conversation

@mathis-m
Copy link
Contributor

Description

Added docs for request snippets plugin

Motivation and Context

Fixes #7502

How Has This Been Tested?

not

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai tim-lai merged commit 87226bc into swagger-api:master Jan 12, 2022
@tim-lai
Copy link
Contributor

tim-lai commented Jan 12, 2022

@mathis-m Thanks for the docs update! PR merged!

@andrei572
Copy link

I can't get this example to work with SwaggerUI 4.14.0. I added the example code to the initializer script in /dist. When I render index.html, the Snippets section isn't displaying. There are no errors in the console. I am able to change other configs through the script, like toggle Try It button and turn on operation IDs, but requestSnippets doesn't seem to be working. Has something changed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create Plugin API Documentation for Request Snippets

4 participants