Skip to content

Commit 9891d97

Browse files
deiningtim-lai
andauthoredAug 12, 2022
docs: fix typos and update https references (swagger-api#8154)
Co-authored-by: Tim Lai <[email protected]>
1 parent 7e65155 commit 9891d97

File tree

19 files changed

+29
-29
lines changed

19 files changed

+29
-29
lines changed
 

‎docs/customization/overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Swagger UI leans heavily on concepts and patterns found in React and Redux.
77
If you aren't already familiar, here's some suggested reading:
88

99
- [React: Quick Start (reactjs.org)](https://reactjs.org/docs/hello-world.html)
10-
- [Redux README (redux.js.org)](http://redux.js.org/)
10+
- [Redux README (redux.js.org)](https://redux.js.org/)
1111

1212
In the following documentation, we won't take the time to define the fundamentals covered in the resources above.
1313

‎docs/customization/plugin-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The Action interface enables the creation of new Redux action creators within a
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

103-
For more information about the concept of actions in Redux, see the [Redux Actions documentation](http://redux.js.org/docs/basics/Actions.html).
103+
For more information about the concept of actions in Redux, see the [Redux Actions documentation](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions).
104104

105105
#### Reducers
106106

‎docs/usage/configuration.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ Example:
369369

370370
```sh
371371
SUPPORTED_SUBMIT_METHODS="[\"get\", \"post\"]"
372-
URLS="[ { url: \"http://petstore.swagger.io/v2/swagger.json\", name: \"Petstore\" } ]"
372+
URLS="[ { url: \"https://petstore.swagger.io/v2/swagger.json\", name: \"Petstore\" } ]"
373373
```
374374

375375
##### Object variables
@@ -387,5 +387,5 @@ SPEC="{ \"openapi\": \"3.0.0\" }"
387387
#### .env file example encoding
388388
```sh
389389
SUPPORTED_SUBMIT_METHODS=['get', 'post']
390-
URLS=[ { url: 'http://petstore.swagger.io/v2/swagger.json', name: 'Petstore' } ]
390+
URLS=[ { url: 'https://petstore.swagger.io/v2/swagger.json', name: 'Petstore' } ]
391391
```

‎docs/usage/cors.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ XMLHttpRequest cannot load http://sad.server.com/v2/api-docs. No 'Access-Control
4141

4242
Swagger UI cannot easily show this error state.
4343

44-
- Use the http://www.test-cors.org website to verify CORS support. Keep in mind this will show a successful result even if `Access-Control-Allow-Headers` is not available, which is still required for Swagger UI to function properly.
44+
- Use the https://www.test-cors.org website to verify CORS support. Keep in mind this will show a successful result even if `Access-Control-Allow-Headers` is not available, which is still required for Swagger UI to function properly.
4545

4646
### Enabling CORS
4747

48-
The method of enabling CORS depends on the server and/or framework you use to host your application. http://enable-cors.org provides information on how to enable CORS in some common web servers.
48+
The method of enabling CORS depends on the server and/or framework you use to host your application. https://enable-cors.org provides information on how to enable CORS in some common web servers.
4949

5050
Other servers/frameworks may provide you information on how to enable it specifically in their use case.
5151

‎docs/usage/version-detection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ If you've determined this is the version you have, to find the exact version:
4848
/**
4949
* swagger-ui - Swagger UI is a dependency-free collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API
5050
* @version v2.2.9
51-
* @link http://swagger.io
51+
* @link https://swagger.io
5252
* @license Apache-2.0
5353
*/
5454
```

‎src/core/components/object-model.jsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ export default class ObjectModel extends Component {
103103
true
104104
</td>
105105
</tr>
106-
106+
107107
}
108108
{
109109
!(properties && properties.size) ? null : properties.entrySeq().filter(
@@ -143,7 +143,7 @@ export default class ObjectModel extends Component {
143143
}).toArray()
144144
}
145145
{
146-
// empty row befor extensions...
146+
// empty row before extensions...
147147
!showExtensions ? null : <tr><td>&nbsp;</td></tr>
148148
}
149149
{

‎src/core/plugins/oas3/helpers.jsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export function isOAS3(jsSpec) {
66
return false
77
}
88

9-
// we gate against `3.1` becasue we want to explicitly opt into supporting it
9+
// we gate against `3.1` because we want to explicitly opt into supporting it
1010
// at some point in the future -- KS, 7/2018
1111

1212
// starts with, but is not `3.0.` exactly

‎src/plugins/add-plugin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export function SomePlugin(toolbox) {
6666
getState => getState(), // This is a requirement... because we `bind` selectors, we don't want to bind to any particular state (which is an immutable value) so we bind to a function, which returns the current state
6767
state => state.get("something") // return the whatever "something" points to
6868
),
69-
foo: getState => "bar" // In the end selectors are just fuctions that we pass getState to
69+
foo: getState => "bar" // In the end selectors are just functions that we pass getState to
7070
}
7171
}
7272

‎test/e2e-cypress/static/documents/features/parameter-array-missing-items.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ paths:
99
parameters:
1010
- in: query
1111
name: basicName
12-
content:
12+
content:
1313
application/json:
1414
schema:
1515
type: object
@@ -21,4 +21,4 @@ paths:
2121
- type: integer
2222
responses:
2323
'200':
24-
description: successfull fetch
24+
description: successful fetch

‎test/e2e-cypress/tests/bugs/5660.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
const expectedValue = "nullable: true"
44

55
describe("#5660: Nullable object", () => {
6-
it("should render `nullable` marker for object ifself", () => {
6+
it("should render `nullable` marker for object itself", () => {
77
cy.visit("/?url=/documents/bugs/5660-model.yaml")
88
.get("#model-SomeObject .model-toggle")
99
.click()
1010
.get("#model-SomeObject > .model-box")
1111
.contains(expectedValue)
1212
})
13-
it("should render `nullable` marker for nexted object in property", () => {
13+
it("should render `nullable` marker for next object in property", () => {
1414
cy.visit("/?url=/documents/bugs/5660-property.yaml")
1515
.get("#model-SomeObject .model-toggle")
1616
.click()

‎test/e2e-cypress/tests/features/oas3-multiple-servers.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ describe("OpenAPI 3.0 Multiple Servers", () => {
5757
.get(".responses-wrapper .request-url")
5858
.should("contains.text", "/test-url-1")
5959
})
60-
it("should render and execute for server '/test-url-switch-1' after changing api defintion", () => {
60+
it("should render and execute for server '/test-url-switch-1' after changing api definition", () => {
6161
cy.visit(
6262
"/?url=/documents/features/oas3-multiple-servers.yaml"
6363
)

‎test/e2e-cypress/tests/features/oas3-user-edit-request-body-flows.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ describe("OAS3 Request Body user edit flows", () => {
8989
})
9090
})
9191
describe("multipart/", () => {
92-
// Case: User wants to execute operation with media-type multipart/ with a enum property. The user expects the first enum value to be used when execuded.
92+
// Case: User wants to execute operation with media-type multipart/ with a enum property. The user expects the first enum value to be used when executed.
9393
it("should use the first enum value on execute if not changed by user (#6976)", () => {
9494
// test/e2e-cypress/static/documents/features/request-body/multipart/enum.yaml
9595
getExpandedTryout(

‎test/e2e-cypress/tests/features/schema-form.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ describe("OpenAPI 3.0 Additional JsonSchemaForm in a Parameter", () => {
251251
.get(".request-url pre.microlight")
252252
.should("contain.text", "available")
253253
})
254-
it("should render the operation, modify value, and execute with modfied value", () => {
254+
it("should render the operation, modify value, and execute with modified value", () => {
255255
cy.visit("/?url=/documents/features/schema-form-core.yaml")
256256
.get("#operations-default-findPetsByStatus")
257257
.click()

‎test/e2e-cypress/tests/features/try-it-out-schema-required-override-allowed.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
describe("Try It Out: schema required properties can be overriden", () => {
1+
describe("Try It Out: schema required properties can be overridden", () => {
22
it("should execute", () => {
33
cy
44
.visit("?tryItOutEnabled=true&url=/documents/features/try-it-out-schema-required-override-allowed.yaml")

‎test/e2e-selenium/scenarios/features/allow-empty-value.openapi.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ describe("feature: OpenAPI 3 allowEmptyValue", function () {
235235
.to.contain(`GET "http://localhost:3230/emptyValueParams"`)
236236
})
237237
})
238-
describe("send empty inital value behavior", function () {
238+
describe("send empty initial value behavior", function () {
239239
it("should send an empty integer value", function (client) {
240240
const paramSelector = `tr[data-param-name="int"]`
241241

‎test/e2e-selenium/static/test-specs/bugs/4196.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ components:
6868
description: a human readable message explaining the error
6969
type: string
7070
reason:
71-
description: a functionnal key about the error
71+
description: a functional key about the error
7272
type: string
7373
responses:
7474
Unauthorized:

‎test/e2e-selenium/static/test-specs/refs/api1.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
openapi: 3.0.0
22
info:
33
description: |
4-
This is a test to show how model refererence from another file are failing.
4+
This is a test to show how model reference from another file fails.
55
This file references api2.yaml. If you load this file first in the browser it fails.
66
However, if you load api2.yaml first, then load this one it will work.
77
version: 1.0.0
88
title: API1 Test
99
paths:
10-
'/test-api-1':
10+
'/test-api-1':
1111
get:
1212
summary: Api 1
1313
responses:
@@ -29,4 +29,4 @@ components:
2929
api1prop:
3030
$ref: '#/components/schemas/Api1Prop'
3131
api2prop:
32-
$ref: 'api2.yaml#/components/schemas/Api2Prop'
32+
$ref: 'api2.yaml#/components/schemas/Api2Prop'

‎test/e2e-selenium/static/test-specs/refs/api2.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
openapi: 3.0.0
22
info:
33
description: |
4-
This is a test to show how model refererence from another file are failing.
4+
This is a test to show how model reference from another file fails.
55
This file is referenced api1.yaml. If you load api1.yaml first in the browser it fails.
66
However, if you load this file first, then load api1.yaml it will work.
77
version: 1.0.0
88
title: API2 Test
99
paths:
10-
'/test-api-2':
10+
'/test-api-2':
1111
get:
1212
summary: Api 2
1313
responses:
@@ -29,4 +29,4 @@ components:
2929
description: This is a test prop
3030
properties:
3131
api2prop:
32-
$ref: '#/components/schemas/Api2Prop'
32+
$ref: '#/components/schemas/Api2Prop'

‎test/unit/core/curlify.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ describe("curlify", function () {
320320
})
321321

322322
describe("POST when header value is 'multipart/form-data' but header name is not 'content-type'", function () {
323-
it("shoud print a proper curl as -d <data>, when file type is provided", function () {
323+
it("should print a proper curl as -d <data>, when file type is provided", function () {
324324
let file = new win.File([""], "file.txt", { type: "text/plain" })
325325
// file.name = "file.txt"
326326
// file.type = "text/plain"
@@ -340,7 +340,7 @@ describe("curlify", function () {
340340
expect(curlified).toEqual("curl -X 'POST' \\\n 'http://example.com' \\\n -H 'x-custom-name: multipart/form-data' \\\n -d '{\n \"id\": \"123\",\n \"file\": {\n \"name\": \"file.txt\",\n \"type\": \"text/plain\"\n }\n}'")
341341
})
342342

343-
it("shoud print a proper curl as -d <data>, no file type provided", function () {
343+
it("should print a proper curl as -d <data>, no file type provided", function () {
344344
let file = new win.File([""], "file.txt")
345345
// file.name = "file.txt"
346346
// file.type = "text/plain"

0 commit comments

Comments
 (0)
Please sign in to comment.