chore: licence compliance for published artifacts

README.md

@@ -1,117 +1,43 @@
-# <img src="https://raw.githubusercontent.com/swagger-api/swagger.io/wordpress/images/assets/SWU-logo-clr.png" width="300">
-
-[![NPM version](https://badge.fury.io/js/swagger-ui.svg)](http://badge.fury.io/js/swagger-ui)
-[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20JavaScript/job/oss-swagger-ui-master/badge/icon?subject=jenkins%20build)](https://jenkins.swagger.io/view/OSS%20-%20JavaScript/job/oss-swagger-ui-master/)
-[![npm audit](https://jenkins.swagger.io/buildStatus/icon?job=oss-swagger-ui-security-audit&subject=npm%20audit)](https://jenkins.swagger.io/job/oss-swagger-ui-security-audit/lastBuild/console)
-![total GitHub contributors](https://img.shields.io/github/contributors-anon/swagger-api/swagger-ui.svg)
-
-![monthly npm installs](https://img.shields.io/npm/dm/swagger-ui.svg?label=npm%20downloads)
-![docker registry](https://img.shields.io/badge/docker-docker.swagger.io%2Fswaggerapi%2Fswagger--ui-blue)
-![monthly packagist installs](https://img.shields.io/packagist/dm/swagger-api/swagger-ui.svg?label=packagist%20installs)
-![gzip size](https://img.shields.io/bundlephobia/minzip/swagger-ui.svg?label=gzip%20size)
-
-## Introduction
-[Swagger UI](https://swagger.io/tools/swagger-ui/) allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from your OpenAPI (formerly known as Swagger) Specification, with the visual documentation making it easy for back end implementation and client side consumption.
-
-## General
-**👉🏼 Want to score an easy open-source contribution?** Check out our [Good first issue](https://github.com/swagger-api/swagger-ui/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%22) label.
-
-**🕰️ Looking for the older version of Swagger UI?** Refer to the [*2.x* branch](https://github.com/swagger-api/swagger-ui/tree/2.x).
-
-
-This repository publishes three different NPM modules:
-
-* [swagger-ui](https://www.npmjs.com/package/swagger-ui) is a traditional npm module intended for use in single-page applications that are capable of resolving dependencies (via Webpack, Browserify, etc.).
-* [swagger-ui-dist](https://www.npmjs.com/package/swagger-ui-dist) is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies.
-* [swagger-ui-react](https://www.npmjs.com/package/swagger-ui-react) is Swagger UI packaged as a React component for use in React applications.
-
-We strongly suggest that you use `swagger-ui` instead of `swagger-ui-dist` if you're building a single-page application, since `swagger-ui-dist` is significantly larger.
-
-If you are looking for plain ol' HTML/JS/CSS, [download the latest release](https://github.com/swagger-api/swagger-ui/releases/latest) and copy the contents of the `/dist` folder to your server.
-
-
-## Compatibility
-The OpenAPI Specification has undergone 5 revisions since initial creation in 2010.  Compatibility between Swagger UI and the OpenAPI Specification is as follows:
-
-| Swagger UI Version | Release Date | OpenAPI Spec compatibility                           | Notes                                                                 |
-|--------------------|--------------|------------------------------------------------------|-----------------------------------------------------------------------|
-| 5.19.0             | 2025-02-17   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1 | [tag v5.19.0](https://github.com/swagger-api/swagger-ui/tree/v5.19.0) |
-| 5.0.0              | 2023-06-12   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0               | [tag v5.0.0](https://github.com/swagger-api/swagger-ui/tree/v5.0.0)   |
-| 4.0.0              | 2021-11-03   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3                      | [tag v4.0.0](https://github.com/swagger-api/swagger-ui/tree/v4.0.0)   |
-| 3.18.3             | 2018-08-03   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3                      | [tag v3.18.3](https://github.com/swagger-api/swagger-ui/tree/v3.18.3) |
-| 3.0.21             | 2017-07-26   | 2.0                                                  | [tag v3.0.21](https://github.com/swagger-api/swagger-ui/tree/v3.0.21) |
-| 2.2.10             | 2017-01-04   | 1.1, 1.2, 2.0                                        | [tag v2.2.10](https://github.com/swagger-api/swagger-ui/tree/v2.2.10) |
-| 2.1.5              | 2016-07-20   | 1.1, 1.2, 2.0                                        | [tag v2.1.5](https://github.com/swagger-api/swagger-ui/tree/v2.1.5)   |
-| 2.0.24             | 2014-09-12   | 1.1, 1.2                                             | [tag v2.0.24](https://github.com/swagger-api/swagger-ui/tree/v2.0.24) |
-| 1.0.13             | 2013-03-08   | 1.1, 1.2                                             | [tag v1.0.13](https://github.com/swagger-api/swagger-ui/tree/v1.0.13) |
-| 1.0.1              | 2011-10-11   | 1.0, 1.1                                             | [tag v1.0.1](https://github.com/swagger-api/swagger-ui/tree/v1.0.1)   |
-
-## Anonymized analytics
-
-SwaggerUI uses [Scarf](https://scarf.sh/) to collect [anonymized installation analytics](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-what-information-does-scarf-js-send-about-me). These analytics help support the maintainers of this library and ONLY run during installation. To [opt out](https://github.com/scarf-sh/scarf-js?tab=readme-ov-file#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics), you can set the `scarfSettings.enabled` field to `false` in your project's `package.json`:
-
-```
-// package.json
-{
-  // ...
-  "scarfSettings": {
-    "enabled": false
-  }
-  // ...
-}
-```
-
-Alternatively, you can set the environment variable `SCARF_ANALYTICS` to `false` as part of the environment that installs your npm packages, e.g., `SCARF_ANALYTICS=false npm install`.
-
-## Documentation
-
-#### Usage
-- [Installation](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/installation.md)
-- [Configuration](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration.md)
-- [CORS](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/cors.md)
-- [OAuth2](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/oauth2.md)
-- [Deep Linking](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/deep-linking.md)
-- [Limitations](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/limitations.md)
-- [Version detection](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/version-detection.md)
-
-#### Customization
-- [Overview](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/overview.md)
-- [Plugin API](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/plugin-api.md)
-- [Custom layout](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/customization/custom-layout.md)
-
-#### Development
-- [Setting up](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/development/setting-up.md)
-- [Scripts](https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/development/scripts.md)
-
-#### Contributing
-- [Contributing](https://github.com/swagger-api/.github/blob/HEAD/CONTRIBUTING.md)
-
-##### Integration Tests
-
-You will need JDK of version 7 or higher as instructed here
-https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server
-
-Integration tests can be run locally with `npm run e2e` - be sure you aren't running a dev server when testing!
-
-### Browser support
-Swagger UI works in the latest versions of Chrome, Safari, Firefox, and Edge.
-
-### Known Issues
-
-To help with the migration, here are the currently known issues with 3.X. This list will update regularly, and will not include features that were not implemented in previous versions.
-
-- Only part of the parameters previously supported are available.
-- The JSON Form Editor is not implemented.
-- Support for `collectionFormat` is partial.
-- l10n (translations) is not implemented.
-- Relative path support for external files is not implemented.
-
-## Security contact
-
-Please disclose any security-related issues or vulnerabilities by emailing [security@swagger.io](mailto:security@swagger.io), instead of using the public issue tracker.
+# Swagger UI
+
+[Swagger UI](https://swagger.io/tools/swagger-ui/) allows anyone — be it your
+development team or your end consumers — to visualize and interact with the
+API's resources without having any of the implementation logic in place.
+
+This repository is the ThingsBoard-maintained fork of
+[swagger-api/swagger-ui](https://github.com/swagger-api/swagger-ui), consumed
+by the
+[ThingsBoard fork of springdoc-openapi](https://github.com/thingsboard/springdoc-openapi)
+as a GitHub archive of a `TB`-suffixed tag when packaging the
+`springdoc-swagger-ui` webjar. The fork differs from the upstream 5.21.0
+release as follows:
+
++ A new ThingsBoard-authored `HttpLoginAuth` plugin
+  (`src/core/plugins/http-login-auth/`) adds a username/password login
+  authorization scheme that obtains a JWT token and applies it to requests;
+  it is registered in `src/core/index.js` and enabled in
+  `dist/swagger-initializer.js`.
++ `src/core/components/responses.jsx`, `src/core/components/live-response.jsx`
+  and `src/style/_layout.scss` rework how the live response to a "Try it out"
+  request is presented. The modified files carry their own modification
+  notices.
++ `package.json` and `package-lock.json` set the version to the fork's
+  `TB`-suffixed form.
++ The `dist` bundles are rebuilt from this fork's sources.
++ `dist/swagger-ui-bundle.js.map`, `dist/swagger-ui-es-bundle.js.map` and
+  `dist/swagger-ui-standalone-preset.js.map` are deleted. The fork's build
+  does not generate source maps for these three bundles, none of the bundles
+  references a map, and the committed files were stale leftovers from an
+  earlier release that no longer described the bundles next to them.
+
+The list above serves as the modification notice required by section 4(b) of
+the Apache License 2.0 for the changed files that cannot carry an in-file
+notice, such as the JSON manifests and the regenerated bundles.
 
 ## License
 
-SwaggerUI is licensed under [Apache 2.0 license](https://github.com/swagger-api/swagger-ui/blob/master/LICENSE).
-SwaggerUI comes with an explicit [NOTICE](https://github.com/swagger-api/swagger-ui/blob/master/NOTICE) file
-containing additional legal notices and information.
+Swagger UI is licensed under the Apache License, Version 2.0. See
+[LICENSE](LICENSE) for the full license text.
+
+The attribution notices of the original work are preserved in the
+[NOTICE](NOTICE) file.

dist/swagger-initializer.js

@@ -1,3 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: Modifications Copyright (C) 2024-present ThingsBoard, Inc.
+ * This file has been modified from the original swagger-ui source.
+ * See the project's Git history for details of the changes.
+ */
 window.onload = function() {
   //<editor-fold desc="Changeable Configuration Block">
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-ui",
-  "version": "5.21.0TB",
+  "version": "5.21.0TB2",
   "main": "./dist/swagger-ui.js",
   "module": "./dist/swagger-ui-es-bundle-core.js",
   "exports": {

src/core/components/live-response.jsx

@@ -1,3 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: Modifications Copyright (C) 2024-present ThingsBoard, Inc.
+ * This file has been modified from the original swagger-ui source.
+ * See the project's Git history for details of the changes.
+ */
 import React from "react"
 import PropTypes from "prop-types"
 import ImPropTypes from "react-immutable-proptypes"

src/core/components/responses.jsx

@@ -1,3 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: Modifications Copyright (C) 2024-present ThingsBoard, Inc.
+ * This file has been modified from the original swagger-ui source.
+ * See the project's Git history for details of the changes.
+ */
 import React from "react"
 import { fromJS, Iterable } from "immutable"
 import PropTypes from "prop-types"

src/core/index.js

@@ -1,6 +1,11 @@
 /**
  * @prettier
  */
+/*
+ * SPDX-FileCopyrightText: Modifications Copyright (C) 2024-present ThingsBoard, Inc.
+ * This file has been modified from the original swagger-ui source.
+ * See the project's Git history for details of the changes.
+ */
 import System from "./system"
 // presets
 import BasePreset from "./presets/base"

src/core/plugins/http-login-auth/actions.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 export const AUTHORIZE_HTTP_JWT_TOKEN = "authorize_http_jwt_token"
 
 export const authorizeHttpJwtToken = (payload) => {

src/core/plugins/http-login-auth/auth-extensions/wrap-actions.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { fromJS } from "immutable"
 
 export const authorizeWithPersistOption = (oriAction, { authActions }) => {

src/core/plugins/http-login-auth/components/index.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import LoginPasswordAuth from "./login-password-auth.jsx"
 
 export default {

src/core/plugins/http-login-auth/components/login-password-auth.jsx

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import React from "react"
 import PropTypes from "prop-types"
 import { parseJwt } from "../helpers.jsx"

src/core/plugins/http-login-auth/execute.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import _objectSpread from "@babel/runtime-corejs3/helpers/objectSpread2";
 import _objectWithoutProperties from "@babel/runtime-corejs3/helpers/objectWithoutProperties";
 import stockHttp from "swagger-client/es/http";

src/core/plugins/http-login-auth/helpers.jsx

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import React from "react"
 
 export const isOAS3 = (jsSpec) => {

src/core/plugins/http-login-auth/index.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import components from "./components"
 import wrapComponents from "./wrap-components"
 import * as authWrapActions from "./auth-extensions/wrap-actions"

src/core/plugins/http-login-auth/reducers.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { Map } from "immutable"
 
 import { AUTHORIZE_HTTP_JWT_TOKEN } from "./actions";

src/core/plugins/http-login-auth/spec-extensions/wrap-actions.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import { fromJS, Map } from "immutable"
 import { parseJwt } from "../helpers.jsx";
 

src/core/plugins/http-login-auth/wrap-components/auth-item.jsx

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import React from "react"
 import { ComponentWrapFactory } from "../helpers.jsx"
 

src/core/plugins/http-login-auth/wrap-components/index.js

@@ -1,3 +1,7 @@
+/*
+ * SPDX-FileCopyrightText: Copyright 2024 ThingsBoard, Inc.
+ * SPDX-License-Identifier: Apache-2.0
+ */
 import AuthItem from "./auth-item.jsx"
 
 export default {

src/style/_layout.scss

@@ -1,3 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: Modifications Copyright (C) 2024-present ThingsBoard, Inc.
+ * This file has been modified from the original swagger-ui source.
+ * See the project's Git history for details of the changes.
+ */
 @use "sass:meta";
 @use "variables" as *;
 @use "type";