Skip to content

docs: sync API docs from website #60

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.

Sign up for GitHub

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

Merged
linfangw merged 2 commits into from
May 23, 2026
Merged

docs: sync API docs from website #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2859fb5
docs: sync API docs from website
May 21, 2026
683e4ae
docs: update generated OpenAPI types
linfangw May 23, 2026
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
48 changes: 45 additions & 3 deletions docs/openapi/qveris-public-api.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2067,6 +2067,48 @@
"default": 50,
"title": "Limit"
}
},
{
"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"
}
}
Comment on lines +2071 to 2112

@gemini-code-assist gemini-code-assist Bot May 21, 2026

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"
          }

],
"responses": {
Expand Down Expand Up @@ -2097,7 +2139,7 @@
],
"x-qveris-source": {
"file": "backend/routers/search.py",
"line": 2260
"line": 3177
}
}
},
Expand Down Expand Up @@ -2132,7 +2174,7 @@
],
"x-qveris-source": {
"file": "backend/routers/search.py",
"line": 2189
"line": 2206
}
}
},
Expand Down Expand Up @@ -2466,7 +2508,7 @@
],
"x-qveris-source": {
"file": "backend/routers/search.py",
"line": 2348
"line": 3297
},
"requestBody": {
"required": true,
Expand Down
3 changes: 3 additions & 0 deletions packages/mcp/src/generated/openapi.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1825,6 +1825,9 @@ export interface operations {
categories?: string | null;
skip?: number;
limit?: number;
query?: string | null;
sort_by?: string | null;
sort_order?: string;
};
header?: never;
path?: never;
Expand Down
Loading