Skip to content

Update Swagger documentation for Metrics API - #12

Merged
Guillaume1868 merged 2 commits into
developfrom
chore/api-swagger
Mar 5, 2026
Merged

Update Swagger documentation for Metrics API#12
Guillaume1868 merged 2 commits into
developfrom
chore/api-swagger

Conversation

@Arthur-Bottemanne

Copy link
Copy Markdown
Contributor

Related Issue

Changes Made

  • Updated api swagger documentation to be up to date with api implementation and specify needed parameters based on metrics for validation

}
}
},
"/api/v1/metrics/query": {

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.

Add a comment to specify that this route is here to send a raw VM query. And we should consider adding a specialized route instead of writing VM specific language in other parts of the project.

This route is here for convinience but is not recommended for best practices

You can merge this PR once that comment is added

@Guillaume1868

Copy link
Copy Markdown
Contributor

👍

@Guillaume1868
Guillaume1868 merged commit 77d98bf into develop Mar 5, 2026
1 check passed
@Arthur-Bottemanne
Arthur-Bottemanne deleted the chore/api-swagger branch March 5, 2026 14:16
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.

2 participants