fix(oas31): allow override names of top level schemas (#9787)

Refs #9713

Co-authored-by: Oliwia Rogala <oliwia.rogala@smartbear.com>
This commit is contained in:
Vladimír Gorej
2024-04-08 13:43:38 +02:00
committed by GitHub
parent af538a3800
commit 111e420c98
5 changed files with 177 additions and 30 deletions

View File

@@ -0,0 +1,21 @@
/**
* @prettier
*/
describe("JSON Schema 2020-12 title keyword", () => {
it("should render a correct title for schemas", () => {
cy.visit("/?url=/documents/features/json-schema-2020-12-title.yaml")
.get(".json-schema-2020-12__title")
.eq(0)
.contains("My Pet")
.should("exist")
.get(".json-schema-2020-12__title")
.eq(1)
.contains("My Pets")
.should("exist")
.get(".json-schema-2020-12__title")
.eq(2)
.contains("Error")
.should("exist")
})
})

View File

@@ -0,0 +1,114 @@
openapi: 3.1.0
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
url: https://opensource.org/licenses/MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
'200':
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Pets'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
Pet:
title: My Pet
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
title: My Pets
type: array
items:
$ref: '#/components/schemas/Pet'
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string