Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions packages/core/src/__tests__/openapiv31.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,36 @@ test('process document', async() => {
expect(result).toBeDefined()
})

test('parse Xquik search operation', async() => {
const result = await createTestDocument('openapiv31/xquik-search.yml')

expect(result.info.title).toEqual('Xquik API')
expect(result.servers![0].url).toEqual('https://xquik.com')
expect(result.securitySchemes).not.toBeNull()
expect(result.securitySchemes?.[0].name).toEqual('apiKey')
expect(result.securitySchemes?.[0].in).toEqual('header')
expect(result.securitySchemes?.[0].paramName).toEqual('x-api-key')

let operation = undefined
for (const group of result.groups) {
for (const candidate of group.operations) {
if (candidate.name === 'searchTweets') {
operation = candidate
break
}
}
if (operation) {
break
}
}
expect(operation).toBeDefined()
expect(operation?.path).toEqual('/v1/x/tweets/search')
expect(operation?.parameters).not.toBeNull()
expect(idx.allValues(operation!.parameters!).map((parameter: { name: string }) => parameter.name)).toEqual(['q', 'cursor', 'limit'])
expect(operation?.securityRequirements?.requirements[0].schemes[0].scheme.name).toEqual('apiKey')
expect(operation?.returnNativeType?.toString()).toEqual('SearchTweetsResponse')
})

test('parse null string', async() => {
const result = await createTestDocument('openapiv31/simple.yml')

Expand Down
63 changes: 63 additions & 0 deletions packages/core/src/__tests__/openapiv31/xquik-search.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
openapi: 3.1.0
info:
title: Xquik API
version: '1.0'
servers:
- url: https://xquik.com
paths:
/api/v1/x/tweets/search:
get:
operationId: searchTweets
tags:
- x
parameters:
- name: q
in: query
required: true
schema:
type: string
- name: cursor
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 100
security:
- apiKey: []
responses:
'200':
description: Search results
content:
application/json:
schema:
$ref: '#/components/schemas/SearchTweetsResponse'
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
schemas:
SearchTweetsResponse:
type: object
required:
- tweets
properties:
tweets:
type: array
items:
$ref: '#/components/schemas/Tweet'
Tweet:
type: object
required:
- id
- text
properties:
id:
type: string
text:
type: string