kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: fix typos and update https references (#8154)

Browse Source 
Co-authored-by: Tim Lai <timothy.lai@smartbear.com>
This commit is contained in:
Andreas Deininger
2022-08-12 19:14:27 +02:00
committed by GitHub
parent 7e65155a7b
commit 9891d97201
19 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/customization/overview.md
View File

@@ -7,7 +7,7 @@ Swagger UI leans heavily on concepts and patterns found in React and Redux.
If you aren't already familiar, here's some suggested reading:
- [React: Quick Start (reactjs.org)](https://reactjs.org/docs/hello-world.html)
- [Redux README (redux.js.org)](http://redux.js.org/)
- [Redux README (redux.js.org)](https://redux.js.org/)
In the following documentation, we won't take the time to define the fundamentals covered in the resources above.

2
docs/customization/plugin-api.md
View File

@@ -100,7 +100,7 @@ The Action interface enables the creation of new Redux action creators within a
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.
For more information about the concept of actions in Redux, see the [Redux Actions documentation](http://redux.js.org/docs/basics/Actions.html).
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).
#### Reducers

4
docs/usage/configuration.md
View File

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

4
docs/usage/cors.md
View File

@@ -41,11 +41,11 @@ XMLHttpRequest cannot load http://sad.server.com/v2/api-docs. No 'Access-Control
Swagger UI cannot easily show this error state.
- 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.
- 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.
### Enabling CORS
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.
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.
Other servers/frameworks may provide you information on how to enable it specifically in their use case.

2
docs/usage/version-detection.md
View File

@@ -48,7 +48,7 @@ If you've determined this is the version you have, to find the exact version:
/**
* 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
* @version v2.2.9
* @link http://swagger.io
* @link https://swagger.io
* @license Apache-2.0
*/
```

2
src/core/components/object-model.jsx
View File

@@ -143,7 +143,7 @@ export default class ObjectModel extends Component {
}).toArray()
}
{
// empty row befor extensions...
// empty row before extensions...
!showExtensions ? null : <tr><td>&nbsp;</td></tr>
}
{

2
src/core/plugins/oas3/helpers.jsx
View File

@@ -6,7 +6,7 @@ export function isOAS3(jsSpec) {
return false
}
// we gate against `3.1` becasue we want to explicitly opt into supporting it
// we gate against `3.1` because we want to explicitly opt into supporting it
// at some point in the future -- KS, 7/2018
// starts with, but is not `3.0.` exactly

2
src/plugins/add-plugin.md
View File

@@ -66,7 +66,7 @@ export function SomePlugin(toolbox) {
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
state => state.get("something") // return the whatever "something" points to
),
foo: getState => "bar" // In the end selectors are just fuctions that we pass getState to
foo: getState => "bar" // In the end selectors are just functions that we pass getState to
}
}

2
test/e2e-cypress/static/documents/features/parameter-array-missing-items.yaml
View File

@@ -21,4 +21,4 @@ paths:
- type: integer
responses:
'200':
description: successfull fetch
description: successful fetch

4
test/e2e-cypress/tests/bugs/5660.js
View File

@@ -3,14 +3,14 @@
const expectedValue = "nullable: true"
describe("#5660: Nullable object", () => {
it("should render `nullable` marker for object ifself", () => {
it("should render `nullable` marker for object itself", () => {
cy.visit("/?url=/documents/bugs/5660-model.yaml")
.get("#model-SomeObject .model-toggle")
.click()
.get("#model-SomeObject > .model-box")
.contains(expectedValue)
})
it("should render `nullable` marker for nexted object in property", () => {
it("should render `nullable` marker for next object in property", () => {
cy.visit("/?url=/documents/bugs/5660-property.yaml")
.get("#model-SomeObject .model-toggle")
.click()

2
test/e2e-cypress/tests/features/oas3-multiple-servers.js
View File

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

2
test/e2e-cypress/tests/features/oas3-user-edit-request-body-flows.js
View File

@@ -89,7 +89,7 @@ describe("OAS3 Request Body user edit flows", () => {
})
})
describe("multipart/", () => {
// 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.
// 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.
it("should use the first enum value on execute if not changed by user (#6976)", () => {
// test/e2e-cypress/static/documents/features/request-body/multipart/enum.yaml
getExpandedTryout(

2
test/e2e-cypress/tests/features/schema-form.js
View File

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

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

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

2
test/e2e-selenium/scenarios/features/allow-empty-value.openapi.js
View File

@@ -235,7 +235,7 @@ describe("feature: OpenAPI 3 allowEmptyValue", function () {
.to.contain(`GET "http://localhost:3230/emptyValueParams"`)
})
})
describe("send empty inital value behavior", function () {
describe("send empty initial value behavior", function () {
it("should send an empty integer value", function (client) {
const paramSelector = `tr[data-param-name="int"]`

2
test/e2e-selenium/static/test-specs/bugs/4196.yaml
View File

@@ -68,7 +68,7 @@ components:
description: a human readable message explaining the error
type: string
reason:
description: a functionnal key about the error
description: a functional key about the error
type: string
responses:
Unauthorized:

2
test/e2e-selenium/static/test-specs/refs/api1.yaml
View File

@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
description: |
This is a test to show how model refererence from another file are failing.
This is a test to show how model reference from another file fails.
This file references api2.yaml. If you load this file first in the browser it fails.
However, if you load api2.yaml first, then load this one it will work.
version: 1.0.0

2
test/e2e-selenium/static/test-specs/refs/api2.yaml
View File

@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
description: |
This is a test to show how model refererence from another file are failing.
This is a test to show how model reference from another file fails.
This file is referenced api1.yaml. If you load api1.yaml first in the browser it fails.
However, if you load this file first, then load api1.yaml it will work.
version: 1.0.0

4
test/unit/core/curlify.js
View File

@@ -320,7 +320,7 @@ describe("curlify", function () {
})
describe("POST when header value is 'multipart/form-data' but header name is not 'content-type'", function () {
it("shoud print a proper curl as -d <data>, when file type is provided", function () {
it("should print a proper curl as -d <data>, when file type is provided", function () {
let file = new win.File([""], "file.txt", { type: "text/plain" })
// file.name = "file.txt"
// file.type = "text/plain"
@@ -340,7 +340,7 @@ describe("curlify", function () {
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}'")
})
it("shoud print a proper curl as -d <data>, no file type provided", function () {
it("should print a proper curl as -d <data>, no file type provided", function () {
let file = new win.File([""], "file.txt")
// file.name = "file.txt"
// file.type = "text/plain"