Feat/openapi generation

[niklastreml]

Motivation

Implements dynamic openapi schemas based on the registered checks

Concept

I have added a new method Schema() to the check interface which has to return an OpenAPI schema of the Result including its metrics type as the data attribute. To make this easier and less prone to errors, a helper function is also provided. An example of how to implement this can be found in the roundtrip check.

Below is a sample of what is generated by sparrow:

openapi: 3.0.0
components: {}
info:
    title: Sparrow Metrics API
    description: Serves metrics collected by sparrows checks
    contact:
        name: CaaS Team
        url: https://caas.telekom.de
        email: [email protected]
    version: ""
paths:
    /v1/metrics/rtt:
        description: rtt
        get:
            tags:
                - Metrics
                - rtt
            description: Returns the performance data for check rtt
            responses:
                "200":
                    description: Metrics for check rtt
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            ms:
                                                type: integer
                                                format: int64
                                    error:
                                        type: string
                                    timestamp:
                                        type: string
                                        format: date-time

Changes

• Feat: Added a schema method to check interface
• Feat: Added an Openapi() method to sparrow
• Misc: Added a debug config for vscode
• Feat: Added a helper to turn check metrics into openapi schemas

Tests done

• Created unit tests for all added logic

TODO

• I've assigned this PR to myself
• I've labeled this PR correctly
• Rebase from main

[y-eight]

reviewed & refactored together... LGTM