OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 6 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.
Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.
Commentaires : bogues et demandes de fonctionnalités
Lister les rapports de bogue
Retourne les rapports de bogues du projet appelant, les plus récents d’abord, jusqu’à cent. Les soumissions d’un autre projet ne sont jamais retournées. Lire un fil possédé par son ID de rétroaction. Il n’y a pas de curseur de pagination en v1. Chaque soumission porte son statut et les réponses du personnel/agent, les plus anciennes d’abord.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/bugs'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Rapports de bogues appartenant au projet appelant. | FeedbackList (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Signaler un bogue
Enregistre un rapport de bogue pour le projet appelant. Les champs propres à une soumission ne peuvent être mis à jour ou supprimés ; ajoutez une correction ou plus d’informations avec une réponse sur le même fil de retour.
Une nouvelle tentative exacte portant la même Idempotency-Key retourne la soumission originale pendant vingt-quatre heures au lieu de créer un doublon, et un corps différent sous cette clé retourne idempotency_mismatch. Chaque soumission est filtrée avant d’être stockée.
Un corps de moins de 12 caractères ou 3 mots retourne submission_too_short ; un texte ne décrivant aucun problème ou demande (caractères aléatoires, frappes au clavier) retourne submission_unclear ; spam, texte avec beaucoup de liens, injection de prompt et texte malveillant retournent submission_rejected.
Une soumission refusée n’est pas stockée, son détail de problème ne répète jamais le texte soumis, et une nouvelle tentative exacte sous le même Idempotency-Key renvoie le même refus.
Ne jamais placer de justificatifs, cookies, en-têtes d’autorisation, nonces d’achèvement, URL signées ou clés d’objet dans le titre, le corps ou le contexte ; le texte en forme de justificatif (jetons ScreenRig, JWT, jetons porteurs, clés cloud et API, clés privées) est remplacé par [caviardé] avant que la soumission soit stockée, et la réponse porte le texte caviardé.
Lorsque le modèle de filtrage est brièvement indisponible, la soumission est acceptée et mise en attente pour un nouveau filtrage en arrière-plan ; après plusieurs acceptations similaires en une heure, le projet reçoit submission_screening_unavailable (500, Retry-After) et réessaie la même requête plus tard.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| Idempotency-Key | en-tête | obligatoire |
Champs du corps de la requête
| Champ | Description |
|---|---|
| titre (obligatoire, chaîne) | Résumé sur une seule ligne. Les espaces en début et fin sont supprimés, et les caractères de contrôle sont refusés. minLength : 1 maxLength : 120 |
| corps (obligatoire, chaîne) | Description complète. Saut de ligne et tabulation sont les seuls caractères de contrôle acceptés. minLength : 1 maxLength : 4000 |
| context (optionnel, FeedbackContext) | Enveloppe de diagnostic fermée. Chaque membre est un scalaire contraint optionnel, l’imbrication est structurellement impossible, et un membre inconnu est rejeté avec invalid_request. La forme existe pour qu’un client ne puisse pas persister des valeurs d’argument, des identifiants ou des données d’environnement libres à travers elle. |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/bugs'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Rapport de bogue stocké. Une nouvelle tentative idempotente exacte renvoie cette même soumission. | FeedbackSubmission (application/json) ; en-têtes : RateLimit-Policy, RateLimit |
| 400 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 422 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 429 | Problème stable rate_limited. Réessayez seulement après l’intervalle Retry-After autoritaire. Les refus à fenêtre fixe incluent aussi la politique RateLimit-Policy applicable et les membres RateLimit ; les refus de concurrence et de budget d’octets omettent ces divulgations optionnelles. | Problème (application/problem+json) ; en-têtes : Retry-After, RateLimit-Policy, RateLimit |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Lister les demandes de fonctionnalités
Retourne les demandes de fonctionnalités du projet appelant, les plus récentes d’abord, jusqu’à cent. Les soumissions d’un autre projet ne sont jamais retournées. Lire un fil possédé par son ID de rétroaction. Il n’y a pas de curseur de pagination en v1. Chaque soumission porte son statut et les réponses du personnel/agent, les plus anciennes d’abord.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/features'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Demandes de fonctionnalités appartenant au projet appelant. | FeedbackList (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Demander une fonctionnalité
Enregistre une demande de fonctionnalité pour le projet appelant. Les champs propres à une soumission ne peuvent être mis à jour ou supprimés ; ajoutez une correction ou plus d’informations avec une réponse sur le même fil de retour.
Une nouvelle tentative exacte portant la même Idempotency-Key retourne la soumission originale pendant vingt-quatre heures au lieu de créer un doublon, et un corps différent sous cette clé retourne idempotency_mismatch. Chaque soumission est filtrée avant d’être stockée.
Un corps de moins de 12 caractères ou 3 mots retourne submission_too_short ; un texte ne décrivant aucun problème ou demande (caractères aléatoires, frappes au clavier) retourne submission_unclear ; spam, texte avec beaucoup de liens, injection de prompt et texte malveillant retournent submission_rejected.
Une soumission refusée n’est pas stockée, son détail de problème ne répète jamais le texte soumis, et une nouvelle tentative exacte sous le même Idempotency-Key renvoie le même refus.
Ne jamais placer de justificatifs, cookies, en-têtes d’autorisation, nonces d’achèvement, URL signées ou clés d’objet dans le titre, le corps ou le contexte ; le texte en forme de justificatif (jetons ScreenRig, JWT, jetons porteurs, clés cloud et API, clés privées) est remplacé par [caviardé] avant que la soumission soit stockée, et la réponse porte le texte caviardé.
Lorsque le modèle de filtrage est brièvement indisponible, la soumission est acceptée et mise en attente pour un nouveau filtrage en arrière-plan ; après plusieurs acceptations similaires en une heure, le projet reçoit submission_screening_unavailable (500, Retry-After) et réessaie la même requête plus tard.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| ScreenRig-Project | en-tête | optionnel | Obsolète pour une version. Doit être cohérent avec les droits JWT des projets ; ajoute les en-têtes Deprecation et Warning. Pas d’échange de jeton. |
| Idempotency-Key | en-tête | obligatoire |
Champs du corps de la requête
| Champ | Description |
|---|---|
| titre (obligatoire, chaîne) | Résumé sur une seule ligne. Les espaces en début et fin sont supprimés, et les caractères de contrôle sont refusés. minLength : 1 maxLength : 120 |
| corps (obligatoire, chaîne) | Description complète. Saut de ligne et tabulation sont les seuls caractères de contrôle acceptés. minLength : 1 maxLength : 4000 |
| context (optionnel, FeedbackContext) | Enveloppe de diagnostic fermée. Chaque membre est un scalaire contraint optionnel, l’imbrication est structurellement impossible, et un membre inconnu est rejeté avec invalid_request. La forme existe pour qu’un client ne puisse pas persister des valeurs d’argument, des identifiants ou des données d’environnement libres à travers elle. |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/features'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Demande de fonctionnalité stockée. Une nouvelle tentative idempotente exacte renvoie cette même soumission. | FeedbackSubmission (application/json) ; en-têtes : RateLimit-Policy, RateLimit |
| 400 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 422 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 429 | Problème stable rate_limited. Réessayez seulement après l’intervalle Retry-After autoritaire. Les refus à fenêtre fixe incluent aussi la politique RateLimit-Policy applicable et les membres RateLimit ; les refus de concurrence et de budget d’octets omettent ces divulgations optionnelles. | Problème (application/problem+json) ; en-têtes : Retry-After, RateLimit-Policy, RateLimit |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Obtenir le fil de rétroaction
Lire le rapport original et toutes les réponses pour un ID de retour possédé. Un ID ne donne jamais d’autorité sur le projet. Les rapports étrangers et manquants retournent not_found. Les réponses sont du texte brut non fiable.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Le fil complet des commentaires du projet propriétaire, la plus ancienne réponse en premier. | FeedbackSubmission (application/json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Répondre au fil de rétroaction
Ajouter une réponse à un rapport de rétroaction possédé. La preuve vérifiée fournit l’identité de l’auteur ; les appelants ne peuvent pas définir l’auteur, le statut ou la version de correction. Le rapport original et les réponses antérieures restent inchangés. Une réponse rouvre waiting_on_user, les rapports corrigés, refusés et en double ; un rapport « planifié » conserve son statut. Les suivis courts sont permis.
Les formes de justificatif sont expurgées et des contrôles de sécurité contre l’injection/spam s’appliquent. Au maximum 20 réponses au total, chacune de 1 à 2000 caractères. Réponse, statut, événement et accusé de réception de nouvelle tentative s’engagent ensemble ; les nouvelles tentatives exactes sont rejouées pendant 24 heures avant consommation des limites d’entrée, tandis que les charges utiles modifiées retournent idempotency_mismatch.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | |
| Idempotency-Key | en-tête | obligatoire |
Champs du corps de la requête
| Champ | Description |
|---|---|
| texte (requis, chaîne) | Texte brut ; saut de ligne et tabulation sont les seuls caractères de contrôle. minLength : 1 maxLength : 2000 |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID/responses'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Fil de commentaires mis à jour incluant cette réponse. | FeedbackSubmission (application/json) ; en-têtes : RateLimit-Policy, RateLimit |
| 422 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 429 | Problème stable rate_limited. Réessayez seulement après l’intervalle Retry-After autoritaire. Les refus à fenêtre fixe incluent aussi la politique RateLimit-Policy applicable et les membres RateLimit ; les refus de concurrence et de budget d’octets omettent ces divulgations optionnelles. | Problème (application/problem+json) ; en-têtes : Retry-After, RateLimit-Policy, RateLimit |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |