Skip to content

Add Xquik OpenAPI example#2

Open
kriptoburak wants to merge 2 commits into
NNNNzs:mainfrom
kriptoburak:codex/add-xquik-openapi-example-0733
Open

Add Xquik OpenAPI example#2
kriptoburak wants to merge 2 commits into
NNNNzs:mainfrom
kriptoburak:codex/add-xquik-openapi-example-0733

Conversation

@kriptoburak

@kriptoburak kriptoburak commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • Add Xquik as a public OpenAPI 3.1 JSON example in the upload instructions.
  • Note that the spec includes API key and OAuth bearer authentication metadata.

Validation

  • git diff --check
  • node --check src/server.js
  • Verified https://xquik.com/openapi.json with jq for OpenAPI 3.1, title, server URL, and x-api-key metadata.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0bd35c274e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
- 文件大小限制:10MB
- 拖拽文件或点击上传区域选择文件

可使用 Xquik 的公开 OpenAPI 3.1 JSON 作为远程规范示例:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Do not recommend a 3.1 spec for validation

This example is presented as a fixture for verifying conversion and auth metadata, but the app exposes the strict 验证规范 option immediately below; when users enable it, the current Higress converter's validator still treats OpenAPI 3.1-only schema keywords used by Xquik (for example const) as invalid extra fields, so the documented sample fails instead of demonstrating a successful upload. Either use a 3.0 sample here or explicitly tell users to leave strict validation off until the converter supports 3.1.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant