Skip to content

feat: Update v2 OpenAPI specification from SonarQube API docs#112

Open
Copilot wants to merge 8 commits intomainfrom
copilot/update-v2-api-specification
Open

feat: Update v2 OpenAPI specification from SonarQube API docs#112
Copilot wants to merge 8 commits intomainfrom
copilot/update-v2-api-specification

Conversation

Copy link
Contributor

Copilot AI commented Nov 20, 2025

Updates src/schema/sonarqube-v2.json with the latest v2 API specification from https://next.sonarqube.com/sonarqube/api/v2/api-docs and regenerates the TypeScript SDK.

Changes

  • Replace src/schema/sonarqube-v2.json with latest specification from SonarQube instance
  • Regenerate SDK in src/generated/ via yarn openapi-ts (merges v1/v2 schemas and generates TypeScript client)
  • Update type definitions and client methods to match new API endpoints/schemas
  • Update tests to use usersManagement service instead of user to match the new API structure

This ensures the SDK stays in sync with SonarQube's evolving v2 API surface.

[!WARNING]

Original prompt

This section details on the original issue you should resolve

<filter_complete></filter_complete>

<issue_title>Update the v2 API specification</issue_title>
<issue_description>Update the v2 openapi specification with the latest from https://next.sonarqube.com/sonarqube/api/v2/api-docs

We should download and overwrite the contents from this URL into the file without changes.

Once updated we need to regenerate the SDK and run the tests using yarn openapi-ts and yarn test.</issue_description>

Comments on the Issue (you are Copilot in this section)

Original prompt

This section details on the original issue you should resolve

<issue_title>Update the v2 API specification</issue_title>
<issue_description>Update the v2 openapi specification with the latest from https://next.sonarqube.com/sonarqube/api/v2/api-docs

We should download and overwrite the contents from this URL into the file without changes.

Once updated we need to regenerate the SDK and run the tests using yarn openapi-ts and yarn test.</issue_description>

Comments on the Issue (you are Copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Update the v2 API specification with latest contents Update v2 OpenAPI specification from SonarQube API docs Nov 20, 2025
@ScottGuymer
Copy link
Member

Copilot i have adjusted the firewall, try to access the URLS again and get the latest specification

Copy link
Contributor Author

Copilot AI commented Nov 20, 2025

Copilot i have adjusted the firewall, try to access the URLS again and get the latest specification

Successfully downloaded the latest v2 API specification and regenerated the SDK. The tests have been updated to match the new API structure and all tests are passing. Changes committed in 8ed0f29.

@ScottGuymer Scott Guymer (ScottGuymer) force-pushed the copilot/update-v2-api-specification branch from 8ed0f29 to d490578 Compare December 6, 2025 19:08
@ScottGuymer Scott Guymer (ScottGuymer) changed the title Update v2 OpenAPI specification from SonarQube API docs feat: Update v2 OpenAPI specification from SonarQube API docs Dec 6, 2025
@ScottGuymer Scott Guymer (ScottGuymer) marked this pull request as ready for review December 6, 2025 19:13
@ScottGuymer Scott Guymer (ScottGuymer) force-pushed the copilot/update-v2-api-specification branch from c279200 to ae4939d Compare December 6, 2025 20:02
@ScottGuymer Scott Guymer (ScottGuymer) force-pushed the copilot/update-v2-api-specification branch from ae4939d to 51b8d88 Compare January 14, 2026 15:16
@ScottGuymer Scott Guymer (ScottGuymer) force-pushed the copilot/update-v2-api-specification branch from 9ec8d25 to ac0dd31 Compare January 14, 2026 15:24
Copy link
Member

@Brend-Smits Brend Smits (Brend-Smits) left a comment

Choose a reason for hiding this comment

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

LGTM :shipit:!

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.

Update the v2 API specification

3 participants