grafana/grafana-image-renderer

no rest API documentation found

Open

#374 opened on Sep 26, 2022

View on GitHub
 (2 comments) (2 reactions) (0 assignees)Go (178 forks)auto 404
good first issuetype/docstype/enhancement

Repository metrics

Stars
 (519 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like to be added:

Documentation for the rest API to render images. What form does the URL take? What query parameters can be passed in to control image rendering?

Why is this needed:

I haven't been able to find documentation that describes the rest API to render images.

Contributor guide

Research direction
Identify the REST API endpoints and query parameters by examining the router and handler code, then document the image rendering API.
Tech stack
go
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80