Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Code Issues Projects Releases Wiki Activity
8,068 Commits 485 Branches 871 Tags 360 MiB
c8bce08e94
Commit Graph

995 Commits

Author SHA1 Message Date
Thomas Heartman
94bfb757d6
docs: slight update to environment docs (#3187) 
## What & why

This update does three things:

1. Adjusts the environment cloning feature availability notice: because
this has been released.
2. Updates the availability notice for environments (to conform with the
standard docusaurus way of doing things): for consistency
3. Add a brief explanation of environment types: because this isn't
documented anywhere

## Sources

The note about how environment types work is sourced from this old
[slack thread (internal to the
team)](https://unleash-community.slack.com/archives/G01MU2Q49QC/p1659600175175769)
 2023-02-24 12:48:45 +00:00
Thomas Heartman
898160b295
network-view-docs: rename source file (#3183) 
This PR expands upon the docs in the original PR (and thus supersedes #3139) 

It contains the docs for the recent network view feature.

Closes #2603

---------

Co-authored-by: Gastón Fournier <gaston@getunleash.io>
Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
 2023-02-24 08:36:12 +00:00
Thomas Heartman
08dbf23ee7
docs: mention env var options for auth config (#3169) 
## What

Adds environment variable equivalents for remaining authentication
options.

Also reformats the list silghtly.

## Why

Because the `AUTH_TYPE` and `AUTH_ENABLE_API_TOKEN` variables hadn't
been previously mentioned and we get questions about this from time to
time.

The reformat is primarily for using `monospace font` where appropriate.
 2023-02-22 12:32:27 +01:00
Thomas Heartman
53c82d798f
docs: remove the proxy from the sdks overview table (#3060) 
## What

This change removes the "unleash proxy" column from the SDK compat
table.

## Why

Because the proxy isn't technically an SDK. Having the column there can
be misleading to users.

In the latest case, a user pointed out that the table says the proxy
supports `isEnabled` with fallback values, but that there is no way to
use this via the API (or via client-side sdks) at the moment.

I think we should add a section to the proxy doc about its capabilities
instead.

In fact, I think we should do the same thing with the proxy that we did
with the SDKs: merge the docs.getunleash content with the github readme
and instead source it from there.
 2023-02-22 09:42:47 +00:00
Gastón Fournier
4e3ce8e0af
chore: GA responseTimeWithAppNames (#3178) 
## About the changes
This makes response time with app names enabled for everyone but also
kept a way of turning it off (kill switch) in case it cause some issues
because of misconfigured app names
 2023-02-22 09:10:06 +00:00
Jaanus Sellin
1dba7291ba
feat: maintenance mode docs (#3159) 
feat: maintenance mode docs
 2023-02-20 16:27:28 +02:00
renovate[bot]
e9b669a49a
chore(deps): update react-router monorepo to v6.8.1 (#3137) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router) | [`6.6.2`
-> `6.8.1`](https://renovatebot.com/diffs/npm/react-router/6.6.2/6.8.1)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router/6.8.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router/6.8.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router/6.8.1/compatibility-slim/6.6.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router/6.8.1/confidence-slim/6.6.2)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router) |
[`6.6.2` ->
`6.8.1`](https://renovatebot.com/diffs/npm/react-router-dom/6.6.2/6.8.1)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router-dom/6.8.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router-dom/6.8.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router-dom/6.8.1/compatibility-slim/6.6.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router-dom/6.8.1/confidence-slim/6.6.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.8.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;681)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.8.0...react-router@6.8.1)

##### Patch Changes

- Remove inaccurate console warning for POP navigations and update
active blocker logic
([#&#8203;10030](https://togithub.com/remix-run/react-router/pull/10030))
-   Updated dependencies:
    -   `@remix-run/router@1.3.2`

###
[`v6.8.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;680)

[Compare
Source](74979cb5f8...react-router@6.8.0)

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.3.1`

###
[`v6.7.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;670)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.6.2...74979cb5f84092d83adcf5cda5bf281b3450683c)

##### Minor Changes

- Add `unstable_useBlocker` hook for blocking navigations within the
app's location origin
([#&#8203;9709](https://togithub.com/remix-run/react-router/pull/9709))

##### Patch Changes

- Fix `generatePath` when optional params are present
([#&#8203;9764](https://togithub.com/remix-run/react-router/pull/9764))
- Update `<Await>` to accept `ReactNode` as children function return
result
([#&#8203;9896](https://togithub.com/remix-run/react-router/pull/9896))
-   Updated dependencies:
    -   `@remix-run/router@1.3.0`

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.8.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;681)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.8.0...react-router-dom@6.8.1)

##### Patch Changes

- Improved absolute url detection in `Link` component (now also supports
`mailto:` urls)
([#&#8203;9994](https://togithub.com/remix-run/react-router/pull/9994))
- Fix partial object (search or hash only) pathnames losing current path
value
([#&#8203;10029](https://togithub.com/remix-run/react-router/pull/10029))
-   Updated dependencies:
    -   `react-router@6.8.1`
    -   `@remix-run/router@1.3.2`

###
[`v6.8.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;680)

[Compare
Source](74979cb5f8...react-router-dom@6.8.0)

##### Minor Changes

- Support absolute URLs in `<Link to>`. If the URL is for the current
origin, it will still do a client-side navigation. If the URL is for a
different origin then it will do a fresh document request for the new
origin.
([#&#8203;9900](https://togithub.com/remix-run/react-router/pull/9900))

    ```tsx
<Link to="https://neworigin.com/some/path"> {/* Document request */}
<Link to="//neworigin.com/some/path"> {/* Document request */}
<Link to="https://www.currentorigin.com/path"> {/* Client-side
navigation */}
    ```

##### Patch Changes

- Fix bug with search params removal via `useSearchParams`
([#&#8203;9969](https://togithub.com/remix-run/react-router/pull/9969))
- Respect `preventScrollReset` on `<fetcher.Form>`
([#&#8203;9963](https://togithub.com/remix-run/react-router/pull/9963))
- Fix navigation for hash routers on manual URL changes
([#&#8203;9980](https://togithub.com/remix-run/react-router/pull/9980))
- Use `pagehide` instead of `beforeunload` for `<ScrollRestoration>`.
This has better cross-browser support, specifically on Mobile Safari.
([#&#8203;9945](https://togithub.com/remix-run/react-router/pull/9945))
-   Updated dependencies:
    -   `@remix-run/router@1.3.1`
    -   `react-router@6.8.0`

###
[`v6.7.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;670)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.6.2...74979cb5f84092d83adcf5cda5bf281b3450683c)

##### Minor Changes

- Add `unstable_useBlocker` hook for blocking navigations within the
app's location origin
([#&#8203;9709](https://togithub.com/remix-run/react-router/pull/9709))
- Add `unstable_usePrompt` hook for blocking navigations within the
app's location origin
([#&#8203;9932](https://togithub.com/remix-run/react-router/pull/9932))
- Add `preventScrollReset` prop to `<Form>`
([#&#8203;9886](https://togithub.com/remix-run/react-router/pull/9886))

##### Patch Changes

- Added pass-through event listener options argument to
`useBeforeUnload`
([#&#8203;9709](https://togithub.com/remix-run/react-router/pull/9709))
- Streamline jsdom bug workaround in tests
([#&#8203;9824](https://togithub.com/remix-run/react-router/pull/9824))
-   Updated dependencies:
    -   `@remix-run/router@1.3.0`
    -   `react-router@6.7.0`

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xNDIuMSIsInVwZGF0ZWRJblZlciI6IjM0LjE0My4xIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-02-18 16:04:36 +00:00
Thomas Heartman
0b1d4fbd07
docs: add notes to constraints and segment docs about large values (#3142) 
## What

This PR adds a note to the constraint and the segment docs about using a
large number of constraint values.

## Why

This is a fairly common question in slack, and there is no clear
documentation around this at the moment. As such, it's likely that
people do this a fair bit without telling us. We don't think this is the
right approach, so adding this bit of documentation should hopefully
make it a little clearer.
 2023-02-17 11:06:25 +00:00
Thomas Heartman
415e1b0596
Source proxy and Edge docs from GitHub (#3122) 
## What

The main purpose of this PR is to

1. Delete the proxy docs in this repo and replace them with the proxy's
GitHub readme.
2. Add the docs for Unleash Edge.

### Detailed change description

This PR contains a lot of small changes in a large number of files. To
make it easier to get an overview, here's a detailed description of what
happens where:

#### In the `website/docs`directory

Except for the deletion of the proxy doc, all changes in this directory
are rewriting internal links, so that they point to the newly generated
document instead.

#### `package.json` and `yarn.lock`

When including the documentation for Edge, we also want to render the
mermaid diagrams it uses. Docusaurus supports this via a plugin. All
changes in these files are related to installing that plugin.

#### `docusaurus.config.js`

There's two types of changes in this file:

1. Mermaid-related changes: we ask docusaurus to render mermaid in
markdown files and add the plugin

2. Document generation. There's some rewrites to the sdk doc generation
plus an entirely new section that generates docs for Edge and the proxy

#### `sidebars.js`

Two things:

1. Add the edge docs
2. Move both the Edge and the proxy docs up a level, so that they're
directly under "reference docs" instead of nested inside "unleash
concepts".

#### In the `website/remote-content` directory

These are the remote content files. Previously, all of this lived only
in a `readme-fns.js` file, but with the introduction of Edge and proxy
docs, this has been moved into its own directory and refactored into
three files (`shared`, `sdks`, `edge-proxy`).

#### `custom.css`

Style updates to center mermaid diagrams and provide more space around
them.

#### In `static/img`

The image files that were included in the proxy doc and that have been
deleted.

## Why

For two reasons:

1. Reduce duplication for the proxy. Have one source of truth.
2. Add docs for edge.

## Discussion points and review wishes

This is a big PR, and I don't expect anyone to do a line-by-line review
of it, nor do I think that is particularly useful. Instead, I'd like to
ask reviewers to:

1. Visit the [documentation
preview](https://unleash-docs-git-docs-source-proxy-gh-unleash-team.vercel.app/reference/unleash-proxy)
and have a look at both the proxy docs and the Edge docs. Potentially
have a look at the SDK docs too to verify that everything still works.

2. Consider whether they think moving the proxy and edge docs up a level
(in the sidebar) makes sense.

3. Let me know what slug they'd prefer for the Edge docs. I've gone with
`unleash-edge` for now (so that it's
`docs.getunleash.io/reference/unleash-edge`), but we could potentially
also just use `edge`. WDYT?

4. Read through the detailed changes section.

5. Let me know if they have any other concerns or questions.

## Screenies

The new proxy doc:


![image](https://user-images.githubusercontent.com/17786332/219043145-1c75c83e-4191-45a3-acb5-775d05d13862.png)

The new edge doc:


![image](https://user-images.githubusercontent.com/17786332/219043220-1f5daf13-972e-4d56-8aaf-70ff1812863e.png)
 2023-02-16 13:36:28 +01:00
renovate[bot]
5420e3c965
fix(deps): update dependency unleash-proxy-client to v2.4.2 (#3099) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[unleash-proxy-client](https://togithub.com/unleash/unleash-proxy-client-js)
| [`2.4.0` ->
`2.4.2`](https://renovatebot.com/diffs/npm/unleash-proxy-client/2.4.0/2.4.2)
|
[![age](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.2/compatibility-slim/2.4.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.2/confidence-slim/2.4.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>unleash/unleash-proxy-client-js</summary>

###
[`v2.4.2`](https://togithub.com/Unleash/unleash-proxy-client-js/releases/tag/v2.4.2)

[Compare
Source](https://togithub.com/unleash/unleash-proxy-client-js/compare/v2.4.1...v2.4.2)

-
[`35f79bd`](35f79bdec7)
- fix: update context can be awaited before start
([#&#8203;137](https://togithub.com/unleash/unleash-proxy-client-js/issues/137))
-
[`56529ac`](56529ac23d)
- version bump
([#&#8203;138](https://togithub.com/unleash/unleash-proxy-client-js/issues/138))
-
[`8a3bc72`](8a3bc72058)
- fix: package lock version
([#&#8203;140](https://togithub.com/unleash/unleash-proxy-client-js/issues/140))

###
[`v2.4.1`](https://togithub.com/Unleash/unleash-proxy-client-js/releases/tag/v2.4.1)

[Compare
Source](https://togithub.com/unleash/unleash-proxy-client-js/compare/v2.4.0...v2.4.1)

-
[`0ca4603`](0ca4603fa9)
- Update context waits for start
([#&#8203;130](https://togithub.com/unleash/unleash-proxy-client-js/issues/130))
-
[`d5f0c74`](d5f0c74352)
- fix: count variant metrics based on enabled state
([#&#8203;131](https://togithub.com/unleash/unleash-proxy-client-js/issues/131))
-
[`2fd7282`](2fd7282ef9)
- fix: nodejs support by default
([#&#8203;134](https://togithub.com/unleash/unleash-proxy-client-js/issues/134))
-
[`c3554dd`](c3554dd3f8)
- 2.4.1
([#&#8203;135](https://togithub.com/unleash/unleash-proxy-client-js/issues/135))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-02-14 16:52:29 +00:00
renovate[bot]
5c5269d618
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.5.2 (#3098) 
[![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-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`1.5.1` ->
`1.5.2`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/1.5.1/1.5.2)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.2/compatibility-slim/1.5.1)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.2/confidence-slim/1.5.1)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.5.2`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;152-Feb-2-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.5.1...v1.5.2)

High level enhancements

-   Improved support for rendering items/arrays
- Fixed issue that prevented some schemas from fully-rendering
([#&#8203;397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397))
-   Added support for `nullable`

Other enhancements and bug fixes

- Cleanup API doc demos
([#&#8203;400](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/400))
- \[Bug] Support multiple same-level node types and improve items/array
support
([#&#8203;397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397))
- Bump ua-parser-js from 0.7.32 to 0.7.33
([#&#8203;395](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/395))
- Add support for nullable
([#&#8203;393](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/393))
- Bump cookiejar from 2.1.3 to 2.1.4
([#&#8203;390](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/390))
- Update intro/README
([#&#8203;384](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/384))
- Update a link in the credits
([#&#8203;382](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/382))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-02-14 05:35:55 +00:00
renovate[bot]
8cd779a57b
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.2 (#3095) 
[![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)
| [`1.5.1` ->
`1.5.2`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/1.5.1/1.5.2)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.2/compatibility-slim/1.5.1)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.2/confidence-slim/1.5.1)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.5.2`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;152-Feb-2-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.5.1...v1.5.2)

High level enhancements

-   Improved support for rendering items/arrays
- Fixed issue that prevented some schemas from fully-rendering
([#&#8203;397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397))
-   Added support for `nullable`

Other enhancements and bug fixes

- Cleanup API doc demos
([#&#8203;400](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/400))
- \[Bug] Support multiple same-level node types and improve items/array
support
([#&#8203;397](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/397))
- Bump ua-parser-js from 0.7.32 to 0.7.33
([#&#8203;395](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/395))
- Add support for nullable
([#&#8203;393](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/393))
- Bump cookiejar from 2.1.3 to 2.1.4
([#&#8203;390](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/390))
- Update intro/README
([#&#8203;384](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/384))
- Update a link in the credits
([#&#8203;382](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/382))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-02-14 02:01:25 +00:00
renovate[bot]
0acfbfe52f
chore(deps): update storybook monorepo to v6.5.16 (#3093) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[@storybook/addon-actions](https://togithub.com/storybookjs/storybook/tree/main/addons/actions)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-actions/6.5.15/6.5.16)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.16/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.16/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.16/compatibility-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.16/confidence-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-essentials](https://togithub.com/storybookjs/storybook/tree/main/addons/essentials)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-essentials/6.5.15/6.5.16)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.16/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.16/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.16/compatibility-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.16/confidence-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-interactions](https://togithub.com/storybookjs/storybook/tree/main/addons/interactions)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-interactions/6.5.15/6.5.16)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.16/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.16/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.16/compatibility-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.16/confidence-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-links](https://togithub.com/storybookjs/storybook/tree/main/addons/links)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2faddon-links/6.5.15/6.5.16)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.16/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.16/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.16/compatibility-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.16/confidence-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/react](https://togithub.com/storybookjs/storybook/tree/main/app/react)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.15` ->
`6.5.16`](https://renovatebot.com/diffs/npm/@storybook%2freact/6.5.15/6.5.16)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.16/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.16/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.16/compatibility-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.16/confidence-slim/6.5.15)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>storybookjs/storybook</summary>

###
[`v6.5.16`](https://togithub.com/storybookjs/storybook/releases/tag/v6.5.16)

[Compare
Source](https://togithub.com/storybookjs/storybook/compare/v6.5.15...v6.5.16)

##### Bug Fixes

- Angular: Fix handling of docsMode option in angular builder
[#&#8203;20608](https://togithub.com/storybooks/storybook/pull/20608)
- Angular: Fix webpackStatsJson types in angular-builder
[#&#8203;20296](https://togithub.com/storybooks/storybook/pull/20296)

##### Dependency Upgrades

- Security: Upgrade json5 dependency
[#&#8203;20526](https://togithub.com/storybooks/storybook/pull/20526)

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzMuMCIsInVwZGF0ZWRJblZlciI6IjM0LjEzMy4wIn0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-02-13 12:23:59 +00:00
Thomas Heartman
eb843c21a1
docs: add image to anatomy about variants per environment (#3080) 
## What

This PR updates the anatomy of unleash document with a figure explaining
how variants can be different across environments now.
 2023-02-10 15:31:11 +01:00
dependabot[bot]
465e98564f
chore(deps): bump http-cache-semantics from 4.1.0 to 4.1.1 in /website (#3044) 
Bumps
[http-cache-semantics](https://github.com/kornelski/http-cache-semantics)
from 4.1.0 to 4.1.1.
<details>
<summary>Commits</summary>
<ul>
<li><a
href="2449650435"><code>2449650</code></a>
Update mocha</li>
<li><a
href="560b2d8ef4"><code>560b2d8</code></a>
Don't use regex to trim whitespace</li>
<li><a
href="b1bdb92638"><code>b1bdb92</code></a>
Remove linting package zoo</li>
<li><a
href="c20dc7eeca"><code>c20dc7e</code></a>
Cache 308</li>
<li>See full diff in <a
href="https://github.com/kornelski/http-cache-semantics/compare/v4.1.0...v4.1.1">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=http-cache-semantics&package-manager=npm_and_yarn&previous-version=4.1.0&new-version=4.1.1)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the
default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as
the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as
the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the
default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/Unleash/unleash/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2023-02-10 11:35:52 +01:00
Gastón Fournier
354b5b2976
chore: service accounts GA (#3059) 
## About the changes
This PR prepares the GA of service accounts: OpenAPI tags, documentation
and flag removal

Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#2942

---------

Co-authored-by: Nuno Góis <github@nunogois.com>
 2023-02-08 11:59:24 +01:00
Sebastian Bury
a9b6c3c53f
Update proxy-hosting.mdx 2023-02-06 17:08:01 +01:00
Yao Sun
94947acac7
Update overview.md, fix typo (#3039) 2023-02-03 16:04:11 +01:00
Thomas Heartman
0a6f9f647b
docs: update Anatomy doc with variants per environment notice (#3046) 
## What

This change updates the "variants" section of the Anatomy of Unleash
document with more information about how variants work with multiple
environments.

At the moment, it states that variants per env are GA from 4.21, but
that might need to be changed.

## Why

With the upcoming release of variants per environment, the doc should
reflect the current state of things. However, it should also still
contain info for those not yet on v4.21
 2023-02-03 12:01:10 +01:00
Thomas Heartman
a7cb20c42b
docs: update old docker compose instructions (#3043) 
## What

This change updates the docker compose instructions to match what is
currently in the Unleash/unleash repo itself.

## Why

Because the old version was out of date.
 2023-02-03 09:39:14 +00:00
dependabot[bot]
cb9414a3f2
chore(deps): bump ua-parser-js from 0.7.32 to 0.7.33 in /website (#2999) 
Bumps [ua-parser-js](https://github.com/faisalman/ua-parser-js) from
0.7.32 to 0.7.33.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/faisalman/ua-parser-js/blob/master/changelog.md">ua-parser-js's
changelog</a>.</em></p>
<blockquote>
<h2>Version 0.7.32 / 1.0.32</h2>
<ul>
<li>Add new browser : DuckDuckGo, Huawei Browser, LinkedIn</li>
<li>Add new OS : HarmonyOS</li>
<li>Add some Huawei models</li>
<li>Add Sharp Aquos TV</li>
<li>Improve detection Xiaomi Mi CC9</li>
<li>Fix Sony Xperia 1 III misidentified as Acer tablet</li>
<li>Fix Detect Sony BRAVIA as SmartTV</li>
<li>Fix Detect Xiaomi Mi TV as SmartTV</li>
<li>Fix Detect Galaxy Tab S8 as tablet</li>
<li>Fix WeGame mistakenly identified as WeChat</li>
<li>Fix included commas in Safari / Mobile Safari version</li>
<li>Increase UA_MAX_LENGTH to 350</li>
</ul>
<h2>Version 0.7.33 / 1.0.33</h2>
<ul>
<li>Add new browser : Cobalt</li>
<li>Identify Macintosh as an Apple device</li>
<li>Fix ReDoS vulnerability</li>
</ul>
<h1>Version 0.8</h1>
<p>Version 0.8 was created by accident. This version is now deprecated
and no longer maintained, please update to version 0.7 / 1.0.</p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="f2d0db001d"><code>f2d0db0</code></a>
Bump version 0.7.33</li>
<li><a
href="a6140a17dd"><code>a6140a1</code></a>
Remove unsafe regex in trim() function</li>
<li><a
href="a886604935"><code>a886604</code></a>
Fix <a
href="https://github-redirect.dependabot.com/faisalman/ua-parser-js/issues/605">#605</a>
- Identify Macintosh as Apple device</li>
<li><a
href="b814bcd791"><code>b814bcd</code></a>
Merge pull request <a
href="https://github-redirect.dependabot.com/faisalman/ua-parser-js/issues/606">#606</a>
from rileyjshaw/patch-1</li>
<li><a
href="7f71024161"><code>7f71024</code></a>
Fix documentation</li>
<li><a
href="c239ac5167"><code>c239ac5</code></a>
Merge pull request <a
href="https://github-redirect.dependabot.com/faisalman/ua-parser-js/issues/604">#604</a>
from obecerra3/master</li>
<li><a
href="8d3c2d327c"><code>8d3c2d3</code></a>
Add new browser: Cobalt</li>
<li>See full diff in <a
href="https://github.com/faisalman/ua-parser-js/compare/0.7.32...0.7.33">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=ua-parser-js&package-manager=npm_and_yarn&previous-version=0.7.32&new-version=0.7.33)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the
default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as
the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as
the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the
default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/Unleash/unleash/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2023-01-27 20:09:16 +01:00
Thomas Heartman
f1984080a9
docs: add next.js docs (#3002) 
## What

This change adds the next.js sdk's readme to the client-side SDKs
section in the docs.

## Why

Because we have a new and official SDK 🙌🏼
 2023-01-27 07:33:19 +00:00
Thomas Heartman
247f751fea
docs: generate client-side SDK docs from readme (#2949) 
## What

Delete static client-side SDK docs in favor of generating them at
build time.

- Add a separate list of `clientSideSdks` to `readme-fns`.
- Use sdk type to determine which generation directory it goes into
- Replace manual sidebar category with autogenerated one

## Why

This does the same for client-side SDKs as was done for server-side
SDKs in https://github.com/Unleash/unleash/pull/2858

(Supersedes #2859)
 2023-01-25 14:36:50 +01:00
Thomas Heartman
502a0759a5
Docs: fix typo in front-end api url 
Seems my autocorrect was a bit overzealous.
 2023-01-25 13:30:43 +01:00
Thomas Heartman
99f45b4248
docs: Add front-end API setup to the quickstart guide (#2984) 
## What

This change adds instructions on how to use the front-end API for
client-side SDKs to the quickstart guide. It also organizes the content
so that this info is presented before the proxy info.

## Why

The front-end API is easier to use, so it should be preferred over the
proxy for people who are just getting started.
 2023-01-25 12:11:23 +00:00
dependabot[bot]
6b22e2eb61
chore(deps): bump cookiejar from 2.1.3 to 2.1.4 in /website (#2977) 
[//]: # (dependabot-start)
⚠️  **Dependabot is rebasing this PR** ⚠️ 

Rebasing might not happen immediately, so don't worry if this takes some
time.

Note: if you make any changes to this PR yourself, they will take
precedence over the rebase.

---

[//]: # (dependabot-end)

Bumps [cookiejar](https://github.com/bmeck/node-cookiejar) from 2.1.3 to
2.1.4.
<details>
<summary>Commits</summary>
<ul>
<li>See full diff in <a
href="https://github.com/bmeck/node-cookiejar/commits">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=cookiejar&package-manager=npm_and_yarn&previous-version=2.1.3&new-version=2.1.4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the
default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as
the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as
the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the
default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/Unleash/unleash/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2023-01-24 14:24:12 +01:00
Thomas Heartman
a8a910a39f
docs: don't tell users to contact support for proxy hosting (#2933) 
## What

This change removes a notice from the proxy documentation saying that
users should reach out to support@getunleash.io if they want the Unleash
team to host it.

## Why

Unleash ships with the front-end API now, so we don't want people
reaching out to support for this anymore.
 2023-01-20 14:26:58 +01:00
renovate[bot]
a6c76155e0
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.5.1 (#2934) 
[![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-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`1.5.0` ->
`1.5.1`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/1.5.0/1.5.1)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.1/compatibility-slim/1.5.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.1/confidence-slim/1.5.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.5.1`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;151-Jan-10-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.5.0...v1.5.1)

High level enhancements

-   Added support for x-webhooks extension
-   Improvements to how Swagger 2.0 is upconverted to OpenAPI 3.0

Other enhancements and bug fixes

- \[Bug] Refactor selective sanitization of > and < symbols in generated
markdown descriptions
([#&#8203;377](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/377))
- fix jsonSchemaMergeAllOf options in createRequestSchema
([#&#8203;374](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/374))
- Add resolveInternal to swagger2openapi options
([#&#8203;375](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/375))
- \[Enhancement] Introduce support for webhooks extension
([#&#8203;370](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/370))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDUuNCIsInVwZGF0ZWRJblZlciI6IjM0LjEwNS40In0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-01-19 21:24:28 +00:00
renovate[bot]
c6d62afd35
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.1 (#2930) 
[![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)
| [`1.5.0` ->
`1.5.1`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/1.5.0/1.5.1)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.1/compatibility-slim/1.5.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.1/confidence-slim/1.5.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.5.1`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;151-Jan-10-2023)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.5.0...v1.5.1)

High level enhancements

-   Added support for x-webhooks extension
-   Improvements to how Swagger 2.0 is upconverted to OpenAPI 3.0

Other enhancements and bug fixes

- \[Bug] Refactor selective sanitization of > and < symbols in generated
markdown descriptions
([#&#8203;377](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/377))
- fix jsonSchemaMergeAllOf options in createRequestSchema
([#&#8203;374](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/374))
- Add resolveInternal to swagger2openapi options
([#&#8203;375](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/375))
- \[Enhancement] Introduce support for webhooks extension
([#&#8203;370](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/370))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDUuNCIsInVwZGF0ZWRJblZlciI6IjM0LjEwNS40In0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-01-19 10:33:30 +00:00
Thomas Heartman
6b458fedbb
docs: add link to the Unleash help center (#2926) 
## What

This change adds a link to the Unleash help center in the list of links.

## Why

To make it easier to get help for customers who require it.

## Notes

Signed off by Diego (@dsusa72) and Elise (@EliseBrevald).
 2023-01-18 13:59:43 +01:00
Thomas Heartman
801e31dc4e
docs: update footer links (#2904) 
## What

This PR:

-   adds a footer link to GitHub discussions
-   updates the link to the public roadmap

## Why

Because we want more people to use discussions as a resource and because
the old roadmap link leads to a deprecated roadmap.
 2023-01-17 13:26:59 +01:00
Thomas Heartman
6d28cd959e
docs: add change requests video (#2909) 
This change adds the change requests explainer video to the change
requests reference documentation.

As a bonus, it also cleans up some redundant whitespace.
 2023-01-17 12:15:59 +01:00
renovate[bot]
c29ff77b50
chore(deps): update react-router monorepo to v6.6.2 (#2907) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router) | [`6.6.1`
-> `6.6.2`](https://renovatebot.com/diffs/npm/react-router/6.6.1/6.6.2)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router/6.6.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router/6.6.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router/6.6.2/compatibility-slim/6.6.1)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router/6.6.2/confidence-slim/6.6.1)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router) |
[`6.6.1` ->
`6.6.2`](https://renovatebot.com/diffs/npm/react-router-dom/6.6.1/6.6.2)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.2/compatibility-slim/6.6.1)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.2/confidence-slim/6.6.1)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.6.2`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;662)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.6.1...react-router@6.6.2)

##### Patch Changes

- Ensure `useId` consistency during SSR
([#&#8203;9805](https://togithub.com/remix-run/react-router/pull/9805))

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.6.2`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;662)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.6.1...react-router-dom@6.6.2)

##### Patch Changes

- Ensure `useId` consistency during SSR
([#&#8203;9805](https://togithub.com/remix-run/react-router/pull/9805))
-   Updated dependencies:
    -   `react-router@6.6.2`

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMDIuNyIsInVwZGF0ZWRJblZlciI6IjM0LjEwMi43In0=-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-01-16 22:15:37 +00:00
Thomas Heartman
14e052b9ac
docs: auto-generate remaining server-side SDK docs (#2858) 
This PR builds on the preceding doc auto-generation PRs and generates
documentation for the remaining server-side SDKs.

## Why

Refer to https://github.com/Unleash/unleash/pull/2809 for more context
about generating SDK docs.

## What

-   Adds generation for the remaining server-side SDKs
- Moves generated docs from the `/reference/sdks` directory to
`/generated` directory.
- Makes sure that the URLs do not change because of the move by using
the `slug` frontmatter property.
- replaces relative github links in the markdown documents so that they
become absolute github links. (refer to the next section)
- Updates some image styling so that it doesn't apply to readme badges
(we don't need them using `display: block`)

### On link replacing:

This PR adds handling of links in the generated documentation.
Specifically, it changes links in one case:

Relative links to github. Links to code and other files in the
repository. These are prefixed with the repository's URL.

While this should work in most cases, it will fail in cases where the
links to the files are not on the repository's primary branch.
(typically main, but could also be "v3", for instance). In these cases,
the links will get a double branch in the URL and will fail. However, I
see no easy way around this (though suggestions are definitely
accepted!), and think it's a fair tradeoff. It takes the links from
"definitely failing" to "will work in the vast majority of cases".

Note: I originally also wanted to handle the case where the link is an
absolute link to docs.getunleash.io. We could turn these into relative
urls to avoid full page reloads and enjoy a smoother experience.
However, the client-side redirects don't work correctly if the relative
URL goes to a redirect page, so you end up with a 404 page. As such, I
think it's better to leave the links as absolute for now.
 2023-01-13 12:40:28 +01:00
Nuno Góis
1faae5757e
docs: service accounts (#2881) 
https://linear.app/unleash/issue/2-545/documentation-service-accounts

-
[reference/service-accounts](https://unleash-docs-git-docs-service-accounts-unleash-team.vercel.app/reference/service-accounts)
-
[how-to/how-to-create-service-accounts](https://unleash-docs-git-docs-service-accounts-unleash-team.vercel.app/how-to/how-to-create-service-accounts)

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2023-01-13 09:46:50 +00:00
JarrodSC
2d3905407e
docs: Update change-requests.md (#2872) 
With the release of 4.19, the info box at the top was outdated. It's been updated to reflect the current situation. References to 4.18 in the body have also been updated.


Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2023-01-13 09:12:33 +00:00
dependabot[bot]
1a894eb3a0
chore(deps): bump json5 from 1.0.1 to 1.0.2 in /website (#2815) 
Bumps [json5](https://github.com/json5/json5) from 1.0.1 to 1.0.2.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/json5/json5/releases">json5's
releases</a>.</em></p>
<blockquote>
<h2>v1.0.2</h2>
<ul>
<li>Fix: Properties with the name <code>__proto__</code> are added to
objects and arrays. (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/199">#199</a>)
This also fixes a prototype pollution vulnerability reported by Jonathan
Gregson! (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/295">#295</a>).
This has been backported to v1. (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/298">#298</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/json5/json5/blob/main/CHANGELOG.md">json5's
changelog</a>.</em></p>
<blockquote>
<h3>Unreleased [<a
href="https://github.com/json5/json5/tree/main">code</a>, <a
href="https://github.com/json5/json5/compare/v2.2.3...HEAD">diff</a>]</h3>
<h3>v2.2.3 [<a
href="https://github.com/json5/json5/tree/v2.2.3">code</a>, <a
href="https://github.com/json5/json5/compare/v2.2.2...v2.2.3">diff</a>]</h3>
<ul>
<li>Fix: json5@2.2.3 is now the 'latest' release according to npm
instead of
v1.0.2. (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/299">#299</a>)</li>
</ul>
<h3>v2.2.2 [<a
href="https://github.com/json5/json5/tree/v2.2.2">code</a>, <a
href="https://github.com/json5/json5/compare/v2.2.1...v2.2.2">diff</a>]</h3>
<ul>
<li>Fix: Properties with the name <code>__proto__</code> are added to
objects and arrays.
(<a
href="https://github-redirect.dependabot.com/json5/json5/issues/199">#199</a>)
This also fixes a prototype pollution vulnerability reported by
Jonathan Gregson! (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/295">#295</a>).</li>
</ul>
<h3>v2.2.1 [<a
href="https://github.com/json5/json5/tree/v2.2.1">code</a>, <a
href="https://github.com/json5/json5/compare/v2.2.0...v2.2.1">diff</a>]</h3>
<ul>
<li>Fix: Removed dependence on minimist to patch CVE-2021-44906. (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/266">#266</a>)</li>
</ul>
<h3>v2.2.0 [<a
href="https://github.com/json5/json5/tree/v2.2.0">code</a>, <a
href="https://github.com/json5/json5/compare/v2.1.3...v2.2.0">diff</a>]</h3>
<ul>
<li>New: Accurate and documented TypeScript declarations are now
included. There
is no need to install <code>@types/json5</code>. (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/236">#236</a>,
<a
href="https://github-redirect.dependabot.com/json5/json5/issues/244">#244</a>)</li>
</ul>
<h3>v2.1.3 [<a
href="https://github.com/json5/json5/tree/v2.1.3">code</a>, <a
href="https://github.com/json5/json5/compare/v2.1.2...v2.1.3">diff</a>]</h3>
<ul>
<li>Fix: An out of memory bug when parsing numbers has been fixed. (<a
href="https://github-redirect.dependabot.com/json5/json5/issues/228">#228</a>,
<a
href="https://github-redirect.dependabot.com/json5/json5/issues/229">#229</a>)</li>
</ul>
<h3>v2.1.2 [<a
href="https://github.com/json5/json5/tree/v2.1.2">code</a>, <a
href="https://github.com/json5/json5/compare/v2.1.1...v2.1.2">diff</a>]</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="a62db1e51e"><code>a62db1e</code></a>
1.0.2</li>
<li><a
href="e0c23fe458"><code>e0c23fe</code></a>
docs: update CHANGELOG for v1.0.2</li>
<li><a
href="62a6540840"><code>62a6540</code></a>
fix: add <strong>proto</strong> to objects and arrays</li>
<li>See full diff in <a
href="https://github.com/json5/json5/compare/v1.0.1...v1.0.2">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=json5&package-manager=npm_and_yarn&previous-version=1.0.1&new-version=1.0.2)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
- `@dependabot use these labels` will set the current labels as the
default for future PRs for this repo and language
- `@dependabot use these reviewers` will set the current reviewers as
the default for future PRs for this repo and language
- `@dependabot use these assignees` will set the current assignees as
the default for future PRs for this repo and language
- `@dependabot use this milestone` will set the current milestone as the
default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/Unleash/unleash/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2023-01-11 14:31:30 +01:00
Thomas Heartman
89c6c09db3
docs: add /docs redirects to _all_ redirect paths (#2839) 
## What

For each defined doc redirect path (that doesn't start with `/docs/`),
this PR adds an additional redirect that starts with `/docs`. The rest
of the path is otherwise identical.

For instance, if we have a redirect that goes from `/user_guide/x`, then
this change will ensure that we also have redirect that goes from
`/docs/user_guide/x`.

## Why

As reported by Roman, we've had some 404s recently when people have
tried to access pages that used to exist (wayyyy back) and that used to
redirect.

The reason these redirects stopped working is that we changed the url
structure recently. Before then, the `createRedirects` function would go
and create redirects that started with `/docs/` for all the paths that
required it. However, now that we've changed the structure of the URLs,
a blanket implementation like that won't work anymore.

Luckily, though, we already have all the redirects for pages we have
moved (just not redirecting from the `/docs/...` paths), so we can map
over the paths and add the missing redirects.
 2023-01-05 21:47:04 +01:00
Thomas Heartman
5fa73b929a
Docs(fix): fix broken link to sdk-generator ADR (#2838) 2023-01-05 14:50:47 +00:00
Tymoteusz Czech
36f849e9e9
docs: Orval ADR (#2818) 
https://linear.app/unleash/issue/1-537/openapi-generator-adr
 2023-01-05 10:24:41 +00:00
Thomas Heartman
7cff6336c1
docs: Use Go readme (#2816) 
# PR 1: add remote content plugin and rust readme

## What

This PR does a few connected things:

1. It adds the ["docusaurus-plugin-remote-content" package](https://github.com/rdilweb/docusaurus-plugin-remote-content).

2. It adds configuration to make it work with Readmes found on GitHub.

3. It adds the Rust SDK's readme (replacing the link we used to have) as a proof of concept on how to do it.

## Why

With documentation split between GitHub readmes and the official docs, it's hard to keep everything up to date and in sync. It's also quite confusing that some information is only available in some places, but not in others. 

We've talked about auto-including readmes from GitHub for a while, so here's a proof of concept (finally) 🥳 

The intention is to get this merged and then to migrate the other SDK docs one by one, ensuring that everything in the documentation is also in the readme (so that no info is lost). 

## Discussion points

### Generation directory

The current generation method generates the files into `/reference/sdks/<sdk name>`. I think this works for now, but it means it adds auto-generated files into a directory that you can't ignore (at least not yet). 

We could instead generate them into `/generated/sdks` and update the slugs so that they still match the expected pattern. 

However, this would make the sidebar a little harder to work with (for now). That said, there may be ways around it. It's worth exploring.

### Generation method

By default, this plugin will generate files whenever you build. That (probably) means that you need an internet connection _and_ that you'll end up with a bunch of untracked files.

An option is to only generate the files "manually" and commit them to the repo. That would allow you to build the project without an internet connection and would also remove the need for ignoring the files. We could automate the generation if we wanted to. 

## Preview / Screenies

Visit [/reference/sdks/rust](https://unleash-docs-git-docs-include-sdk-readmes-unleash-team.vercel.app/reference/sdks/rust) in the preview to see what it looks like live. 

![image](https://user-images.githubusercontent.com/17786332/210373446-784b7e69-0f36-4e9e-874a-2b06b863b603.png)

# PR 2: add go readme

This PR changes the docs generation to use the Go SDK's GitHub readme
for the SDK docs instead of a separate document.

## What

The changes in this PR are:

- Delete the existing Go SDK documentation. All the content in this
guide already exists in the Go readme.
-   Add the Go SDK to the list of auto-generated readme docs
- Move the readme-related code into a separate module, `readme-fns.js`
(I'm not bullish about the file name: we can change it if you have
suggestions)
- Add a note to the top of all generated readmes saying you'll need an
API url and an API token. The note also links you to the relevant
reference and how-to docs.

## Why

Having two different bits of documentation for the same SDK is
troublesome. By only having the data in one place, we can avoid it going
out of sync and getting stale.
 2023-01-05 09:47:49 +00:00
renovate[bot]
878560e2f1
chore(deps): update dependency babel-loader to v9.1.2 (#2826) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [babel-loader](https://togithub.com/babel/babel-loader) | [`9.1.0` ->
`9.1.2`](https://renovatebot.com/diffs/npm/babel-loader/9.1.0/9.1.2) |
[![age](https://badges.renovateapi.com/packages/npm/babel-loader/9.1.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/babel-loader/9.1.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/babel-loader/9.1.2/compatibility-slim/9.1.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/babel-loader/9.1.2/confidence-slim/9.1.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel-loader</summary>

###
[`v9.1.2`](https://togithub.com/babel/babel-loader/releases/tag/v9.1.2)

[Compare
Source](https://togithub.com/babel/babel-loader/compare/v9.1.1...v9.1.2)

9.1.1 was a broken release, it didn't include all the commits.

#### Dependencies updates

- Bump qs from 6.5.2 to 6.5.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/babel/babel-loader/pull/977](https://togithub.com/babel/babel-loader/pull/977)
- Bump json5 from 2.2.1 to 2.2.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/babel/babel-loader/pull/980](https://togithub.com/babel/babel-loader/pull/980)

#### Misc

- GitHub Workflows security hardening by
[@&#8203;sashashura](https://togithub.com/sashashura) in
[https://github.com/babel/babel-loader/pull/976](https://togithub.com/babel/babel-loader/pull/976)

#### New Contributors

- [@&#8203;sashashura](https://togithub.com/sashashura) made their first
contribution in
[https://github.com/babel/babel-loader/pull/976](https://togithub.com/babel/babel-loader/pull/976)

**Full Changelog**:
https://github.com/babel/babel-loader/compare/v9.1.0...v9.1.2

###
[`v9.1.1`](https://togithub.com/babel/babel-loader/compare/v9.1.0...v9.1.1)

[Compare
Source](https://togithub.com/babel/babel-loader/compare/v9.1.0...v9.1.1)

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC44MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuODEuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-01-05 01:53:41 +00:00
renovate[bot]
157b54d420
chore(deps): update dependency @babel/core to v7.20.12 (#2825) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@babel/core](https://babel.dev/docs/en/next/babel-core)
([source](https://togithub.com/babel/babel)) | [`7.20.7` ->
`7.20.12`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.20.7/7.20.12)
|
[![age](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.12/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.12/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.12/compatibility-slim/7.20.7)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.12/confidence-slim/7.20.7)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel</summary>

###
[`v7.20.12`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v72012-2023-01-04)

[Compare
Source](https://togithub.com/babel/babel/compare/v7.20.7...v7.20.12)

##### 🐛 Bug Fix

-   `babel-traverse`
- [#&#8203;15224](https://togithub.com/babel/babel/pull/15224) Fix
`TaggedTemplateLiteral` evaluation
([@&#8203;nmn](https://togithub.com/nmn))
- `babel-helper-create-class-features-plugin`,
`babel-plugin-proposal-class-properties`
- [#&#8203;15312](https://togithub.com/babel/babel/pull/15312) fix:
`delete this` in static class properties initialization
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))

##### 💅 Polish

-   `babel-traverse`
- [#&#8203;15313](https://togithub.com/babel/babel/pull/15313) Implement
support for evaluating computed properties.
([@&#8203;JBYoshi](https://togithub.com/JBYoshi))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC44MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuODEuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2023-01-04 22:44:01 +00:00
Ivar Conradi Østhus
3a8107ce6e
fix: state-service should always keep api keys (#2552) 
We have experienced side-effects where the import was unexpected and
resulted in environments thought to be removed. This had the unexpected
side-effect of also deleting API keys for some environments not part of
the import file.

This commit removes the ability of the state-service to mutate api keys
directly. There is no compelling reasons why we should remove API keys
as part of an import query.

Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2023-01-04 11:24:34 +00:00
Mateusz Kwasniewski
cc1512cd44
refactor: styled component in header (#2808) 2023-01-03 14:52:10 +01:00
Thomas Heartman
c2a3872386
Fix(typo): Fix "login"/"log in", "logout"/"log out" issues (#2807) 
## What

This change updates some places in the docs where we use the terms
"login" and "logout" incorrectly.

A "login" is a noun, typically referring to the set of credentials you
need to _log in_ to a service. The verb form, the act of signing in, is
written in two words: to "log in".

A similar logic applies to "logout" and "log out", although I don't find
the term "logout" in my dictionary. However, I think it makes sense to
talk about "logout requests" (and I see references to logout in other
services and documentation), so I'm happy to use that as a noun.
Regardless, the act of logging out is to "log out".
 2023-01-03 13:40:03 +01:00
Thomas Heartman
01b05fb0d6
docs: fix android admonition formatting (#2800) 
This change fixes a formatting issue which causes the entire document to
be rendered inside of the admonition.
 2023-01-03 13:14:45 +01:00
Mateusz Kwasniewski
82a4191e1d
added flutter documentation (#2736) 2023-01-03 13:07:01 +01:00
Thomas Heartman
6b5e25b191
Docs(fix): broken links (#2797) 
This change fixes some broken links in the "about the docs" document.
Most of these links go to concrete documents and have been replaced with
their appropriate relative file links. The few links that go to
auto-generated pages have been corrected.

Unfortunately, there does not seem to be an easy way to link safely to
generated pages.
 2023-01-03 11:27:45 +01:00
Thomas Heartman
d2245583ec
Docs: add missing words "connect to" 2023-01-03 11:27:06 +01:00
Thomas Heartman
983d3a9513
docs: clarify node sdk instructions wrt envs and tokens (#2799) 
## What

This change does two things:

It **removes the `environment` option** from the initialization
examples. This option is deprecated and only causes confusion. There's
no good reason to have it lying around in the examples.

It also **updates the explanation of the code samples**, telling you
that you need to generate an API key and linking you to the reference
doc and how to guide.

Relates to: #2782.
 2023-01-03 11:26:17 +01:00
Thomas Heartman
3ac8a63f67
chore: remove constraints announcements from readme and docs (#2678) 
## What

This change removes the Unleash 4.16 constraints announcement from
readme and from the docs.

## Why

It feels like 4.16 has been out for long enough now. Gearing up for
version 4.19, it may be time to take this away.

## Discussion

However, open-sourcing constraints was (and still is) a big deal, so it
might be worth keeping the banner around, but maybe in a more subdued
format? Something like "did you know Unleash's constraints feature is
open source, now?".
 2023-01-03 10:11:04 +01:00
renovate[bot]
b290ffe669
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.0 (#2763) 
[![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)
| [`1.4.7` ->
`1.5.0`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/1.4.7/1.5.0)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.0/compatibility-slim/1.4.7)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.5.0/confidence-slim/1.4.7)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.5.0`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;150-Dec-16-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.7...v1.5.0)

High level enhancements

-   Introduced proxy support
-   Added support for rendering deprecated schema items/properties

Other enhancements and bug fixes

- Only create list of 2xx content types for request samples
([#&#8203;365](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/365))
- \[Enhancement] Add deprecated support to schema items
([#&#8203;367](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/367))
- \[Enhancement] Add proxy support
([#&#8203;366](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/366))
- kebab case fix for info pages
([#&#8203;363](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/363))
- Hide edit URL by default
([#&#8203;364](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/364))
- Update index.ts
([#&#8203;361](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/361))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43NC4yIiwidXBkYXRlZEluVmVyIjoiMzQuNzQuMiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-29 00:04:18 +00:00
renovate[bot]
b61267e713
chore(deps): update react-router monorepo to v6.6.1 (#2762) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router) | [`6.4.5`
-> `6.6.1`](https://renovatebot.com/diffs/npm/react-router/6.4.5/6.6.1)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router/6.6.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router/6.6.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router/6.6.1/compatibility-slim/6.4.5)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router/6.6.1/confidence-slim/6.4.5)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router) |
[`6.4.5` ->
`6.6.1`](https://renovatebot.com/diffs/npm/react-router-dom/6.4.5/6.6.1)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.1/compatibility-slim/6.4.5)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router-dom/6.6.1/confidence-slim/6.4.5)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.6.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;661)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.6.0...react-router@6.6.1)

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.2.1`

###
[`v6.6.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;660)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.5.0...react-router@6.6.0)

##### Patch Changes

- Prevent `useLoaderData` usage in `errorElement`
([#&#8203;9735](https://togithub.com/remix-run/react-router/pull/9735))
-   Updated dependencies:
    -   `@remix-run/router@1.2.0`

###
[`v6.5.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;650)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.4.5...react-router@6.5.0)

This release introduces support for [Optional Route
Segments](https://togithub.com/remix-run/react-router/issues/9546). Now,
adding a `?` to the end of any path segment will make that entire
segment optional. This works for both static segments and dynamic
parameters.

**Optional Params Examples**

-   `<Route path=":lang?/about>` will match:
    -   `/:lang/about`
    -   `/about`
-   `<Route path="/multistep/:widget1?/widget2?/widget3?">` will match:
    -   `/multistep`
    -   `/multistep/:widget1`
    -   `/multistep/:widget1/:widget2`
    -   `/multistep/:widget1/:widget2/:widget3`

**Optional Static Segment Example**

-   `<Route path="/home?">` will match:
    -   `/`
    -   `/home`
-   `<Route path="/fr?/about">` will match:
    -   `/about`
    -   `/fr/about`

##### Minor Changes

- Allows optional routes and optional static segments
([#&#8203;9650](https://togithub.com/remix-run/react-router/pull/9650))

##### Patch Changes

- Stop incorrectly matching on partial named parameters, i.e. `<Route
path="prefix-:param">`, to align with how splat parameters work. If you
were previously relying on this behavior then it's recommended to
extract the static portion of the path at the `useParams` call site:
([#&#8203;9506](https://togithub.com/remix-run/react-router/pull/9506))

```jsx
// Old behavior at URL /prefix-123
<Route path="prefix-:id" element={<Comp /> }>

function Comp() {
  let params = useParams(); // { id: '123' }
  let id = params.id; // "123"
  ...
}

// New behavior at URL /prefix-123
<Route path=":id" element={<Comp /> }>

function Comp() {
  let params = useParams(); // { id: 'prefix-123' }
  let id = params.id.replace(/^prefix-/, ''); // "123"
  ...
}
```

-   Updated dependencies:
    -   `@remix-run/router@1.1.0`

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.6.1`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;661)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.6.0...react-router-dom@6.6.1)

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.2.1`
    -   `react-router@6.6.1`

###
[`v6.6.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;660)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.5.0...react-router-dom@6.6.0)

##### Minor Changes

- Add `useBeforeUnload()` hook
([#&#8203;9664](https://togithub.com/remix-run/react-router/pull/9664))
- Remove `unstable_` prefix from
`createStaticHandler`/`createStaticRouter`/`StaticRouterProvider`
([#&#8203;9738](https://togithub.com/remix-run/react-router/pull/9738))

##### Patch Changes

- Proper hydration of `Error` objects from `StaticRouterProvider`
([#&#8203;9664](https://togithub.com/remix-run/react-router/pull/9664))
- Support uppercase `<Form method>` and `useSubmit` method values
([#&#8203;9664](https://togithub.com/remix-run/react-router/pull/9664))
- Skip initial scroll restoration for SSR apps with `hydrationData`
([#&#8203;9664](https://togithub.com/remix-run/react-router/pull/9664))
- Fix `<button formmethod>` form submission overriddes
([#&#8203;9664](https://togithub.com/remix-run/react-router/pull/9664))
-   Updated dependencies:
    -   `@remix-run/router@1.2.0`
    -   `react-router@6.6.0`

###
[`v6.5.0`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;650)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.4.5...react-router-dom@6.5.0)

##### Patch Changes

-   Updated dependencies:
    -   `react-router@6.5.0`
    -   `@remix-run/router@1.1.0`

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC43My4zIiwidXBkYXRlZEluVmVyIjoiMzQuNzMuMyJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-28 21:50:42 +00:00
renovate[bot]
5dd93b1802
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.5.0 (#2764) 
[![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-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`1.4.7` ->
`1.5.0`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/1.4.7/1.5.0)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.0/compatibility-slim/1.4.7)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.5.0/confidence-slim/1.4.7)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.5.0`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;150-Dec-16-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.7...v1.5.0)

High level enhancements

-   Introduced proxy support
-   Added support for rendering deprecated schema items/properties

Other enhancements and bug fixes

- Only create list of 2xx content types for request samples
([#&#8203;365](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/365))
- \[Enhancement] Add deprecated support to schema items
([#&#8203;367](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/367))
- \[Enhancement] Add proxy support
([#&#8203;366](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/366))
- kebab case fix for info pages
([#&#8203;363](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/363))
- Hide edit URL by default
([#&#8203;364](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/364))
- Update index.ts
([#&#8203;361](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/361))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43NC4yIiwidXBkYXRlZEluVmVyIjoiMzQuNzQuMiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-28 18:56:33 +00:00
renovate[bot]
47bdf618a0
fix(deps): update dependency unleash-proxy-client to v2.4.0 (#2766) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[unleash-proxy-client](https://togithub.com/unleash/unleash-proxy-client-js)
| [`2.3.0` ->
`2.4.0`](https://renovatebot.com/diffs/npm/unleash-proxy-client/2.3.0/2.4.0)
|
[![age](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.0/compatibility-slim/2.3.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/unleash-proxy-client/2.4.0/confidence-slim/2.3.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>unleash/unleash-proxy-client-js</summary>

###
[`v2.4.0`](https://togithub.com/Unleash/unleash-proxy-client-js/releases/tag/v2.4.0)

[Compare
Source](https://togithub.com/unleash/unleash-proxy-client-js/compare/v2.3.0...v2.4.0)

-
[`dd59036`](dd59036a3e)
- fix: Include impression data status when not enabled
([#&#8203;122](https://togithub.com/unleash/unleash-proxy-client-js/issues/122))
-
[`766b697`](766b697fbe)
- Feat/post fetching
([#&#8203;125](https://togithub.com/unleash/unleash-proxy-client-js/issues/125))
-
[`815ac4b`](815ac4b3b8)
- 2.4.0-beta.0
-
[`f0d5397`](f0d5397b63)
- bundle rollup for browser
([#&#8203;129](https://togithub.com/unleash/unleash-proxy-client-js/issues/129))
-
[`477a529`](477a529061)
- 2.4.0-beta.1
-
[`6c7a458`](6c7a458a53)
- 2.4.0

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43NC4yIiwidXBkYXRlZEluVmVyIjoiMzQuNzQuMiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-28 10:55:46 +01:00
renovate[bot]
8790e73b30
chore(deps): update dependency decode-uri-component to ^0.4.0 (#2754) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[decode-uri-component](https://togithub.com/SamVerschueren/decode-uri-component)
| [`^0.2.1` ->
`^0.4.0`](https://renovatebot.com/diffs/npm/decode-uri-component/0.2.2/0.4.1)
|
[![age](https://badges.renovateapi.com/packages/npm/decode-uri-component/0.4.1/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/decode-uri-component/0.4.1/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/decode-uri-component/0.4.1/compatibility-slim/0.2.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/decode-uri-component/0.4.1/confidence-slim/0.2.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>SamVerschueren/decode-uri-component</summary>

###
[`v0.4.1`](https://togithub.com/SamVerschueren/decode-uri-component/releases/tag/v0.4.1)

[Compare
Source](https://togithub.com/SamVerschueren/decode-uri-component/compare/v0.4.0...v0.4.1)

- Add TypeScript type definitions
[`c345b4c`](https://togithub.com/SamVerschueren/decode-uri-component/commit/c345b4c)

###
[`v0.4.0`](https://togithub.com/SamVerschueren/decode-uri-component/releases/tag/v0.4.0)

[Compare
Source](https://togithub.com/SamVerschueren/decode-uri-component/compare/v0.3.0...v0.4.0)

- Require Node.js 14 and move to ESM
([#&#8203;11](https://togithub.com/SamVerschueren/decode-uri-component/issues/11))
[`b09e39d`](https://togithub.com/SamVerschueren/decode-uri-component/commit/b09e39d)

###
[`v0.3.0`](https://togithub.com/SamVerschueren/decode-uri-component/releases/tag/v0.3.0)

[Compare
Source](https://togithub.com/SamVerschueren/decode-uri-component/compare/v0.2.2...v0.3.0)

- Do not decode + to a space - fixes
[#&#8203;3](https://togithub.com/SamVerschueren/decode-uri-component/issues/3)
[`3bbc879`](https://togithub.com/SamVerschueren/decode-uri-component/commit/3bbc879)

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43My4zIiwidXBkYXRlZEluVmVyIjoiMzQuNzMuMyJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-28 01:40:24 +00:00
renovate[bot]
3b1cd9ad80
chore(deps): update storybook monorepo to v6.5.15 (#2751) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[@storybook/addon-actions](https://togithub.com/storybookjs/storybook/tree/main/addons/actions)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.14` ->
`6.5.15`](https://renovatebot.com/diffs/npm/@storybook%2faddon-actions/6.5.14/6.5.15)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.15/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.15/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.15/compatibility-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.15/confidence-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-essentials](https://togithub.com/storybookjs/storybook/tree/main/addons/essentials)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.14` ->
`6.5.15`](https://renovatebot.com/diffs/npm/@storybook%2faddon-essentials/6.5.14/6.5.15)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.15/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.15/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.15/compatibility-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.15/confidence-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-interactions](https://togithub.com/storybookjs/storybook/tree/main/addons/interactions)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.14` ->
`6.5.15`](https://renovatebot.com/diffs/npm/@storybook%2faddon-interactions/6.5.14/6.5.15)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.15/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.15/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.15/compatibility-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.15/confidence-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-links](https://togithub.com/storybookjs/storybook/tree/main/addons/links)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.14` ->
`6.5.15`](https://renovatebot.com/diffs/npm/@storybook%2faddon-links/6.5.14/6.5.15)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.15/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.15/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.15/compatibility-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.15/confidence-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/react](https://togithub.com/storybookjs/storybook/tree/main/app/react)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.14` ->
`6.5.15`](https://renovatebot.com/diffs/npm/@storybook%2freact/6.5.14/6.5.15)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.15/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.15/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.15/compatibility-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.15/confidence-slim/6.5.14)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>storybookjs/storybook</summary>

###
[`v6.5.15`](https://togithub.com/storybookjs/storybook/blob/HEAD/CHANGELOG.md#&#8203;6515-December-20-2022)

[Compare
Source](https://togithub.com/storybookjs/storybook/compare/v6.5.14...v6.5.15)

##### Bug Fixes

- Support Angular 15.0.4
[#&#8203;20287](https://togithub.com/storybooks/storybook/pull/20287)
- CLI: execute automigrations when pressing enter in the prompts
[#&#8203;20208](https://togithub.com/storybooks/storybook/pull/20208)

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC43My4zIiwidXBkYXRlZEluVmVyIjoiMzQuNzMuMyJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-27 22:50:34 +00:00
renovate[bot]
03dc65bf2a
chore(deps): update dependency @babel/core to v7.20.7 (#2740) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@babel/core](https://babel.dev/docs/en/next/babel-core)
([source](https://togithub.com/babel/babel)) | [`7.20.5` ->
`7.20.7`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.20.5/7.20.7)
|
[![age](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.7/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.7/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.7/compatibility-slim/7.20.5)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.7/confidence-slim/7.20.5)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel</summary>

###
[`v7.20.7`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7207-2022-12-22)

[Compare
Source](https://togithub.com/babel/babel/compare/v7.20.5...v7.20.7)

##### 👓 Spec Compliance

- `babel-helper-member-expression-to-functions`,
`babel-helper-replace-supers`, `babel-plugin-proposal-class-properties`,
`babel-plugin-transform-classes`
- [#&#8203;15223](https://togithub.com/babel/babel/pull/15223) fix:
Deleting super property should throw
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))
- `babel-helpers`, `babel-plugin-proposal-class-properties`,
`babel-plugin-transform-classes`, `babel-plugin-transform-object-super`
- [#&#8203;15241](https://togithub.com/babel/babel/pull/15241) fix:
Throw correct error types from sed ant class TDZ helpers
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))

##### 🐛 Bug Fix

-   `babel-parser`, `babel-plugin-transform-typescript`
- [#&#8203;15209](https://togithub.com/babel/babel/pull/15209) fix:
Support auto accessors with TypeScript annotations
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-traverse`
- [#&#8203;15287](https://togithub.com/babel/babel/pull/15287) Fix
`.parentPath` after rename in `SwitchCase`
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))
-   `babel-plugin-transform-typescript`, `babel-traverse`
- [#&#8203;15284](https://togithub.com/babel/babel/pull/15284) fix: Ts
import type and func with duplicate name
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-plugin-transform-block-scoping`
- [#&#8203;15278](https://togithub.com/babel/babel/pull/15278) Fix tdz
analysis for reassigned captured for bindings
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))
- `babel-plugin-proposal-async-generator-functions`, `babel-preset-env`
- [#&#8203;15235](https://togithub.com/babel/babel/pull/15235) fix:
Transform `for await` with shadowed variables
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-generator`, `babel-plugin-proposal-optional-chaining`
- [#&#8203;15258](https://togithub.com/babel/babel/pull/15258) fix:
Correctly generate `(a ?? b) as T`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-plugin-transform-react-jsx`, `babel-types`
- [#&#8203;15233](https://togithub.com/babel/babel/pull/15233) fix: Emit
correct sourcemap ranges for `JSXText`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
- `babel-core`, `babel-helpers`,
`babel-plugin-transform-computed-properties`, `babel-runtime-corejs2`,
`babel-runtime-corejs3`, `babel-runtime`
- [#&#8203;15232](https://togithub.com/babel/babel/pull/15232) fix:
Computed properties should keep original definition order
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))
- `babel-helper-member-expression-to-functions`,
`babel-helper-replace-supers`, `babel-plugin-proposal-class-properties`,
`babel-plugin-transform-classes`
- [#&#8203;15223](https://togithub.com/babel/babel/pull/15223) fix:
Deleting super property should throw
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))
-   `babel-generator`
- [#&#8203;15216](https://togithub.com/babel/babel/pull/15216) fix:
Print newlines for leading Comments of `TSEnumMember`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))

##### 💅 Polish

-   `babel-plugin-transform-block-scoping`, `babel-traverse`
- [#&#8203;15275](https://togithub.com/babel/babel/pull/15275) Improve
relative execution tracking in fn exprs
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))

##### 🏠 Internal

- `babel-helper-define-map`, `babel-plugin-transform-property-mutators`
- [#&#8203;15274](https://togithub.com/babel/babel/pull/15274) Inline &
simplify `@babel/helper-define-map`
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))
- `babel-core`, `babel-plugin-proposal-class-properties`,
`babel-plugin-transform-block-scoping`,
`babel-plugin-transform-classes`,
`babel-plugin-transform-destructuring`,
`babel-plugin-transform-parameters`,
`babel-plugin-transform-regenerator`, `babel-plugin-transform-runtime`,
`babel-preset-env`, `babel-traverse`
- [#&#8203;15200](https://togithub.com/babel/babel/pull/15200) Rewrite
`transform-block-scoping` plugin
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))

##### 🏃‍♀️ Performance

-   `babel-helper-compilation-targets`
- [#&#8203;15228](https://togithub.com/babel/babel/pull/15228) perf:
Speed up `getTargets`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43My4zIiwidXBkYXRlZEluVmVyIjoiMzQuNzMuMyJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-27 10:07:48 +00:00
Thomas Heartman
ff9bc1d10c
Docs: fix typo / lexical illusion "the the" -> "to the" 2022-12-18 23:06:35 +01:00
Simon Hornby
e437b61753
docs: update group docs to reflect that users is not optional (#2667) 
The reference documentation for groups is incorrect, groups always
require a list of users

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-12-16 10:45:15 +01:00
Thomas Heartman
dc8a369b7b
Docs: update availability notice for sso keycloak group sync 
## What

This change updates the availability notice in the SSO keycloak setup
guide.

## Why

Because the notice still said that it's an "upcoming" feature, but it
was released in 4.18.
 2022-12-15 11:00:36 +01:00
Thomas Heartman
160b9a0604
docs: small fixes (#2688) 
## What

This PR contains two small doc updates/fixes:

1. Update the availability notice on SSO syncing to indicate that it has
been released.
2. Add a note to the Import API description that importing environments
will make Unleash delete API keys belonging to those environments.

## Why

1. To keep the docs up to date.
2. Because this behavior surprised (and rightly so, I'd say) a user, who
then suddenly had all their SDKs unable to connect.

Co-authored-by: Nuno Góis <github@nunogois.com>
 2022-12-14 15:26:41 +01:00
Thomas Heartman
65d69c6fa7
Chore: correctly format docusaurus.config.js 
This bit of code has been popping up in all my change batches
recently, so I'm gonna nip it in the bud and fix it.
 2022-12-13 08:27:00 +01:00
Thomas Heartman
a3fdef11ab
docs: various fixes (#2669) 
## What

This PR contains a number of minor fixes to the docs in terms of
formatting and redirects. The changes are:

- Adding an availability notice for the front-end API reference docs
(with links to the release blog post).

- Fix malformed admonition headers in the Unleash proxy docs and
impression data docs.

-   Add missing redirects:

- `/advanced/custom_activation_strategy` ->
`/reference/custom-activation-strategies`
- `/docs/deploy/configuring_unleash` ->
`/reference/deploy/configuring-unleash`
- `/docs/user_guide/connect_sdk` -> `/reference/sdks`(this one goes to
the SDKs doc instead of the quickstart because there's more
comprehensive information there and because `/user_guide/connect_sdk`
already goes there)
    -   `/sdks/proxy-javascript` -> `/reference/sdks/javascript-browser`
    -   `/sdks/proxy-react`-> `/reference/sdks/react`
- `/docs/getting_started` -> `/tutorials/quickstart` (this does not go
to "Deploy: getting started" because that is its own link)

## Why

Because keeping the docs up to date and accessible is important.
 2022-12-12 14:08:13 +01:00
renovate[bot]
768e2b2038
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.4.7 (#2652) 
[![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-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`1.4.5` ->
`1.4.7`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/1.4.5/1.4.7)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.7/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.7/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.7/compatibility-slim/1.4.5)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.7/confidence-slim/1.4.5)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.4.7`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;147-Dec-2-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.6...v1.4.7)

High level enhancements

- Emergency patch to address regression bug introdudced by
[#&#8203;351](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/351)

Other enhancements and bug fixes

- Import markdown utils from lib
([#&#8203;358](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/358))

###
[`v1.4.6`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;146-Dec-2-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.5...v1.4.6)

High level enhancements

-   Added support for swizzling `ApiItem` and `ApiDemoPanel` components!

Other enhancements and bug fixes

- Remove createProperties from items anyOneOf condition and add new
condition for handling items.properties
([#&#8203;356](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/356))
- \[Enhancement] Allow whitespace in key/token/password input
([#&#8203;354](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/354))
- \[Bug] Respect readOnly/writeOnly when creating example from schema
([#&#8203;353](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/353))
- \[Bug] Import Body from [@&#8203;theme](https://togithub.com/theme) in
makeRequest
([#&#8203;352](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/352))
- \[Experimental] Improve support for swizzling theme components
([#&#8203;351](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/351))
- Bump loader-utils from 2.0.3 to 2.0.4
([#&#8203;346](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/346))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC41MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuNTEuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-09 20:17:43 +00:00
Zan Marolt
d76d9d863d
Add azure example to the documentation page (#2641) 
## About the changes
Noticed there is missing link to the azure sso implementation example.
 2022-12-09 10:49:38 +00:00
Mateusz Kwasniewski
867a8a4e8d
remove experimental notice (#2640) 2022-12-09 09:30:00 +01:00
renovate[bot]
a3328a2d18
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.4.7 (#2646) 
[![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)
| [`1.4.5` ->
`1.4.7`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/1.4.5/1.4.7)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.7/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.7/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.7/compatibility-slim/1.4.5)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.7/confidence-slim/1.4.5)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.4.7`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;147-Dec-2-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.6...v1.4.7)

High level enhancements

- Emergency patch to address regression bug introdudced by
[#&#8203;351](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/351)

Other enhancements and bug fixes

- Import markdown utils from lib
([#&#8203;358](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/358))

###
[`v1.4.6`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;146-Dec-2-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.5...v1.4.6)

High level enhancements

-   Added support for swizzling `ApiItem` and `ApiDemoPanel` components!

Other enhancements and bug fixes

- Remove createProperties from items anyOneOf condition and add new
condition for handling items.properties
([#&#8203;356](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/356))
- \[Enhancement] Allow whitespace in key/token/password input
([#&#8203;354](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/354))
- \[Bug] Respect readOnly/writeOnly when creating example from schema
([#&#8203;353](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/353))
- \[Bug] Import Body from [@&#8203;theme](https://togithub.com/theme) in
makeRequest
([#&#8203;352](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/352))
- \[Experimental] Improve support for swizzling theme components
([#&#8203;351](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/351))
- Bump loader-utils from 2.0.3 to 2.0.4
([#&#8203;346](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/346))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC41MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuNTEuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-09 07:55:01 +00:00
renovate[bot]
c60f94d61d
chore(deps): update storybook monorepo to v6.5.14 (#2645) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
|
[@storybook/addon-actions](https://togithub.com/storybookjs/storybook/tree/main/addons/actions)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.13` ->
`6.5.14`](https://renovatebot.com/diffs/npm/@storybook%2faddon-actions/6.5.13/6.5.14)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.14/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.14/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.14/compatibility-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-actions/6.5.14/confidence-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-essentials](https://togithub.com/storybookjs/storybook/tree/main/addons/essentials)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.13` ->
`6.5.14`](https://renovatebot.com/diffs/npm/@storybook%2faddon-essentials/6.5.13/6.5.14)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.14/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.14/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.14/compatibility-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-essentials/6.5.14/confidence-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-interactions](https://togithub.com/storybookjs/storybook/tree/main/addons/interactions)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.13` ->
`6.5.14`](https://renovatebot.com/diffs/npm/@storybook%2faddon-interactions/6.5.13/6.5.14)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.14/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.14/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.14/compatibility-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-interactions/6.5.14/confidence-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/addon-links](https://togithub.com/storybookjs/storybook/tree/main/addons/links)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.13` ->
`6.5.14`](https://renovatebot.com/diffs/npm/@storybook%2faddon-links/6.5.13/6.5.14)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.14/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.14/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.14/compatibility-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2faddon-links/6.5.14/confidence-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
|
[@storybook/react](https://togithub.com/storybookjs/storybook/tree/main/app/react)
([source](https://togithub.com/storybookjs/storybook)) | [`6.5.13` ->
`6.5.14`](https://renovatebot.com/diffs/npm/@storybook%2freact/6.5.13/6.5.14)
|
[![age](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.14/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.14/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.14/compatibility-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@storybook%2freact/6.5.14/confidence-slim/6.5.13)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>storybookjs/storybook</summary>

###
[`v6.5.14`](https://togithub.com/storybookjs/storybook/releases/tag/v6.5.14)

[Compare
Source](https://togithub.com/storybookjs/storybook/compare/v6.5.13...v6.5.14)

##### Bug Fixes

- Angular: Fix "**webpack_require**.nmd is not a function issue" in
Angular 15
[#&#8203;20043](https://togithub.com/storybooks/storybook/pull/20043)
- CLI/React native: Fix addons template to import register instead of
manager
[#&#8203;19620](https://togithub.com/storybooks/storybook/pull/19620)

##### Maintenance

- Core: Patch preview-web and refs to support React Native
[#&#8203;19975](https://togithub.com/storybooks/storybook/pull/19975)

##### Dependency Upgrades

- Upgrade loader-utils to 2.0.4 in storysource and source-loader
[#&#8203;19891](https://togithub.com/storybooks/storybook/pull/19891)

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC41MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuNTEuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-09 04:13:41 +00:00
renovate[bot]
ae107ee230
chore(deps): update react-router monorepo to v6.4.5 (#2643) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router) | [`6.4.3`
-> `6.4.5`](https://renovatebot.com/diffs/npm/react-router/6.4.3/6.4.5)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router/6.4.5/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router/6.4.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router/6.4.5/compatibility-slim/6.4.3)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router/6.4.5/confidence-slim/6.4.3)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router) |
[`6.4.3` ->
`6.4.5`](https://renovatebot.com/diffs/npm/react-router-dom/6.4.3/6.4.5)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.5/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.5/compatibility-slim/6.4.3)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.5/confidence-slim/6.4.3)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.4.5`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;645)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.4.4...react-router@6.4.5)

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.0.5`

###
[`v6.4.4`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;644)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.4.3...react-router@6.4.4)

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.0.4`

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.4.5`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;645)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.4.4...react-router-dom@6.4.5)

##### Patch Changes

-   Updated dependencies:
    -   `@remix-run/router@1.0.5`
    -   `react-router@6.4.5`

###
[`v6.4.4`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;644)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.4.3...react-router-dom@6.4.4)

##### Patch Changes

- Fix issues with encoded characters in `NavLink` and descendant
`<Routes>`
([#&#8203;9589](https://togithub.com/remix-run/react-router/pull/9589),
[#&#8203;9647](https://togithub.com/remix-run/react-router/pull/9647))
- Properly serialize/deserialize `ErrorResponse` instances when using
built-in hydration
([#&#8203;9593](https://togithub.com/remix-run/react-router/pull/9593))
- Support `basename` in static data routers
([#&#8203;9591](https://togithub.com/remix-run/react-router/pull/9591))
-   Updated dependencies:
    -   `@remix-run/router@1.0.4`
    -   `react-router@6.4.4`

</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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC41MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuNTEuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-12-08 23:52:35 +00:00
Ivar Conradi Østhus
739b6c3170
fix(docs): add resulution for qs dep 2022-12-08 11:32:22 +01:00
Fredrik Strand Oseberg
8f540f0698
Docs/change request beta docs (#2608) 
<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

This PR adds beta documentation for the change request feature. 

<!-- Does it close an issue? Multiple? -->
Closes #

<!-- (For internal contributors): Does it relate to an issue on public
roadmap? -->
<!--
Relates to [roadmap](https://github.com/orgs/Unleash/projects/10) item:
#
-->

### Important files
<!-- PRs can contain a lot of changes, but not all changes are equally
important. Where should a reviewer start looking to get an overview of
the changes? Are any files particularly important? -->


## Discussion points
<!-- Anything about the PR you'd like to discuss before it gets merged?
Got any questions or doubts? -->

Co-authored-by: sjaanus <sellinjaanus@gmail.com>
 2022-12-06 14:02:44 +01:00
Ivar Conradi Østhus
0188998b4c
fix(docs): add resulution for 'decode-uri-component' 2022-12-06 09:46:22 +01:00
Thomas Heartman
8c42fbf34b
Docs(fix): add more (missing) redirects, fix links (#2592) 
## What

This PR fixes some broken links we had in the application. It also adds
redirects for those links so that they should work in the future.

## Why

Because it's important to have links that work 💁
 2022-12-06 09:32:42 +01:00
Ivar Conradi Østhus
4a3d26065f
Fix/cors expose ETag (#2594) 
This commit fixes two issues with the frontend API

1. fix: update cors max age to match chromium defaults
https://source.chromium.org/chromium/chromium/src/+/main:services/network/public/cpp/cors/preflight_result.cc;drc=49e7c0b4886cac1f3d09dc046bd528c9c811a0fa;l=31
2: fix: expose ETage for cross-origin requests
 2022-12-05 10:04:35 +01:00
Pranshu Khanna
a2321192fc Added GitHub Discussions Links 
Added GitHub Discussions as an option along with Slack.
 2022-12-01 17:09:53 +01:00
Christopher Kolstad
a113f9c2c0
Change to preferred export format (#2567) 
### What
This PR updates the example for the hook to use the export format that
is recommended in the ADR we've written on export types.
 2022-11-30 10:42:00 +01:00
Christopher Kolstad
753d6681ff
fix typo in preferred-form-architecture (#2566) 
A very quick typo fix. It's whether, not wheter. :)
 2022-11-30 10:33:42 +01:00
Fredrik Strand Oseberg
ad7c139992
fix: add ADR for domain language (#2541) 
This PR puts our contributing guidelines in the sidebar of the unleash
documentation. Currently there was no way of navigating to them easily,
which made our contribution guides and ADRs less useful. This PR adds
them to the sidebar as their own category, and adds an ADR for domain
centric language.

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-11-29 08:57:27 +01:00
renovate[bot]
1c5b96fcab
chore(deps): update dependency @babel/core to v7.20.5 (#2551) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@babel/core](https://babel.dev/docs/en/next/babel-core)
([source](https://togithub.com/babel/babel)) | [`7.20.2` ->
`7.20.5`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.20.2/7.20.5)
|
[![age](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.5/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.5/compatibility-slim/7.20.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.5/confidence-slim/7.20.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel</summary>

###
[`v7.20.5`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7205-2022-11-28)

[Compare
Source](https://togithub.com/babel/babel/compare/v7.20.2...v7.20.5)

##### 👓 Spec Compliance

- `babel-helpers`, `babel-plugin-transform-destructuring`,
`babel-plugin-transform-modules-commonjs`, `babel-preset-env`,
`babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`,
`babel-traverse`
- [#&#8203;15183](https://togithub.com/babel/babel/pull/15183) Improve
array destructuring spec compliance
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))
- `babel-cli`, `babel-helpers`,
`babel-plugin-proposal-class-properties`,
`babel-plugin-proposal-class-static-block`,
`babel-plugin-transform-classes`, `babel-plugin-transform-runtime`,
`babel-preset-env`
- [#&#8203;15182](https://togithub.com/babel/babel/pull/15182) fix:
apply toPropertyKey when defining class members
([@&#8203;JLHwung](https://togithub.com/JLHwung))
- `babel-helper-create-class-features-plugin`, `babel-helpers`,
`babel-plugin-proposal-decorators`,
`babel-plugin-proposal-private-property-in-object`, `babel-preset-env`,
`babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`
- [#&#8203;15133](https://togithub.com/babel/babel/pull/15133) fix:
validate rhs of `in` when transpiling `#p in C`
([@&#8203;JLHwung](https://togithub.com/JLHwung))

##### 🐛 Bug Fix

-   `babel-parser`
- [#&#8203;15225](https://togithub.com/babel/babel/pull/15225) Parse
`using[foo]` as computed member expression
([@&#8203;JLHwung](https://togithub.com/JLHwung))
- [#&#8203;15207](https://togithub.com/babel/babel/pull/15207) Export
`ParseResult` type ([@&#8203;davydof](https://togithub.com/davydof))
- [#&#8203;15198](https://togithub.com/babel/babel/pull/15198) fix:
parse `import module, ...`
([@&#8203;JLHwung](https://togithub.com/JLHwung))
-   `babel-helper-wrap-function`, `babel-preset-env`, `babel-traverse`
- [#&#8203;15181](https://togithub.com/babel/babel/pull/15181) fix: Edge
cases for async functions and `noNewArrow` assumption
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
- `babel-plugin-transform-arrow-functions`,
`babel-plugin-transform-parameters`, `babel-traverse`
- [#&#8203;15163](https://togithub.com/babel/babel/pull/15163) fix:
Throw error when compiling `super()` in arrow functions with default /
rest parameters
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))
- `babel-helpers`, `babel-node`,
`babel-plugin-proposal-async-generator-functions`,
`babel-plugin-transform-regenerator`, `babel-preset-env`,
`babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`
- [#&#8203;15194](https://togithub.com/babel/babel/pull/15194) fix: Bump
`regenerator` and add tests
([@&#8203;SuperSodaSea](https://togithub.com/SuperSodaSea))
-   `babel-helper-create-regexp-features-plugin`
- [#&#8203;15192](https://togithub.com/babel/babel/pull/15192) fix:
Update `regjsparser` for `@babel/standalone`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-parser`, `babel-types`
- [#&#8203;15109](https://togithub.com/babel/babel/pull/15109) fix:
Babel 8 types
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-generator`
- [#&#8203;15143](https://togithub.com/babel/babel/pull/15143) Don't
print inner comments as leading when wrapping in `(``)`
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))
-   `babel-plugin-transform-block-scoping`, `babel-traverse`
- [#&#8203;15167](https://togithub.com/babel/babel/pull/15167) Register
`switch`'s `discriminant` in the outer scope
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))

##### 💅 Polish

-   `babel-generator`
- [#&#8203;15173](https://togithub.com/babel/babel/pull/15173) Improve
generator behavior when `comments:false`
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-plugin-transform-block-scoping`
- [#&#8203;15164](https://togithub.com/babel/babel/pull/15164) Only
extract IDs for TDZ checks in assign when necessary
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))

##### 🏠 Internal

-   `babel-core`, `babel-parser`
- [#&#8203;15202](https://togithub.com/babel/babel/pull/15202) Bump
typescript to 4.9.3 ([@&#8203;JLHwung](https://togithub.com/JLHwung))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC40MC4yIiwidXBkYXRlZEluVmVyIjoiMzQuNDAuMiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-28 21:52:20 +00:00
Fredrik Strand Oseberg
5d52216d53
fix: adds cors caching (#2522) 
* This PR adds a configurable maxAge header to the CORS middleware. This
allows the preflight request to be cached so that we can reduce the
request load on our end for the frontend clients starting to utilise the
frontend api.
 2022-11-24 16:14:47 +01:00
renovate[bot]
6e2351edeb
chore(deps): update dependency enhanced-resolve to v5.12.0 (#2517) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [enhanced-resolve](https://togithub.com/webpack/enhanced-resolve) |
[`5.11.0` ->
`5.12.0`](https://renovatebot.com/diffs/npm/enhanced-resolve/5.11.0/5.12.0)
|
[![age](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.12.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.12.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.12.0/compatibility-slim/5.11.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.12.0/confidence-slim/5.11.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>webpack/enhanced-resolve</summary>

###
[`v5.12.0`](https://togithub.com/webpack/enhanced-resolve/releases/tag/v5.12.0)

[Compare
Source](https://togithub.com/webpack/enhanced-resolve/compare/v5.11.0...v5.12.0)

-   reverts "utilize throwIfNoEntry in sync mode"

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4zMC40IiwidXBkYXRlZEluVmVyIjoiMzQuMzAuNCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-23 21:57:46 +00:00
NicolaeUnleash
bf13009a00
Docs: update unleash proxy API img (#2478) 
This change updates the proxy API illustration with the correct payload. It also adds a caption to better explain what is going on (and to make it more accessible).

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-11-23 12:27:59 +00:00
renovate[bot]
543f07104c
chore(deps): update dependency enhanced-resolve to v5.11.0 (#2507) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [enhanced-resolve](https://togithub.com/webpack/enhanced-resolve) |
[`5.10.0` ->
`5.11.0`](https://renovatebot.com/diffs/npm/enhanced-resolve/5.10.0/5.11.0)
|
[![age](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.11.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.11.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.11.0/compatibility-slim/5.10.0)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/enhanced-resolve/5.11.0/confidence-slim/5.10.0)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>webpack/enhanced-resolve</summary>

###
[`v5.11.0`](https://togithub.com/webpack/enhanced-resolve/releases/tag/v5.11.0)

[Compare
Source](https://togithub.com/webpack/enhanced-resolve/compare/v5.10.0...v5.11.0)

### Features

-   utilize throwIfNoEntry in sync mode

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4zMC4yIiwidXBkYXRlZEluVmVyIjoiMzQuMzAuMiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-22 22:24:57 +00:00
Thomas Heartman
d5fbd0b743
refactor: move docs into new structure / fix links for SEO (#2416) 
## What

This (admittedly massive) PR updates the "physical" documentation
structure and fixes url inconsistencies and SEO problems reported by
marketing. The main points are:

- remove or move directories : advanced, user_guide, deploy, api
- move the files contained within to the appropriate one of topics,
how-to, tutorials, or reference
- update internal doc links and product links to the content
- create client-side redirects for all the urls that have changed.

A number of the files have been renamed in small ways to better match
their url and to make them easier to find. Additionally, the top-level
api directory has been moved to /reference/api/legacy/unleash (see the
discussion points section for more on this).

## Why

When moving our doc structure to diataxis a while back, we left the
"physical' files lying where they were, because it didn't matter much to
the new structure. However, that did introduce some inconsistencies with
where you place docs and how we organize them.

There's also the discrepancies in whether urls us underscores or hyphens
(which isn't necessarily the same as their file name), which has been
annoying me for a while, but now has also been raised by marketing as an
issue in terms of SEO.

## Discussion points

The old, hand-written API docs have been moved from /api to
/reference/api/legacy/unleash. There _is_ a /reference/api/unleash
directory, but this is being populated by the OpenAPI plugin, and mixing
those could only cause trouble. However, I'm unsure about putting
/legacy/ in the title, because the API isn't legacy, the docs are. Maybe
we could use another path? Like /old-docs/ or something? I'd appreciate
some input on this.
 2022-11-22 09:05:30 +00:00
NicolaeUnleash
65ba1bf4e0
docs: Update Unleash proxy illustration (#2477) 
Updates the diagram presented in the docs to better illustrate how it works and to use the correct endpoint.
 2022-11-18 14:20:18 +00:00
JarrodSC
31dc31fdf4
Docs: Updated personal access tokens for accuracy (#2459) 
Updated **personal access tokens** section to reflect that users
technically can set the expiration date to **never**.
 2022-11-18 11:23:17 +00:00
renovate[bot]
d1f657bf0a
fix(deps): update dependency docusaurus-theme-openapi-docs to v1.4.5 (#2370) 
[![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-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`1.4.4` ->
`1.4.5`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/1.4.4/1.4.5)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.5/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.5/compatibility-slim/1.4.4)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/1.4.5/confidence-slim/1.4.4)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.4.5`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;145-Nov-15-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.4...v1.4.5)

High level enhancements

-   Bug fixes and polish
- Re-introduce missing `--openapi-input-background` variable to
`styles.css`

Other enhancements and bug fixes

- \[Bug] Add condition for handling arrays of discriminators
([#&#8203;344](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/344))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzQuMjQuMSJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-17 18:27:28 +00:00
renovate[bot]
bffea7dcb9
fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.4.5 (#2369) 
[![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)
| [`1.4.4` ->
`1.4.5`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/1.4.4/1.4.5)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.5/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.5/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.5/compatibility-slim/1.4.4)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/1.4.5/confidence-slim/1.4.4)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v1.4.5`](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CHANGELOG.md#&#8203;145-Nov-15-2022)

[Compare
Source](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/compare/v1.4.4...v1.4.5)

High level enhancements

-   Bug fixes and polish
- Re-introduce missing `--openapi-input-background` variable to
`styles.css`

Other enhancements and bug fixes

- \[Bug] Add condition for handling arrays of discriminators
([#&#8203;344](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/344))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzQuMjQuMSJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-16 19:30:08 +00:00
Simon Hornby
3624cdc21f
docs: move sso how to guides to the how-to folder (#2323) 
We're in the process of moving how-to guides into the how-to folder,
where they belong. This continues that work and shifts the how to guides
for SSO to the correct place and gives them appropriate names

Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
 2022-11-14 14:11:27 +02:00
Ivar Conradi Østhus
309ba68a31
Update import-export.md 2022-11-14 10:24:20 +01:00
Thomas Heartman
29da625195
chore: update docusaurus/openapi integration to stable version (#2414) 
## What

This PR updates the version of the docusaurus-openapi plugin we depend
on for openapi docs generation from canary version 0.0.0-514 to stable
release 1.4.4.

Also removes the manual file cleanup that was created as a workaround to
solve the issues we were having.

## Why

When we set the canary version before the weekend it was because it
contained a fix of some of the issues we were having with our docs.

That issue (and the one about file cleanup) have now been released in
v1.4.4, so we can upgrade to a stable version and remove now-redundant
cleanup code.
 2022-11-14 08:52:46 +01:00
renovate[bot]
ca2c96de52
chore(deps): update dependency @babel/core to v7.20.2 (#2371) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@babel/core](https://babel.dev/docs/en/next/babel-core)
([source](https://togithub.com/babel/babel)) | [`7.19.6` ->
`7.20.2`](https://renovatebot.com/diffs/npm/@babel%2fcore/7.19.6/7.20.2)
|
[![age](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.2/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.2/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.2/compatibility-slim/7.19.6)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/@babel%2fcore/7.20.2/confidence-slim/7.19.6)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>babel/babel</summary>

###
[`v7.20.2`](https://togithub.com/babel/babel/blob/HEAD/CHANGELOG.md#v7202-2022-11-04)

[Compare
Source](https://togithub.com/babel/babel/compare/v7.19.6...v7.20.2)

##### 🐛 Bug Fix

- `babel-core`, `babel-helper-create-class-features-plugin`,
`babel-helper-module-transforms`, `babel-helper-plugin-utils`,
`babel-helper-simple-access`, `babel-node`,
`babel-plugin-transform-block-scoping`,
`babel-plugin-transform-classes`,
`babel-plugin-transform-react-constant-elements`, `babel-preset-env`,
`babel-standalone`, `babel-types`
- [#&#8203;15124](https://togithub.com/babel/babel/pull/15124) fix:
`@babel/node` repl and enable `no-use-before-define` rule
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-plugin-transform-typescript`
- [#&#8203;15121](https://togithub.com/babel/babel/pull/15121) fix:
`tsSatisfiesExpression` check with different duplicated `@babel/types`
versions ([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-parser`
- [#&#8203;15094](https://togithub.com/babel/babel/pull/15094) fix:
`parser` typings for plugins
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))
-   `babel-generator`
- [#&#8203;15118](https://togithub.com/babel/babel/pull/15118) Improve
printing of \[no LineTerminator here] with comments
([@&#8203;nicolo-ribaudo](https://togithub.com/nicolo-ribaudo))
- `babel-plugin-proposal-decorators`,
`babel-plugin-proposal-object-rest-spread`,
`babel-plugin-transform-jscript`
- [#&#8203;15113](https://togithub.com/babel/babel/pull/15113) fix: wrap
anonymous class expression within statement
([@&#8203;JLHwung](https://togithub.com/JLHwung))
-   `babel-plugin-transform-destructuring`
- [#&#8203;15104](https://togithub.com/babel/babel/pull/15104) fix:
Destructuring exceptions ` for ( let { } = 0 ; 0 ; ) `
([@&#8203;liuxingbaoyu](https://togithub.com/liuxingbaoyu))

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzQuMTkuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-12 08:24:41 +00:00
renovate[bot]
5988148e13
fix(deps): update dependency docusaurus-theme-openapi-docs to v0.0.0-514 (#2409) 
[![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-theme-openapi-docs](https://togithub.com/PaloAltoNetworks/docusaurus-openapi-docs)
| [`0.0.0-507` ->
`0.0.0-514`](https://renovatebot.com/diffs/npm/docusaurus-theme-openapi-docs/0.0.0-507/0.0.0-514)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/0.0.0-514/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/0.0.0-514/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/0.0.0-514/compatibility-slim/0.0.0-507)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-theme-openapi-docs/0.0.0-514/confidence-slim/0.0.0-507)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v0.0.0-514`](795da2f81a...a8ae6e77f4)

[Compare
Source](795da2f81a...a8ae6e77f4)

###
[`v0.0.0-513`](e32c9361d2...795da2f81a)

[Compare
Source](e32c9361d2...795da2f81a)

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4yMS42IiwidXBkYXRlZEluVmVyIjoiMzQuMjEuNiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-12 05:54:51 +00:00
renovate[bot]
167ad82a4f
chore(deps): update react-router monorepo to v6.4.3 (#2368) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-router](https://togithub.com/remix-run/react-router) | [`6.4.2`
-> `6.4.3`](https://renovatebot.com/diffs/npm/react-router/6.4.2/6.4.3)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router/6.4.3/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router/6.4.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router/6.4.3/compatibility-slim/6.4.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router/6.4.3/confidence-slim/6.4.2)](https://docs.renovatebot.com/merge-confidence/)
|
| [react-router-dom](https://togithub.com/remix-run/react-router) |
[`6.4.2` ->
`6.4.3`](https://renovatebot.com/diffs/npm/react-router-dom/6.4.2/6.4.3)
|
[![age](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.3/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.3/compatibility-slim/6.4.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/react-router-dom/6.4.3/confidence-slim/6.4.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>remix-run/react-router (react-router)</summary>

###
[`v6.4.3`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router/CHANGELOG.md#&#8203;643)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router@6.4.2...react-router@6.4.3)

##### Patch Changes

- `useRoutes` should be able to return `null` when passing `locationArg`
([#&#8203;9485](https://togithub.com/remix-run/react-router/pull/9485))
- fix `initialEntries` type in `createMemoryRouter`
([#&#8203;9498](https://togithub.com/remix-run/react-router/pull/9498))
-   Updated dependencies:
    -   `@remix-run/router@1.0.3`

</details>

<details>
<summary>remix-run/react-router (react-router-dom)</summary>

###
[`v6.4.3`](https://togithub.com/remix-run/react-router/blob/HEAD/packages/react-router-dom/CHANGELOG.md#&#8203;643)

[Compare
Source](https://togithub.com/remix-run/react-router/compare/react-router-dom@6.4.2...react-router-dom@6.4.3)

##### Patch Changes

- Fix hrefs generated for `createHashRouter`
([#&#8203;9409](https://togithub.com/remix-run/react-router/pull/9409))
- fix encoding/matching issues with special chars
([#&#8203;9477](https://togithub.com/remix-run/react-router/pull/9477),
[#&#8203;9496](https://togithub.com/remix-run/react-router/pull/9496))
- Properly support `index` routes with a `path` in `useResolvedPath`
([#&#8203;9486](https://togithub.com/remix-run/react-router/pull/9486))
- Respect `relative=path` prop on `NavLink`
([#&#8203;9453](https://togithub.com/remix-run/react-router/pull/9453))
- Fix `NavLink` behavior for root urls
([#&#8203;9497](https://togithub.com/remix-run/react-router/pull/9497))
-   Updated dependencies:
    -   `@remix-run/router@1.0.3`
    -   `react-router@6.4.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 these
updates 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:eyJjcmVhdGVkSW5WZXIiOiIzNC4xOS4wIiwidXBkYXRlZEluVmVyIjoiMzQuMTkuMCJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-12 03:27:44 +00:00
renovate[bot]
e924d9da57
fix(deps): update dependency docusaurus-plugin-openapi-docs to v0.0.0-514 (#2408) 
[![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)
| [`0.0.0-507` ->
`0.0.0-514`](https://renovatebot.com/diffs/npm/docusaurus-plugin-openapi-docs/0.0.0-507/0.0.0-514)
|
[![age](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/0.0.0-514/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/0.0.0-514/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/0.0.0-514/compatibility-slim/0.0.0-507)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/docusaurus-plugin-openapi-docs/0.0.0-514/confidence-slim/0.0.0-507)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

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

###
[`v0.0.0-514`](795da2f81a...a8ae6e77f4)

[Compare
Source](795da2f81a...a8ae6e77f4)

###
[`v0.0.0-513`](e32c9361d2...795da2f81a)

[Compare
Source](e32c9361d2...795da2f81a)

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC4yMS42IiwidXBkYXRlZEluVmVyIjoiMzQuMjEuNiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-12 00:16:33 +00:00
Thomas Heartman
0cd04fc882
chore: fix broken docs build / remove unused tag files (#2402) 
## Issue

So, we've got an issue with our docs build not working. When building
for production, we get an error that looks a little bit like this:

```
$ docusaurus build
[INFO] [en] Creating an optimized production build...

✔ Client


✖ Server
  Compiled with some errors in 40.85s



TypeError: source_default(...).bold is not a function
TypeError: source_default(...).bold is not a function
[ERROR] Unable to build website for locale en.
[ERROR] Error: Failed to compile with errors.
    at /Users/thomas/projects/work/unleash/website/node_modules/@docusaurus/core/lib/webpack/utils.js:180:24
    at /Users/thomas/projects/work/unleash/website/node_modules/webpack/lib/MultiCompiler.js:554:14
    at processQueueWorker (/Users/thomas/projects/work/unleash/website/node_modules/webpack/lib/MultiCompiler.js:491:6)
    at processTicksAndRejections (node:internal/process/task_queues:78:11)
[INFO] Docusaurus version: 2.2.0
Node version: v16.14.0
error Command failed with exit code 1.
```

Which isn't very helpful at all. If you go into
`/node_modules/@docusaurus/core/lib/client/serverEntry.js` and modify
the `render` function to log the actual error and remove anything
chalk-related, you get this instead:

```
$ docusaurus build
[INFO] [en] Creating an optimized production build...

✔ Client


✖ Server
  Compiled with some errors in 44.62s

Actual error: Error: Unexpected: cant find current sidebar in context
    at useCurrentSidebarCategory (main:11618:247)
    at MDXContent (main:38139:1593)
    at Fb (main:149154:44)
    at Ib (main:149156:254)
    at W (main:149162:89)
    at Jb (main:149165:98)
    at Ib (main:149157:145)
    at W (main:149162:89)
    at Jb (main:149165:98)
    at Ib (main:149157:145)
Actual error: Error: Unexpected: cant find current sidebar in context
    at useCurrentSidebarCategory (main:11618:247)
    at MDXContent (main:38513:1469)
    at Fb (main:149154:44)
    at Ib (main:149156:254)
    at W (main:149162:89)
    at Jb (main:149165:98)
    at Ib (main:149157:145)
    at W (main:149162:89)
    at Jb (main:149165:98)
    at Ib (main:149157:145)


Error: Unexpected: cant find current sidebar in context
Error: Unexpected: cant find current sidebar in context
[ERROR] Unable to build website for locale en.
[ERROR] Error: Failed to compile with errors.
    at /Users/thomas/projects/work/unleash/website/node_modules/@docusaurus/core/lib/webpack/utils.js:180:24
    at /Users/thomas/projects/work/unleash/website/node_modules/webpack/lib/MultiCompiler.js:554:14
    at processQueueWorker (/Users/thomas/projects/work/unleash/website/node_modules/webpack/lib/MultiCompiler.js:491:6)
    at processTicksAndRejections (node:internal/process/task_queues:78:11)
[INFO] Docusaurus version: 2.2.0
Node version: v16.14.0
error Command failed with exit code 1.
```

That's better, but it's still not very clear.

## Getting more info

We've had problems with a similar error message before. Last time it was
caused by an empty file that docusaurus couldn't process.

A similar issue has also been described in [ this docusaurus GitHub
issue ](https://github.com/facebook/docusaurus/issues/7686). That's also
what gave me the idea of changing the logging in the dependency.

I'm currently unsure whether this is caused by the openapi docs or
something else. I've been in touch with the [openapi plugin
maintainer](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/323)
and he has been able to see the same error when building for prod
locally, but it was due to some old generated files.

Worth noting: this only seems to affect the prod build. Building for dev
(`yarn docusaurus start`) works just fine. It also fails locally **and**
in CI, so it _is_ an issue.

## Updating the logging
To get better logging, you can go into the
`/node_modules/@docusaurus/core/lib/client/serverEntry.js` file and
update the `render` function from

```js
export default async function render(locals) {
    try {
        return await doRender(locals);
    }
    catch (err) {
        // We are not using logger in this file, because it seems to fail with some
        // compilers / some polyfill methods. This is very likely a bug, but in the
        // long term, when we output native ES modules in SSR, the bug will be gone.
        // prettier-ignore
        console.error(chalk.red(`${chalk.bold('[ERROR]')} Docusaurus server-side rendering could not render static page with path ${chalk.cyan.underline(locals.path)}.`));
        const isNotDefinedErrorRegex = /(?:window|document|localStorage|navigator|alert|location|buffer|self) is not defined/i;
        if (isNotDefinedErrorRegex.test(err.message)) {
            // prettier-ignore
            console.info(`${chalk.cyan.bold('[INFO]')} It looks like you are using code that should run on the client-side only.
To get around it, try using ${chalk.cyan('`<BrowserOnly>`')} (${chalk.cyan.underline('https://docusaurus.io/docs/docusaurus-core/#browseronly')}) or ${chalk.cyan('`ExecutionEnvironment`')} (${chalk.cyan.underline('https://docusaurus.io/docs/docusaurus-core/#executionenvironment')}).
It might also require to wrap your client code in ${chalk.cyan('`useEffect`')} hook and/or import a third-party library dynamically (if any).`);
        }
        throw err;
    }
}
```

to

```js
export default async function render(locals) {
    try {
        return await doRender(locals);
    }
    catch (err) {
        console.error(err)
        throw err;
    }
}
```

That'll yield the errors about the current sidebar in context.


## Root cause

Found the issue! 🙋🏼 It's explained in [this comment on the openapi docs
integration](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/323#issuecomment-1311549864)
for now, but in short: we have tags defined that we don't use. They're
being picked up by docusaurus, but don't have the proper context. That's
causing this.

The previously mentioned comment is included here for easy finding in
the future:

### Root cause explanation

The OpenAPI spec we use to generate the docs has a number of tags listed
at the root level. This is necessary for this plugin to pick up tag
categories and is, as far as I can tell, also how it _should_ be done.

However, not all of those tags are in use. Specifically, there's 2 tags
that are not.

When the plugin generates docs from the spec, it generates pages for all
endpoints and all tags and groups them by tag. However, it seems likely
that if a tag doesn't have any associated endpoints, then it won't get
added to the sidebar because there's no endpoint that references it.

But the doc files for these tags do end up lying around in the directory
regardless, and when docusaurus tries to pick up the files in the
generated directory, it also tries to pick up the unused tag files. But
because they're not part of a sidebar, they end up throwing errors
because they can't find the sidebar context.

### How I found it

The fact that I got more instances of the error message without the
sidebar ref than with it made me pay more attention to the number of
errors. I decided to check how many files were in the generated
directory and how many files were referenced from the generated sidebar.
Turns out the difference there was **2**: there were two generated files
in the directory that the sidebar didn't reference.

At this point, it was easy enough to try and delete those files before
rebuilding, and wouldn't you know: it worked!

### Our use case

Now, why do we have tags that are unused in the root spec? Can't we just
remove them?

That's a good question with a bit of a complicated answer. Unleash uses
an open core model and the OpenAPI integration is part of that open
core. The closed-source parts of Unleash are located in another repo and
extend the open-source distribution.

Because the OpenAPI spec is configured in the open-source part,
enterprise-only tags etc also need to be configured there. Then, when
the changes are absorbed into enterprise, we can use the tags there.

It gets more complicated because we use an enterprise instance to
generate the docs (because we want enterprise-endpoints to be listed
too). The instance uses the latest released instance of Unleash to have
the docs most accurately reflect the current state of things.

So, in this case, the tags have been added, but not yet used by any
endpoints, which suddenly causes this build failure. We can add the tags
to the enterprise-version, but the spec wouldn't be updated before the
next release regardless, which will probably be in a week or so.

This isn't an ideal setup, but .. it is what it is.

## Solutions and workarounds

As mentioned in the previous section, the reason the build was failing
was that there were unused tag files that docusaurus tried to include in
the build. Because they don't belong to a sidebar, the compilation
failed.

I've reported the issue to the openapi plugin maintainers and am waiting
for a response.

However, it seems that having unused root tags declared is invalid
according to the spec, so it's something we should look into fixing in
the future.

### Current workaround: cleaning script

The current workaround is to extend the api cleaning script to manually
remove the unused tag files.

### Ideal solution: filter root-level tags

Ideally, we shouldn't list unused OpenAPI tags on the root level at all.
However, because of the way we add root-level tags (as a predefined,
static lists, refer to `src/lib/openapi/index.ts`) and endpoints
(dynamically added at runtime) today, we don't really have a clear way
to filter the list of tags. This gets even more complicated when taking
the enterprise functionality and the potential extra tags they must
have.

This is, however, something that should definitely be looked into.
Working with OpenAPI across multipile repos is already troublesome, so
this is just yet another thing to look into.
 2022-11-11 15:01:54 +02:00
Thomas Heartman
665638b9da
fix: Fix broken OpenAPI (#2379) 
## What

This change removes the use of double quotes in the
'addPublicSignupTokenUser' endpoint summary. It also changes the
original summary to a description and adds a new, shorter summary.

## Why

The OpenAPI / docusaurus integration errors out (refer to [this failed
build](https://github.com/Unleash/unleash/actions/runs/3434792557/jobs/5726445104))
if the frontmatter contains invalid characters. In this case, it's
because the automatic sidebar label contains double quotes, which it
interprets as a new key having been declared:

```
Error:  Error while parsing Markdown front matter.
This can happen if you use special characters in front matter values (try using double quotes around that value).
Error:  Loading of version failed for version current
Error:  Unable to build website for locale en.
Error:  YAMLException: can not read a block mapping entry; a multiline key may not be an implicit key at line 4, column 12:
    description: "Create a user with the 'viewe ...
               ^
```

For some reason, I cannot reproduce this error locally. Instead, the
generation goes as expected.

---

Regarding using description instead of summary: summaries should be very
short and sweet, especially because they're also used in the generated
sidebar. Descriptions can be a bit wordier, so I added a shorter summary
for going forward.

## Generated output

This is what the old configuration would generate. Notice the
`sidedar_label` key on line 2:

```md
---
id: add-public-signup-token-user
sidebar_label: Create a user with the "viewer" root role and link them to a signup token
hide_title: true
hide_table_of_contents: true
api: {'tags': ['Public signup tokens'], 'operationId': 'addPublicSignupTokenUser', 'requestBody': {'description': 'createInvitedUserSchema', 'required': true, 'content': {'application/json': {'schema': {'type': 'object', 'additionalProperties': false, 'required': ['email', 'name', 'password'], 'properties': {'username': { 'type': 'string' }, 'email': { 'type': 'string' }, 'name': { 'type': 'string' }, 'password': { 'type': 'string' },},},},},}, 'responses': {'200': {'description': 'userSchema', 'content': {'application/json': {'schema': {'type': 'object', 'additionalProperties': false, 'required': ['id'], 'properties': {'id': {'type': 'number',}, 'isAPI': {'type': 'boolean',}, 'name': {'type': 'string',}, 'email': {'type': 'string',}, 'username': {'type': 'string',}, 'imageUrl': {'type': 'string',}, 'inviteLink': {'type': 'string',}, 'loginAttempts': {'type': 'number',}, 'emailSent': {'type': 'boolean',}, 'rootRole': {'type': 'number',}, 'seenAt': {'type': 'string', 'format': 'date-time', 'nullable': true,}, 'createdAt': {'type': 'string', 'format': 'date-time',},},},},},}, '400': {'description': 'The request data does not match what we expect.',}, '409': {'description': 'The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.',},}, 'parameters': [{'name': 'token', 'in': 'path', 'required': true, 'schema': { 'type': 'string' },},], 'description': 'Create a user with the "viewer" root role and link them to a signup token', 'method': 'post', 'path': '/invite/{token}/signup', 'servers': [{ 'url': '<your-unleash-url>' }], 'security': [{ 'apiKey': [] }], 'securitySchemes': {'apiKey': {'type': 'apiKey', 'in': 'header', 'name': 'Authorization',},}, 'jsonRequestBodyExample': {'username': 'string', 'email': 'string', 'name': 'string', 'password': 'string',}, 'info': { 'title': 'Unleash API', 'version': '4.17.2' }, 'postman': {'name': 'Create a user with the "viewer" root role and link them to a signup token', 'description': { 'type': 'text/plain' }, 'url': {'path': ['invite', ':token', 'signup'], 'host': ['{{baseUrl}}'], 'query': [], 'variable': [{'disabled': false, 'description': {'content': '(Required) ', 'type': 'text/plain',}, 'type': 'any', 'value': '', 'key': 'token',},],}, 'header': [{ 'key': 'Content-Type', 'value': 'application/json' }, { 'key': 'Accept', 'value': 'application/json' },], 'method': 'POST', 'body': {'mode': 'raw', 'raw': '""', 'options': { 'raw': { 'language': 'json' } }}}}
sidebar_class_name: 'post api-method'
info_path: docs/reference/api/unleash/unleash-api
---

import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem" import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem";

## Create a user with the &quot;viewer&quot; root role and link them to a signup token

Create a user with the &quot;viewer&quot; root role and link them to a signup token

<!-- And much much more! -->
```
 2022-11-10 22:55:01 +01:00
renovate[bot]
7207f1b572
chore(deps): update dependency minimatch to v5 (#2400) 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [minimatch](https://togithub.com/isaacs/minimatch) | [`^3.0.5` ->
`^5.0.0`](https://renovatebot.com/diffs/npm/minimatch/3.1.2/5.1.0) |
[![age](https://badges.renovateapi.com/packages/npm/minimatch/5.1.0/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/npm/minimatch/5.1.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/npm/minimatch/5.1.0/compatibility-slim/3.1.2)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/npm/minimatch/5.1.0/confidence-slim/3.1.2)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>isaacs/minimatch</summary>

###
[`v5.1.0`](https://togithub.com/isaacs/minimatch/compare/v5.0.1...v5.1.0)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v5.0.1...v5.1.0)

###
[`v5.0.1`](https://togithub.com/isaacs/minimatch/compare/v5.0.0...v5.0.1)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v5.0.0...v5.0.1)

###
[`v5.0.0`](https://togithub.com/isaacs/minimatch/compare/v4.2.1...v5.0.0)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v4.2.1...v5.0.0)

###
[`v4.2.1`](https://togithub.com/isaacs/minimatch/compare/v4.2.0...v4.2.1)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v4.2.0...v4.2.1)

###
[`v4.2.0`](https://togithub.com/isaacs/minimatch/compare/v4.1.1...v4.2.0)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v4.1.1...v4.2.0)

###
[`v4.1.1`](https://togithub.com/isaacs/minimatch/compare/v4.1.0...v4.1.1)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v4.1.0...v4.1.1)

###
[`v4.1.0`](https://togithub.com/isaacs/minimatch/compare/v4.0.0...v4.1.0)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v4.0.0...v4.1.0)

###
[`v4.0.0`](https://togithub.com/isaacs/minimatch/compare/v3.1.2...v4.0.0)

[Compare
Source](https://togithub.com/isaacs/minimatch/compare/v3.1.2...v4.0.0)

</details>

---

### Configuration

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

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **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:eyJjcmVhdGVkSW5WZXIiOiIzNC4yMS42IiwidXBkYXRlZEluVmVyIjoiMzQuMjEuNiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
 2022-11-10 21:36:46 +00:00