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

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

@@ -9,7 +9,7 @@ paths:
parameters:
- in: query
name: basicName
content:
content:
application/json:
schema:
type: object
@@ -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:

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

@@ -1,13 +1,13 @@
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
title: API1 Test
paths:
'/test-api-1':
'/test-api-1':
get:
summary: Api 1
responses:
@@ -29,4 +29,4 @@ components:
api1prop:
$ref: '#/components/schemas/Api1Prop'
api2prop:
$ref: 'api2.yaml#/components/schemas/Api2Prop'
$ref: 'api2.yaml#/components/schemas/Api2Prop'

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

@@ -1,13 +1,13 @@
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
title: API2 Test
paths:
'/test-api-2':
'/test-api-2':
get:
summary: Api 2
responses:
@@ -29,4 +29,4 @@ components:
description: This is a test prop
properties:
api2prop:
$ref: '#/components/schemas/Api2Prop'
$ref: '#/components/schemas/Api2Prop'

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"