Skip to content

Conversation

@pasha-zayko
Copy link
Contributor

Adding API endpoint to allow communication with AI Agent about license reports

Adding API endpoint to allow communication with AI Agent about license reports
@pasha-zayko pasha-zayko marked this pull request as ready for review July 15, 2025 19:27
Copilot AI review requested due to automatic review settings July 15, 2025 19:27

This comment was marked as outdated.

Fixed the same typo across entire spec
@pasha-zayko pasha-zayko requested a review from Copilot July 15, 2025 19:38
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a new chat-based AI endpoint for querying license report data and updates related versioning and documentation.

  • Bumped package and OpenAPI spec version to 2.1.3
  • Added Chat.MessageRecord schema and /Api/Chat/LicenseGpt endpoint
  • Fixed typos (“form” → “from”) and added a new Chat tag

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File Description
src/dataGateway/TypeScript/package.json Bumped SDK package version from 2.1.2 to 2.1.3
specs/Data-Gateway.json Added chat schema & endpoint, updated spec version, fixed typos
Files not reviewed (1)
  • src/dataGateway/TypeScript/package-lock.json: Language not supported
Comments suppressed due to low confidence (3)

specs/Data-Gateway.json:206

  • Property name 'tool_calls' is snake_case and inconsistent with the camelCase naming used elsewhere (e.g., 'messageList', 'responseText'). Consider renaming to 'toolCalls'.
                    "tool_calls": {

specs/Data-Gateway.json:237

  • Property name 'tool_call_id' is snake_case and inconsistent with the camelCase naming used elsewhere. Consider renaming to 'toolCallId' to follow naming conventions.
                    "tool_call_id": {

specs/Data-Gateway.json:1624

  • Example uses single quotes inside the JSON string for 'content', which is not valid JSON. Consider using double quotes or escaping them properly to avoid confusion.
                                                "content": "{'825a9d7e-0b62-4392-b8ef-ab6951a46ebd':'2025-07-03T18:39:50.828Z','744c0878-3a82-48a7-b239-a1d4b9298a69':'2025-07-07T21:01:20.995Z'}",

Making sure the example string is valid json stringified value
@pasha-zayko pasha-zayko requested a review from Copilot July 15, 2025 20:06
@pasha-zayko pasha-zayko self-assigned this Jul 15, 2025
@pasha-zayko pasha-zayko added the enhancement New feature or request label Jul 15, 2025

This comment was marked as outdated.

Enhancing example data to closer represent the real details of the request
@pasha-zayko pasha-zayko requested a review from Copilot July 16, 2025 16:30

This comment was marked as outdated.

@elliot-huffman elliot-huffman changed the title Adding endpoint for chat communication [Feature]Data Gateway - LicenseGPT Jul 16, 2025
Ensure that the Data Gateway API Spec version matches the published version of Data Gateway.
Regenerate Lock
@socket-security
Copy link

socket-security bot commented Jul 16, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updated@​types/​node@​24.0.12 ⏵ 24.0.141001008096100
Updated@​azure/​core-auth@​1.9.0 ⏵ 1.10.0100 +110095 +197 +2100
Updatedtypia@​9.4.0 ⏵ 9.5.0100 +110010095 +1100

View full report

Regenerate lock
Update required properties for the Data Gateway response. There will always be those properties, they aren't optional.
Update name of the schema to be able to be understood better when operating with Kiota generated SDKs.
Order of properties.
Copy link
Contributor

@elliot-huffman elliot-huffman left a comment

Choose a reason for hiding this comment

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

Looks great!

@elliot-huffman elliot-huffman requested a review from Copilot July 16, 2025 19:42
@elliot-huffman elliot-huffman merged commit 30903ed into main Jul 16, 2025
6 checks passed
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a conversational AI endpoint for license reports and updates package dependencies.

  • Bumps Azure auth, Node types, and typia versions in Shield and Data Gateway packages
  • Adds Chat.OpenAIChatMessage schema and the /Api/Chat/LicenseGpt endpoint to the API spec
  • Corrects minor typos in endpoint descriptions and bumps the spec version

Reviewed Changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated no comments.

File Description
src/shield/TypeScript/package.json Updated devDependency versions for core-auth, types-node, typia
src/dataGateway/TypeScript/package.json Bumped package version to 2.2.0 and updated devDependency versions
specs/Data-Gateway.json Added Chat schema, new Chat endpoint, fixed typos, bumped spec version to 2.1.3
Files not reviewed (2)
  • src/dataGateway/TypeScript/package-lock.json: Language not supported
  • src/shield/TypeScript/package-lock.json: Language not supported
Comments suppressed due to low confidence (4)

specs/Data-Gateway.json:1009

  • The OpenAPI spec version (2.1.3) doesn’t align with the Data Gateway package version (2.2.0); consider bumping the spec version to 2.2.0 for consistency.
        "version": "2.1.3"

specs/Data-Gateway.json:206

  • [nitpick] The property tool_calls (and tool_call_id) uses snake_case while other schema properties use camelCase; consider renaming to toolCalls and toolCallId to match the rest of the spec.
                    "tool_calls": {

specs/Data-Gateway.json:1589

  • The new Chat endpoint currently defines only 200 and 400 responses; consider adding standard HTTP error responses (e.g., 401, 403, 500) via #/components/responses to cover authentication and server failures.
                "responses": {

specs/Data-Gateway.json:1572

  • Consider adding integration or unit tests for the new /Api/Chat/LicenseGpt endpoint and the Chat.OpenAIChatMessage schema to validate message parsing and tool call handling.
            "post": {

@elliot-huffman elliot-huffman deleted the pasha-chat-endpoint branch July 16, 2025 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants