Skip to content

Adding query search params #12

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
elliot-huffman merged 3 commits into from
Jun 23, 2025
Merged

Adding query search params #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea82a11
Adding query search params
pasha-zayko Jun 12, 2025
c63c75e
Fixing typo
pasha-zayko Jun 12, 2025
cc06203
Updating version in lock file
pasha-zayko Jun 12, 2025
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
42 changes: 39 additions & 3 deletions specs/Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,28 @@
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
}
},
"dateStart": {
"description": "Date string to narrow records selection to those created on or after that date.",
"in": "query",
"name": "dateStart",
"required": false,
"schema": {
"example": "2025-01-01T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"dateEnd": {
"description": "Date string to narrow records selection to those created before or on that date.",
"in": "query",
"name": "dateEnd",
"required": false,
"schema": {
"example": "2025-02-05T23:59:59Z",
"format": "date-time",
"type": "string"
}
}
},
"responses": {
Expand Down Expand Up @@ -891,7 +913,7 @@
},
"description": "Collects data from the various SHI Lab products and makes it available in a standardized way.",
"title": "SHI Data Gateway",
"version": "2.1.0"
"version": "2.1.1"
},
"openapi": "3.0.0",
"paths": {
Expand Down Expand Up @@ -1077,8 +1099,16 @@
},
"/Api/LicenseReport/Correlation": {
"get": {
"description": "Retrieves the list of correlation records for the authenticated tenant. Correlation records store the metadata for a specific license report.\n\nThis endpoint requires the `LicenseReport.Read`, `LicenseReport.Read.All`, `LicenseReport.ReadWrite`, or `LicenseReport.ReadWrite.All` scope (permission).",
"description": "Retrieves the list of correlation records for the authenticated tenant. Can use filters targeting creation date to limit results. Correlation records store the metadata for a specific license report.\n\nThis endpoint requires the `LicenseReport.Read`, `LicenseReport.Read.All`, `LicenseReport.ReadWrite`, or `LicenseReport.ReadWrite.All` scope (permission).",
"operationId": "/Api/LicenseReport/Correlation/Get",
"parameters": [
{
"$ref": "#/components/parameters/dateStart"
},
{
"$ref": "#/components/parameters/dateEnd"
}
],
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -1133,11 +1163,17 @@
},
"/Api/LicenseReport/Correlation/Tenant/{tenantId}": {
"get": {
"description": "Retrieves the list of correlation records for the specified tenant. Correlation records store the metadata for a specific license report.\n\nThis endpoint requires the `LicenseReport.Read.All`, or `LicenseReport.ReadWrite.All` scope (permission). This endpoint is also only accessible form the `SHI` and `SHI Lab` tenants. End user access is restricted.",
"description": "Retrieves the list of correlation records for the specified tenant. Can use filters targeting creation date to limit results. Correlation records store the metadata for a specific license report.\n\nThis endpoint requires the `LicenseReport.Read.All`, or `LicenseReport.ReadWrite.All` scope (permission). This endpoint is also only accessible from the `SHI` and `SHI Lab` tenants. End user access is restricted.",
"operationId": "/Api/LicenseReport/Correlation/Tenant/:tenantId/Get",
"parameters": [
{
"$ref": "#/components/parameters/tenantId"
},
{
"$ref": "#/components/parameters/dateStart"
},
{
"$ref": "#/components/parameters/dateEnd"
}
],
"responses": {
Expand Down
4 changes: 2 additions & 2 deletions src/dataGateway/TypeScript/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/dataGateway/TypeScript/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@shi-corp/sdk-data-gateway",
"version": "2.1.0",
"version": "2.1.1",
"type": "module",
"main": "bin/index.js",
"description": "SDK client used to interface with the SHI Data Gateway service.",
Expand Down