Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: put string as a placeholder instead of value #8215

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 6 additions & 3 deletions src/core/json-schema-components.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,7 @@ export class JsonSchema_array extends PureComponent {
addItem = () => {
let newValue = valueOrEmptyList(this.state.value)
this.setState(() => ({
value: newValue.push(getSampleSchema(this.state.schema.get("items"), false, {
includeWriteOnly: true
}))
value: newValue.push(null)
}), this.onChange)
}

Expand Down Expand Up @@ -211,6 +209,10 @@ export class JsonSchema_array extends PureComponent {
}

const Button = getComponent("Button")
const sampleSchema = getSampleSchema(this.state.schema.get("items"), false, {
includeWriteOnly: true
})

return (
<div className="json-schema-array">
{shouldRenderValue ?
Expand All @@ -236,6 +238,7 @@ export class JsonSchema_array extends PureComponent {
onChange={(val) => this.onItemChange(val, i)}
disabled={disabled}
errors={itemErrors}
description={sampleSchema}
/>
: <ArrayItemsComponent {...this.props}
value={item}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification
termsOfService: http://swagger.io/terms/
contact:
name: Swagger API Team
email: apiteam@swagger.io
url: http://swagger.io
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://petstore.swagger.io/api
security:
- Petstore: []
paths:
/pets:
get:
description: |
Returns all pets from the system that the user has access to
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.

Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
operationId: findPets
parameters:
- name: tags
in: query
description: tags to filter by
required: false
style: form
schema:
type: array
items:
type: string
- name: limit
in: query
description: maximum number of results to return
required: false
schema:
type: integer
format: int32
responses:
'200':
description: pet response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
55 changes: 55 additions & 0 deletions test/e2e-cypress/tests/features/edit-parameters/string-array.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
describe("Edit parameters", () => {
describe("String array parameter", () => {
it("should render button add only if no value", () => {
cy
.visit("/?url=/documents/features/edit-parameters/string-array-parameter.yaml")
.get(".opblock-summary-control")
.click()
.get(".try-out__btn")
.click()
.get(".json-schema-array")
.should("have.length", 1)
.find(".json-schema-form-item-add")
.should("be.visible")
})
it("should render an input if clicking on add button", () => {
cy
.visit("/?url=/documents/features/edit-parameters/string-array-parameter.yaml")
.get(".opblock-summary-control")
.click()
.get(".try-out__btn")
.click()

cy
.get(".json-schema-array")
.find(".json-schema-form-item-add")
.should("be.visible")
.click()
.get(".json-schema-array")
.children()
.should('have.length', 2)
})

it("should render an input with a placeholder if clicking on add button", () => {
cy
.visit("/?url=/documents/features/edit-parameters/string-array-parameter.yaml")
.get(".opblock-summary-control")
.click()
.get(".try-out__btn")
.click()
.get(".json-schema-array")
.children()

cy
.get(".json-schema-array")
.find(".json-schema-form-item-add")
.should("be.visible")
.click()

cy
.get(".json-schema-array input")
.should("have.attr", "placeholder")
.and('match', /string/)
})
})
})