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

[UI Enhancement] Move authorization card to ApiItem #531

Merged
merged 7 commits into from
Apr 3, 2023
Merged

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Apr 3, 2023

Description

This change moves the Authorization card from the demo/explorer panel over to ApiItem.

A good post-cleanup step would be to cleanup the component naming. For example, we use "security schemes" and "authorization" and "security" interchangeably but perhaps there's a more intuitive/accurate naming we can apply to these componens.

Motivation and Context

The contents of Authorization are align more with reference documentation as opposed to anything demo/explorer specific. In other words, the content is read-only and has no bearing on the final API request that gets sent from browser. Therefore, it makes sense to move it under the reference docs column. The added benefit is that the API demo/explorer panel will be less crowded.

How Has This Been Tested?

See deploy preview

@sserrata sserrata added the v2.0.0 label Apr 3, 2023
@sserrata sserrata added this to the v2.0 UI/UX Refresh milestone Apr 3, 2023
@sserrata sserrata requested a review from blindaa121 April 3, 2023 21:00
@github-actions
Copy link

github-actions bot commented Apr 3, 2023

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

https://docusaurus-openapi-36b86--pr531-4xcdpdxs.web.app

(expires Wed, 03 May 2023 21:11:03 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata changed the title [UI enhancement] Move authorization card to ApiItem [UI Enhancement] Move authorization card to ApiItem Apr 3, 2023
Copy link
Collaborator

@blindaa121 blindaa121 left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks Steven! 🚀

@sserrata sserrata merged commit 03a26d4 into v2.0.0 Apr 3, 2023
14 checks passed
@sserrata sserrata deleted the ui/auth-panel branch April 3, 2023 21:16
@blindaa121 blindaa121 mentioned this pull request Apr 10, 2023
12 tasks
renovate bot added a commit to Unleash/unleash that referenced this pull request May 13, 2023
…-beta.3 (#3765)

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[docusaurus-plugin-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`2.0.0-beta.2` ->
`2.0.0-beta.3`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.2/2.0.0-beta.3)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/compatibility-slim/2.0.0-beta.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/2.0.0-beta.3/confidence-slim/2.0.0-beta.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>PaloAltoNetworks/docusaurus-openapi-docs</summary>

###
[`v2.0.0-beta.3`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/releases/tag/v2.0.0-beta.3)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v2.0.0-beta.2...v2.0.0-beta.3)

#### What's Changed

- \[Bug] Narrow SASS loader rules to avoid conflicts with
docusaurus-plugin-sass by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#519
- \[Bug] Patch webpack sass loader by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#521
- \[Cleanup] Optimize theme typescript build by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#524
- Update bash/curl logo and refactor how logo width/height are defined
by [@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#525
- \[UI Enhancement] Move authorization card to ApiItem by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#531
- \[UI Enhancement] Move CodeTabs above Request by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#533
- \[UI Enhancement] Restyle schema property labels by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#534
- \[UI Enhancement] Add expand button to CodeBlock by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#537
- \[UI Enhancement] Restyle details markers with caret by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#540
- \[UI Enhancement] Response Examples: Updated styling and support for
multiple language variants by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[PaloAltoNetworks/docusaurus-openapi-docs#542
- \[UI Enhancement] Request form validation and updated styling by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[PaloAltoNetworks/docusaurus-openapi-docs#530
- \[UI Enhancement] Enable Expand button for Response by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#553
- Upgrade demo to 2.4.0 and update supported range in plugin and theme
by [@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#554
- \[Bug] Improve support for additional properties, cleanup nested
`<li>`, support SchemaItem children by
[@&#8203;sserrata](https://togithub.com/sserrata) in
[PaloAltoNetworks/docusaurus-openapi-docs#563
- \[UI Enhancement] Updated left doc panel styling by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[PaloAltoNetworks/docusaurus-openapi-docs#557
- \[UI Enhancement] ApiDemoPanel: Expand modal cleanup by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[PaloAltoNetworks/docusaurus-openapi-docs#566
- Prepare release v2.0.0-beta.3 by
[@&#8203;blindaa121](https://togithub.com/blindaa121) in
[PaloAltoNetworks/docusaurus-openapi-docs#570

**Full Changelog**:
PaloAltoNetworks/docusaurus-openapi-docs@v2.0.0-beta.2...v2.0.0-beta.3

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://app.renovatebot.com/dashboard#github/Unleash/unleash).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS43OS4xIiwidXBkYXRlZEluVmVyIjoiMzUuNzkuMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants