Skip to content

Commit 8822a72

Browse files
hkosovawebron
authored andcommitted
Change Swagger-UI -> Swagger UI in docs (swagger-api#5479)
* Change Swagger-UI -> Swagger UI in docs * Changed back to SwaggerUI in places that refer to JS construct
1 parent be5e057 commit 8822a72

15 files changed

+77
-77
lines changed

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Swagger-UI
1+
# Swagger UI
22

3-
Welcome to the Swagger-UI documentation!
3+
Welcome to the Swagger UI documentation!
44

55
A table of contents can be found at `SUMMARY.md`.

docs/book.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"title": "Swagger-UI"
2+
"title": "Swagger UI"
33
}

docs/customization/custom-layout.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Creating a custom layout
22

3-
**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.
3+
**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.
44

5-
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.
5+
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.
66

77
<br>
88

docs/customization/overview.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Prior art
44

5-
Swagger-UI leans heavily on concepts and patterns found in React and Redux.
5+
Swagger UI leans heavily on concepts and patterns found in React and Redux.
66

77
If you aren't already familiar, here's some suggested reading:
88

@@ -17,7 +17,7 @@ In the following documentation, we won't take the time to define the fundamental
1717
1818
### The System
1919

20-
The _system_ is the heart of the Swagger-UI application. At runtime, it's a JavaScript object that holds many things:
20+
The _system_ is the heart of the Swagger UI application. At runtime, it's a JavaScript object that holds many things:
2121

2222
- React components
2323
- 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
2727
- References to the React and Immutable.js libraries (`system.React`, `system.Im`)
2828
- User-defined helper functions
2929

30-
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.
30+
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.
3131

3232
### Presets
3333

34-
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:
34+
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:
3535

3636
```javascript
3737
const MyPreset = [FirstPlugin, SecondPlugin, ThirdPlugin]
@@ -43,7 +43,7 @@ SwaggerUI({
4343
})
4444
```
4545

46-
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:
46+
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:
4747

4848
```javascript
4949
SwaggerUI({
@@ -54,15 +54,15 @@ SwaggerUI({
5454
})
5555
```
5656

57-
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.
57+
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.
5858

5959
### getComponent
6060

6161
`getComponent` is a helper function injected into every container component, which is used to get references to components provided by the plugin system.
6262

6363
All components should be loaded through `getComponent`, since it allows other plugins to modify the component. It is preferred over a conventional `import` statement.
6464

65-
Container components in Swagger-UI can be loaded by passing `true` as the second argument to `getComponent`, like so:
65+
Container components in Swagger UI can be loaded by passing `true` as the second argument to `getComponent`, like so:
6666

6767
```javascript
6868
getComponent("ContainerComponentName", true)

docs/customization/plug-points.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# Plug points
22

3-
Swagger-UI exposes most of its internal logic through the plugin system.
3+
Swagger UI exposes most of its internal logic through the plugin system.
44

55
Often, it is beneficial to override the core internals to achieve custom behavior.
66

77
### Note: Semantic Versioning
88

9-
Swagger-UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing.
9+
Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing.
1010

11-
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.
11+
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.
1212

13-
If you're installing Swagger-UI via NPM, for example, you can do this by using a tilde:
13+
If you're installing Swagger UI via NPM, for example, you can do this by using a tilde:
1414

1515
```js
1616
{

docs/customization/plugin-api.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Plugins
22

3-
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.
3+
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.
44

55
### Note: Semantic Versioning
66

7-
Swagger-UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing.
7+
Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing.
88

9-
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.
9+
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.
1010

11-
If you're installing Swagger-UI via NPM, for example, you can do this by using a tilde:
11+
If you're installing Swagger UI via NPM, for example, you can do this by using a tilde:
1212

1313
```js
1414
{
@@ -96,7 +96,7 @@ Once an action has been defined, you can use it anywhere that you can get a syst
9696
system.exampleActions.updateFavoriteColor("blue")
9797
```
9898

99-
The Action interface enables the creation of new Redux action creators within a piece of state in the Swagger-UI system.
99+
The Action interface enables the creation of new Redux action creators within a piece of state in the Swagger UI system.
100100

101101
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.
102102

@@ -225,7 +225,7 @@ A Wrap Action's first argument is `oriAction`, which is the action being wrapped
225225
This mechanism is useful for conditionally overriding built-in behaviors, or listening to actions.
226226

227227
```javascript
228-
// FYI: in an actual Swagger-UI, `updateSpec` is already defined in the core code
228+
// FYI: in an actual Swagger UI, `updateSpec` is already defined in the core code
229229
// it's just here for clarity on what's behind the scenes
230230
const MySpecPlugin = function(system) {
231231
return {
@@ -251,9 +251,9 @@ const MyWrapActionPlugin = function(system) {
251251
spec: {
252252
wrapActions: {
253253
updateSpec: (oriAction, system) => (str) => {
254-
// here, you can hand the value to some function that exists outside of Swagger-UI
254+
// here, you can hand the value to some function that exists outside of Swagger UI
255255
console.log("Here is my API definition", str)
256-
return oriAction(str) // don't forget! otherwise, Swagger-UI won't update
256+
return oriAction(str) // don't forget! otherwise, Swagger UI won't update
257257
}
258258
}
259259
}
@@ -273,7 +273,7 @@ This interface is useful for controlling what data flows into components. We use
273273
```javascript
274274
import { createSelector } from 'reselect'
275275

276-
// FYI: in an actual Swagger-UI, the `url` spec selector is already defined
276+
// FYI: in an actual Swagger UI, the `url` spec selector is already defined
277277
// it's just here for clarity on what's behind the scenes
278278
const MySpecPlugin = function(system) {
279279
return {

docs/development/scripts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Any of the scripts below can be run by typing `npm run <script name>` in the pro
66
Script name | Description
77
--- | ---
88
`dev` | Spawn a hot-reloading dev server on port 3200.
9-
`deps-check` | Generate a size and licensing report on Swagger-UI's dependencies.
9+
`deps-check` | Generate a size and licensing report on Swagger UI's dependencies.
1010
`lint` | Report ESLint style errors and warnings.
1111
`lint-errors` | Report ESLint style errors, without warnings.
1212
`lint-fix` | Attempt to fix style errors automatically.
13-
`watch` | Rebuild the core files in `/dist` when the source code changes. Useful for `npm link` with Swagger-Editor.
13+
`watch` | Rebuild the core files in `/dist` when the source code changes. Useful for `npm link` with Swagger Editor.
1414

1515
### Building
1616
Script name | Description

docs/development/setting-up.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Setting up a dev environment
22

3-
Swagger-UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
3+
Swagger UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.
44

55
### Prerequisites
66

@@ -20,5 +20,5 @@ Swagger-UI includes a development server that provides hot module reloading and
2020

2121
## Bonus points
2222

23-
- Swagger-UI includes an ESLint rule definition. If you use a graphical editor, consider installing an ESLint plugin, which will point out syntax and style errors for you as you code.
23+
- Swagger UI includes an ESLint rule definition. If you use a graphical editor, consider installing an ESLint plugin, which will point out syntax and style errors for you as you code.
2424
- The linter runs as part of the PR test sequence, so don't think you can get away with not paying attention to it!

0 commit comments

Comments
 (0)