-
Notifications
You must be signed in to change notification settings - Fork 1
Add Xquik OpenAPI parser coverage #2
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
Open
kriptoburak
wants to merge
1
commit into
UnitOneAI:main
Choose a base branch
from
kriptoburak:codex/xquik-openapi-parser-test
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,97 @@ | ||
| import { describe, expect, it } from "vitest"; | ||
| import { ApiParser } from "./ApiParser"; | ||
|
|
||
| describe("ApiParser", () => { | ||
| it("parses an OpenAPI 3.1 API-key search endpoint", async () => { | ||
| const spec = { | ||
| openapi: "3.1.0", | ||
| info: { | ||
| title: "Xquik API", | ||
| version: "1.0.0", | ||
| }, | ||
| servers: [{ url: "https://xquik.com" }], | ||
| paths: { | ||
| "/api/v1/x/tweets/search": { | ||
| get: { | ||
| operationId: "searchTweets", | ||
| summary: "Search tweets", | ||
| description: "Search public posts with query, limit, and cursor parameters.", | ||
| parameters: [ | ||
| { | ||
| name: "query", | ||
| in: "query", | ||
| required: true, | ||
| schema: { type: "string" }, | ||
| description: "Search query.", | ||
| }, | ||
| { | ||
| name: "limit", | ||
| in: "query", | ||
| required: false, | ||
| schema: { type: "integer" }, | ||
| description: "Maximum number of results.", | ||
| }, | ||
| { | ||
| name: "cursor", | ||
| in: "query", | ||
| required: false, | ||
| schema: { type: "string" }, | ||
| description: "Pagination cursor.", | ||
| }, | ||
| ], | ||
| responses: { | ||
| "200": { | ||
| description: "Search results.", | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| components: { | ||
| securitySchemes: { | ||
| apiKey: { | ||
| type: "apiKey", | ||
| in: "header", | ||
| name: "x-api-key", | ||
| }, | ||
| }, | ||
| }, | ||
| security: [{ apiKey: [] }], | ||
| }; | ||
|
|
||
| const parsed = await new ApiParser().parseOpenApi(JSON.stringify(spec)); | ||
|
|
||
| expect(parsed.name).toBe("Xquik API"); | ||
| expect(parsed.baseUrl).toBe("https://xquik.com"); | ||
| expect(parsed.authType).toBe("apiKey"); | ||
| expect(parsed.endpoints).toHaveLength(1); | ||
| expect(parsed.endpoints?.[0]).toMatchObject({ | ||
| path: "/api/v1/x/tweets/search", | ||
| method: "GET", | ||
| operationId: "searchTweets", | ||
| parameters: [ | ||
| { | ||
| name: "query", | ||
| in: "query", | ||
| type: "string", | ||
| required: true, | ||
| description: "Search query.", | ||
| }, | ||
| { | ||
| name: "limit", | ||
| in: "query", | ||
| type: "integer", | ||
| required: false, | ||
| description: "Maximum number of results.", | ||
| }, | ||
| { | ||
| name: "cursor", | ||
| in: "query", | ||
| type: "string", | ||
| required: false, | ||
| description: "Pagination cursor.", | ||
| }, | ||
| ], | ||
| }); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because this test is placed under
src/generator, it matchestsconfig.server.json'ssrc/generator/**/*include and will be emitted bynpm run build:serverintodist/server/generator/ApiParser.test.jswith a test-onlyvitestimport. In deploy or publish contexts that consume the server build artifact without devDependencies, this leaves a production artifact that can fail if loaded or packaged; move the test under an excluded test location or exclude*.test.tsfrom the server tsconfig.Useful? React with 👍 / 👎.