Skip to content

docs: sync API docs from website#60

Merged
linfangw merged 2 commits into
mainfrom
docs/sync-api-docs-26236637463
May 23, 2026
Merged

docs: sync API docs from website#60
linfangw merged 2 commits into
mainfrom
docs/sync-api-docs-26236637463

Conversation

@linfangw
Copy link
Copy Markdown
Contributor

Mirrors website-owned REST API, Cookbook, and OpenAPI docs after qveris-website release/test changed. Source run: https://github.com/WonderfulValley/qveris-website/actions/runs/26236637463.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the OpenAPI documentation by adding three new query parameters—query, sort_by, and sort_order—and updating several source line references. The review feedback suggests enhancing these new parameters by adding descriptions and examples to improve documentation quality, and specifically recommends restricting sort_order to an enumeration of 'asc' and 'desc' for better validation.

Comment on lines +2071 to 2112
{
"name": "query",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query"
}
},
{
"name": "sort_by",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sort By"
}
},
{
"name": "sort_order",
"in": "query",
"required": false,
"schema": {
"type": "string",
"default": "asc",
"title": "Sort Order"
}
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The new query parameters (query, sort_by, sort_order) lack descriptions and examples, which reduces the quality of the public API documentation. Additionally, sort_order should include an enum to restrict values to asc and desc. Providing these details ensures consistency with other well-documented endpoints in this schema and improves the developer experience for API consumers.

          {
            "name": "query",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Query",
              "description": "Search query to filter providers by name or description."
            },
            "description": "Search query to filter providers by name or description.",
            "example": "cloud"
          },
          {
            "name": "sort_by",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Sort By",
              "description": "Field to sort the results by (e.g., name, score)."
            },
            "description": "Field to sort the results by (e.g., name, score).",
            "example": "name"
          },
          {
            "name": "sort_order",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ],
              "default": "asc",
              "title": "Sort Order",
              "description": "Sort order for the results (asc or desc)."
            },
            "description": "Sort order for the results (asc or desc).",
            "example": "asc"
          }

@linfangw linfangw merged commit 8022d40 into main May 23, 2026
4 checks passed
@linfangw linfangw deleted the docs/sync-api-docs-26236637463 branch May 23, 2026 07:36
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.

3 participants