-
Notifications
You must be signed in to change notification settings - Fork 8.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(requestBody): hide read only properties (#6490)
- Loading branch information
Lucia Sarni
committed
Oct 15, 2020
1 parent
5fc43fa
commit 5065613
Showing
3 changed files
with
113 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
openapi: 3.0.0 | ||
info: | ||
title: "Swagger Test" | ||
version: "1.0.0" | ||
servers: | ||
- url: https://api.example.com/v1 | ||
paths: | ||
/users: | ||
get: | ||
tags: | ||
- User | ||
summary: Get Users | ||
responses: | ||
200: | ||
description: User List | ||
content: | ||
application/json: | ||
schema: | ||
type: array | ||
items: | ||
$ref: '#/components/schemas/User' | ||
post: | ||
tags: | ||
- User | ||
summary: Create a user | ||
requestBody: | ||
content: | ||
application/x-www-form-urlencoded: | ||
schema: | ||
$ref: '#/components/schemas/User' | ||
responses: | ||
201: | ||
description: Created successfully | ||
put: | ||
tags: | ||
- User | ||
summary: Update user | ||
requestBody: | ||
content: | ||
application/x-www-form-urlencoded: | ||
schema: | ||
$ref: '#/components/schemas/User' | ||
responses: | ||
201: | ||
description: Created successfully | ||
components: | ||
schemas: | ||
User: | ||
type: object | ||
properties: | ||
id: | ||
type: integer | ||
readOnly: true | ||
name: | ||
type: string | ||
required: | ||
- name |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
describe("#6158: read-only property is not hidden in `POST/PUT`", () => { | ||
describe("POST", () => { | ||
it("should hide property 'id'", () => { | ||
cy.visit("/?url=/documents/bugs/6158.yaml") | ||
.get("#operations-User-post_users") | ||
.click() | ||
.get(".parameters[data-property-name='id']") | ||
.should("not.exist") | ||
.get(".parameters[data-property-name='name']") | ||
.should("exist") | ||
}) | ||
it("should hide property 'id' when trying it out", () => { | ||
cy.visit("/?url=/documents/bugs/6158.yaml") | ||
.get("#operations-User-post_users") | ||
.click() | ||
.get(".try-out__btn") | ||
.click() | ||
.get(".parameters[data-property-name='id']") | ||
.should("not.exist") | ||
.get("input[placeholder='id']") | ||
.should("not.exist") | ||
.get(".parameters[data-property-name='name']") | ||
.should("exist") | ||
.get("input[placeholder='name']") | ||
.should("exist") | ||
}) | ||
}) | ||
describe("PUT", () => { | ||
it("should hide property 'id'", () => { | ||
cy.visit("/?url=/documents/bugs/6158.yaml") | ||
.get("#operations-User-put_users") | ||
.click() | ||
.get(".parameters[data-property-name='id']") | ||
.should("not.exist") | ||
.get(".parameters[data-property-name='name']") | ||
.should("exist") | ||
}) | ||
it("should hide property 'id' when trying it out", () => { | ||
cy.visit("/?url=/documents/bugs/6158.yaml") | ||
.get("#operations-User-put_users") | ||
.click() | ||
.get(".try-out__btn") | ||
.click() | ||
.get(".parameters[data-property-name='id']") | ||
.should("not.exist") | ||
.get("input[placeholder='id']") | ||
.should("not.exist") | ||
.get(".parameters[data-property-name='name']") | ||
.should("exist") | ||
.get("input[placeholder='name']") | ||
.should("exist") | ||
}) | ||
}) | ||
}) |