[Bug] Fix createPostmanCollection method where a copy of openapiData is generated

[johnnyswan]

Description

This PR introduces the following changes:

1. Fix createPostmanCollection method where a copy of openapiData is generated
2. Add groupId to Tabs component for Authentication section in generated *.info.mdx file

Motivation and Context

1. The motivation is to fix the problem when some paths can have their own server object. For example:

openapi: 3.0.3
info:
  title: Burger Example
  version: 1.0.0
  description: Sample description.
servers:
  - url: https://api.example.com/v1
paths:
  /user:
    get:
      servers:
        - url: https://users.example.com/v1
      responses:
        200:
          description: OK
  /flavors:
    get:
      responses:
        200:
          description: OK

The previous realization with Object.assign does not copy nested objects, and the next operation with deleting 'servers' attributes removes them into the parent object too.

2. Fix problem when changing of Authentication method in *.info.mdx file does not save user choice to storage and does not change security scheme all over the documentation

How Has This Been Tested?

Environment: Local

Changes were tested by viewing specific API docs to ensure functionality for API docs were intact and ensuring that the app builds successfully upon each change.

Types of changes

• Bug fix (non-breaking change which fixes an issue)

Checklist

• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes if appropriate.
• All new and existing tests passed.

[welcome-to-palo-alto-networks]

🎉 Thanks for opening this pull request! We really appreciate contributors like you! 🙌

[github-actions]

Visit the preview URL for this PR (updated for commit 57b57b5):

https://docusaurus-openapi-36b86--pr183-tz6wbim6.web.app

_{(expires Wed, 31 Aug 2022 19:44:35 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

[sserrata]

Hi @johnnyswan, thanks for your contribution! The cloneDeep implementation looks good but it looks like we missed an opportunity to "tree shake" the kebabCase import. Can you refactor as follows?

Change this:

import { kebabCase, cloneDeep } from "lodash";

To this:

import { kebabCase } from "lodash/kebabCase";
import { cloneDeep } from "lodash/cloneDeep";

As for the groupId change for the authentication tabs, I was wondering what the expected behavior/use-case should be. Based on the change alone, I would only expect the tab choice to be persisted in localStorage. Is the idea to eventually support reading the tab choice from localStorage and using it somewhere else? I ask because sometimes the authentication tab choices are meant to be used in combination, like when multiple authentication headers are required for example - just something to keep in mind.

[johnnyswan]

I plan to use groupId in SecuritySchemes-like component

[sserrata]

Gotcha - definitely excited to see what you have in mind!

In that case, I think it's best to leave the groupId change out of this PR with the intent to reintroduce it with the new SecuritySchemes-like component.

[sserrata]

Remove groupId from createAuthentication until new SecurityScheme component is introduced. Thanks!

[sserrata]

🚀

[welcome-to-palo-alto-networks]

🎉 Congrats on getting your first pull request merged! We here at Palo Alto Networks are so grateful! ❤️

[TarasMelnyk]

Can you please say when will be the release of this fix? I have the same issue.

[sserrata]

Hi @TarasMelnyk, we should have a new production release out later this week. If you need it sooner, you can always upgrade to a canary release, which auto publishes whenever we merge to main.