From 8822a7229ae756e57c7149b37672de4ad7757f27 Mon Sep 17 00:00:00 2001 From: Helen Kosova Date: Fri, 19 Jul 2019 18:22:45 +0300 Subject: [PATCH] Change Swagger-UI -> Swagger UI in docs (#5479) * Change Swagger-UI -> Swagger UI in docs * Changed back to SwaggerUI in places that refer to JS construct --- docs/README.md | 4 ++-- docs/book.json | 2 +- docs/customization/custom-layout.md | 4 ++-- docs/customization/overview.md | 14 +++++------ docs/customization/plug-points.md | 8 +++---- docs/customization/plugin-api.md | 18 +++++++-------- docs/development/scripts.md | 4 ++-- docs/development/setting-up.md | 4 ++-- docs/usage/configuration.md | 36 ++++++++++++++--------------- docs/usage/cors.md | 12 +++++----- docs/usage/deep-linking.md | 14 +++++------ docs/usage/installation.md | 8 +++---- docs/usage/limitations.md | 2 +- docs/usage/oauth2.md | 4 ++-- docs/usage/version-detection.md | 20 ++++++++-------- 15 files changed, 77 insertions(+), 77 deletions(-) diff --git a/docs/README.md b/docs/README.md index 13d8028f..ab0cae8c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ -# Swagger-UI +# Swagger UI -Welcome to the Swagger-UI documentation! +Welcome to the Swagger UI documentation! A table of contents can be found at `SUMMARY.md`. diff --git a/docs/book.json b/docs/book.json index f5a5c8fe..3536cdff 100644 --- a/docs/book.json +++ b/docs/book.json @@ -1,3 +1,3 @@ { - "title": "Swagger-UI" + "title": "Swagger UI" } diff --git a/docs/customization/custom-layout.md b/docs/customization/custom-layout.md index e0214ce3..f30b7729 100644 --- a/docs/customization/custom-layout.md +++ b/docs/customization/custom-layout.md @@ -1,8 +1,8 @@ # Creating a custom layout -**Layouts** are a special type of component that Swagger-UI uses as the root component for the entire application. You can define custom layouts in order to have high-level control over what ends up on the page. +**Layouts** are a special type of component that Swagger UI uses as the root component for the entire application. You can define custom layouts in order to have high-level control over what ends up on the page. -By default, Swagger-UI uses `BaseLayout`, which is built into the application. You can specify a different layout to be used by passing the layout's name as the `layout` parameter to Swagger-UI. Be sure to provide your custom layout as a component to Swagger-UI. +By default, Swagger UI uses `BaseLayout`, which is built into the application. You can specify a different layout to be used by passing the layout's name as the `layout` parameter to Swagger UI. Be sure to provide your custom layout as a component to Swagger UI.
diff --git a/docs/customization/overview.md b/docs/customization/overview.md index c64f0c0c..1d97daa3 100644 --- a/docs/customization/overview.md +++ b/docs/customization/overview.md @@ -2,7 +2,7 @@ ### Prior art -Swagger-UI leans heavily on concepts and patterns found in React and Redux. +Swagger UI leans heavily on concepts and patterns found in React and Redux. If you aren't already familiar, here's some suggested reading: @@ -17,7 +17,7 @@ In the following documentation, we won't take the time to define the fundamental ### The System -The _system_ is the heart of the Swagger-UI application. At runtime, it's a JavaScript object that holds many things: +The _system_ is the heart of the Swagger UI application. At runtime, it's a JavaScript object that holds many things: - React components - Bound Redux actions and reducers @@ -27,11 +27,11 @@ The _system_ is the heart of the Swagger-UI application. At runtime, it's a Java - References to the React and Immutable.js libraries (`system.React`, `system.Im`) - User-defined helper functions -The system is built up when Swagger-UI is called by iterating through ("compiling") each plugin that Swagger-UI has been given, through the `presets` and `plugins` configuration options. +The system is built up when Swagger UI is called by iterating through ("compiling") each plugin that Swagger UI has been given, through the `presets` and `plugins` configuration options. ### Presets -Presets are arrays of plugins, which are provided to Swagger-UI through the `presets` configuration option. All plugins within presets are compiled before any plugins provided via the `plugins` configuration option. Consider the following example: +Presets are arrays of plugins, which are provided to Swagger UI through the `presets` configuration option. All plugins within presets are compiled before any plugins provided via the `plugins` configuration option. Consider the following example: ```javascript const MyPreset = [FirstPlugin, SecondPlugin, ThirdPlugin] @@ -43,7 +43,7 @@ SwaggerUI({ }) ``` -By default, Swagger-UI includes the internal `ApisPreset`, which contains a set of plugins that provide baseline functionality for Swagger-UI. If you specify your own `presets` option, you need to add the ApisPreset manually, like so: +By default, Swagger UI includes the internal `ApisPreset`, which contains a set of plugins that provide baseline functionality for Swagger UI. If you specify your own `presets` option, you need to add the ApisPreset manually, like so: ```javascript SwaggerUI({ @@ -54,7 +54,7 @@ SwaggerUI({ }) ``` -The need to provide the `apis` preset when adding other presets is an artifact of Swagger-UI's original design, and will likely be removed in the next major version. +The need to provide the `apis` preset when adding other presets is an artifact of Swagger UI's original design, and will likely be removed in the next major version. ### getComponent @@ -62,7 +62,7 @@ The need to provide the `apis` preset when adding other presets is an artifact o All components should be loaded through `getComponent`, since it allows other plugins to modify the component. It is preferred over a conventional `import` statement. -Container components in Swagger-UI can be loaded by passing `true` as the second argument to `getComponent`, like so: +Container components in Swagger UI can be loaded by passing `true` as the second argument to `getComponent`, like so: ```javascript getComponent("ContainerComponentName", true) diff --git a/docs/customization/plug-points.md b/docs/customization/plug-points.md index f6a99f14..20d013a1 100644 --- a/docs/customization/plug-points.md +++ b/docs/customization/plug-points.md @@ -1,16 +1,16 @@ # Plug points -Swagger-UI exposes most of its internal logic through the plugin system. +Swagger UI exposes most of its internal logic through the plugin system. Often, it is beneficial to override the core internals to achieve custom behavior. ### Note: Semantic Versioning -Swagger-UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing. +Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing. -If your custom plugins wrap, extend, override, or consume any internal core APIs, we recommend specifying a specific minor version of Swagger-UI to use in your application, because they will _not_ change between patch versions. +If your custom plugins wrap, extend, override, or consume any internal core APIs, we recommend specifying a specific minor version of Swagger UI to use in your application, because they will _not_ change between patch versions. -If you're installing Swagger-UI via NPM, for example, you can do this by using a tilde: +If you're installing Swagger UI via NPM, for example, you can do this by using a tilde: ```js { diff --git a/docs/customization/plugin-api.md b/docs/customization/plugin-api.md index 52252633..03294f7a 100644 --- a/docs/customization/plugin-api.md +++ b/docs/customization/plugin-api.md @@ -1,14 +1,14 @@ # Plugins -A plugin is a function that returns an object - more specifically, the object may contain functions and components that augment and modify Swagger-UI's functionality. +A plugin is a function that returns an object - more specifically, the object may contain functions and components that augment and modify Swagger UI's functionality. ### Note: Semantic Versioning -Swagger-UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing. +Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing. -If your custom plugins wrap, extend, override, or consume any internal core APIs, we recommend specifying a specific minor version of Swagger-UI to use in your application, because they will _not_ change between patch versions. +If your custom plugins wrap, extend, override, or consume any internal core APIs, we recommend specifying a specific minor version of Swagger UI to use in your application, because they will _not_ change between patch versions. -If you're installing Swagger-UI via NPM, for example, you can do this by using a tilde: +If you're installing Swagger UI via NPM, for example, you can do this by using a tilde: ```js { @@ -96,7 +96,7 @@ Once an action has been defined, you can use it anywhere that you can get a syst system.exampleActions.updateFavoriteColor("blue") ``` -The Action interface enables the creation of new Redux action creators within a piece of state in the Swagger-UI system. +The Action interface enables the creation of new Redux action creators within a piece of state in the Swagger UI system. This action creator function will be exposed to container components as `exampleActions.updateFavoriteColor`. When this action creator is called, the return value (which should be a [Flux Standard Action](https://github.com/acdlite/flux-standard-action)) will be passed to the `example` reducer, which we'll define in the next section. @@ -225,7 +225,7 @@ A Wrap Action's first argument is `oriAction`, which is the action being wrapped This mechanism is useful for conditionally overriding built-in behaviors, or listening to actions. ```javascript -// FYI: in an actual Swagger-UI, `updateSpec` is already defined in the core code +// FYI: in an actual Swagger UI, `updateSpec` is already defined in the core code // it's just here for clarity on what's behind the scenes const MySpecPlugin = function(system) { return { @@ -251,9 +251,9 @@ const MyWrapActionPlugin = function(system) { spec: { wrapActions: { updateSpec: (oriAction, system) => (str) => { - // here, you can hand the value to some function that exists outside of Swagger-UI + // here, you can hand the value to some function that exists outside of Swagger UI console.log("Here is my API definition", str) - return oriAction(str) // don't forget! otherwise, Swagger-UI won't update + return oriAction(str) // don't forget! otherwise, Swagger UI won't update } } } @@ -273,7 +273,7 @@ This interface is useful for controlling what data flows into components. We use ```javascript import { createSelector } from 'reselect' -// FYI: in an actual Swagger-UI, the `url` spec selector is already defined +// FYI: in an actual Swagger UI, the `url` spec selector is already defined // it's just here for clarity on what's behind the scenes const MySpecPlugin = function(system) { return { diff --git a/docs/development/scripts.md b/docs/development/scripts.md index c0edda21..031ef34d 100644 --- a/docs/development/scripts.md +++ b/docs/development/scripts.md @@ -6,11 +6,11 @@ Any of the scripts below can be run by typing `npm run diff --git a/docs/usage/limitations.md b/docs/usage/limitations.md index f618deeb..9eed4981 100644 --- a/docs/usage/limitations.md +++ b/docs/usage/limitations.md @@ -33,6 +33,6 @@ Forbidden headers include: > _[Forbidden header names (developer.mozilla.org)](https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name)_ The biggest impact of this is that OpenAPI 3.0 Cookie parameters cannot be -controlled when running Swagger-UI in a browser. +controlled when running Swagger UI in a browser. For more context, see [#3956](https://github.com/swagger-api/swagger-ui/issues/3956). diff --git a/docs/usage/oauth2.md b/docs/usage/oauth2.md index af44c66d..74fc176f 100644 --- a/docs/usage/oauth2.md +++ b/docs/usage/oauth2.md @@ -1,5 +1,5 @@ -# OAuth2 configuration -You can configure OAuth2 authorization by calling the `initOAuth` method. +# OAuth 2.0 configuration +You can configure OAuth 2.0 authorization by calling the `initOAuth` method. Property name | Docker variable | Description --- | --- | ------ diff --git a/docs/usage/version-detection.md b/docs/usage/version-detection.md index 2ef2d471..82a702f3 100644 --- a/docs/usage/version-detection.md +++ b/docs/usage/version-detection.md @@ -1,17 +1,17 @@ -# Detecting your Swagger-UI version +# Detecting your Swagger UI version -At times, you're going to need to know which version of Swagger-UI you use. +At times, you're going to need to know which version of Swagger UI you use. -The first step would be to detect which major version you currently use, as the method of detecting the version has changed. If your Swagger-UI has been heavily modified and you cannot detect from the look and feel which major version you use, you'd have to try both methods to get the exact version. +The first step would be to detect which major version you currently use, as the method of detecting the version has changed. If your Swagger UI has been heavily modified and you cannot detect from the look and feel which major version you use, you'd have to try both methods to get the exact version. To help you visually detect which version you're using, we've included supporting images. -# Swagger-UI 3.X +# Swagger UI 3.x -![Swagger-UI 3](/docs/images/swagger-ui3.png) +![Swagger UI 3](/docs/images/swagger-ui3.png) -Some distinct identifiers to Swagger-UI 3.X: +Some distinct identifiers to Swagger UI 3.x: - The API version appears as a badge next to its title. - If there are schemes or authorizations, they'd appear in a bar above the operations. - Try it out functionality is not enabled by default. @@ -27,11 +27,11 @@ If you've determined this is the version you have, to find the exact version: Note: This functionality was added in 3.0.8. If you're unable to execute it, you're likely to use an older version, and in that case the first step would be to upgrade. -# Swagger-UI 2.X and under +# Swagger UI 2.x and under -![Swagger-UI 2](/docs/images/swagger-ui2.png) +![Swagger UI 2](/docs/images/swagger-ui2.png) -Some distinct identifiers to Swagger-UI 3.X: +Some distinct identifiers to Swagger UI 3.x: - The API version appears at the bottom of the page. - Schemes are not rendered. - Authorization, if rendered, will appear next to the navigation bar. @@ -42,7 +42,7 @@ Some distinct identifiers to Swagger-UI 3.X: If you've determined this is the version you have, to find the exact version: - Navigate to the sources of the UI. Either on your disk or via the view page source functionality in your browser. - Find an open the `swagger-ui.js` -- At the top of the page, there would be a comment containing the exact version of swagger-ui. This example shows version `2.2.9`: +- At the top of the page, there would be a comment containing the exact version of Swagger UI. This example shows version `2.2.9`: ``` /**