OpenAPI YAMLOpenAPI JSONproblemi YAMLPanoramica dell’API
Questo gruppo ha 6 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.
Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.
Feedback: bug e richieste di funzionalità
Elenca segnalazioni bug
Restituisce i report di bug del progetto chiamante, dal più recente, fino a cento. Le segnalazioni di altri progetti non sono mai restituite. Leggi un thread di proprietà tramite il suo ID feedback. Non c’è cursore di paginazione in v1. Ogni segnalazione riporta il suo stato e le risposte dello staff/agente, dalla più vecchia.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/bugs'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Segnalazioni di bug di proprietà del progetto chiamante. | FeedbackList (application/json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Segnala bug
Registra un bug report contro il progetto chiamante. I campi della segnalazione non possono essere aggiornati o eliminati; aggiungi una correzione o più informazioni con una risposta nello stesso thread di feedback.
Un retry esatto con la stessa Idempotency-Key restituisce la stessa submission originale per ventiquattro ore invece di creare un duplicato, e un corpo diverso sotto quella chiave restituisce idempotency_mismatch. Ogni submission è controllata prima di essere memorizzata.
Un corpo sotto i 12 caratteri o 3 parole restituisce submission_too_short; testo che non descrive problema o richiesta (caratteri casuali, battitura) restituisce submission_unclear; spam, testo con molti link, injection prompt e testo malevolo restituiscono submission_rejected.
Una sottomissione rifiutata non viene memorizzata, il dettaglio del problema non ripete mai il testo inviato, e un ritentativo esatto con la stessa Idempotency-Key restituisce lo stesso rifiuto.
Non inserire mai credenziali, cookie, header Authorization, nonce di completamento, URL firmati o chiavi oggetto in titolo, corpo o contesto; testo a forma di credenziale (token ScreenRig, JWT, bearer token, chiavi cloud e API, chiavi private) è sostituito con [redacted] prima che la submission sia archiviata, e la risposta riporta il testo redatto.
Quando il modello di screening è temporaneamente non disponibile, la segnalazione viene accettata e trattenuta per un nuovo screening in background; dopo alcune accettazioni simili in un’ora, il progetto riceve submission_screening_unavailable (500, Retry-After) e riprova la stessa richiesta più tardi.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| Idempotency-Key | intestazione | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| titolo (obbligatorio, stringa) | Sommario su una riga. Spazi iniziali e finali rimossi, caratteri di controllo rifiutati. minLength: 1 maxLength: 120 |
| body (obbligatorio, stringa) | Descrizione completa. A capo e tabulazione sono gli unici caratteri di controllo accettati. minLength: 1 maxLength: 4000 |
| context (opzionale, FeedbackContext) | Busta diagnostica chiusa. Ogni membro è uno scalare opzionale vincolato, l’annidamento è strutturalmente impossibile, e un membro sconosciuto è rifiutato con invalid_request. La forma esiste affinché un client non possa persistere valori argomento, credenziali o dati ambiente liberi attraverso di essa. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Rapporto bug archiviato. Un tentativo idempotente esatto restituisce la stessa segnalazione. | FeedbackSubmission (application/json); intestazioni: RateLimit-Policy, RateLimit |
| 400 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 409 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 422 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 429 | Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Elenca richieste di funzionalità
Restituisce le richieste di funzionalità del progetto chiamante, dal più recente, fino a cento. Le segnalazioni di altri progetti non sono mai restituite. Leggi un thread di proprietà tramite il suo ID feedback. Non c’è cursore di paginazione in v1. Ogni segnalazione riporta il suo stato e le risposte dello staff/agente, dalla più vecchia.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/features'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Richieste funzionalità di proprietà del progetto chiamante. | FeedbackList (application/json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Richiedi funzione
Registra una richiesta di funzionalità contro il progetto chiamante. I campi della segnalazione non possono essere aggiornati o eliminati; aggiungi una correzione o più informazioni con una risposta nello stesso thread di feedback.
Un retry esatto con la stessa Idempotency-Key restituisce la stessa submission originale per ventiquattro ore invece di creare un duplicato, e un corpo diverso sotto quella chiave restituisce idempotency_mismatch. Ogni submission è controllata prima di essere memorizzata.
Un corpo sotto i 12 caratteri o 3 parole restituisce submission_too_short; testo che non descrive problema o richiesta (caratteri casuali, battitura) restituisce submission_unclear; spam, testo con molti link, injection prompt e testo malevolo restituiscono submission_rejected.
Una sottomissione rifiutata non viene memorizzata, il dettaglio del problema non ripete mai il testo inviato, e un ritentativo esatto con la stessa Idempotency-Key restituisce lo stesso rifiuto.
Non inserire mai credenziali, cookie, header Authorization, nonce di completamento, URL firmati o chiavi oggetto in titolo, corpo o contesto; testo a forma di credenziale (token ScreenRig, JWT, bearer token, chiavi cloud e API, chiavi private) è sostituito con [redacted] prima che la submission sia archiviata, e la risposta riporta il testo redatto.
Quando il modello di screening è temporaneamente non disponibile, la segnalazione viene accettata e trattenuta per un nuovo screening in background; dopo alcune accettazioni simili in un’ora, il progetto riceve submission_screening_unavailable (500, Retry-After) e riprova la stessa richiesta più tardi.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| Idempotency-Key | intestazione | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| titolo (obbligatorio, stringa) | Sommario su una riga. Spazi iniziali e finali rimossi, caratteri di controllo rifiutati. minLength: 1 maxLength: 120 |
| body (obbligatorio, stringa) | Descrizione completa. A capo e tabulazione sono gli unici caratteri di controllo accettati. minLength: 1 maxLength: 4000 |
| context (opzionale, FeedbackContext) | Busta diagnostica chiusa. Ogni membro è uno scalare opzionale vincolato, l’annidamento è strutturalmente impossibile, e un membro sconosciuto è rifiutato con invalid_request. La forma esiste affinché un client non possa persistere valori argomento, credenziali o dati ambiente liberi attraverso di essa. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Richiesta funzionalità archiviata. Un tentativo idempotente esatto restituisce la stessa segnalazione. | FeedbackSubmission (application/json); intestazioni: RateLimit-Policy, RateLimit |
| 400 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 409 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 422 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 429 | Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Ottieni thread feedback
Leggi il rapporto originale e tutte le risposte per un ID feedback di proprietà. Un ID non concede mai autorità sul progetto. Rapporti esterni o mancanti restituiscono not_found. Le risposte sono testo semplice non attendibile.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| id | path | obbligatorio |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://api.screenrig.ai/api/feedback/RESOURCE_ID'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il thread completo di feedback del progetto proprietario, risposta più vecchia prima. | FeedbackSubmission (application/json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Rispondi al thread feedback
Aggiungi una risposta a un report di feedback di proprietà. La credenziale verificata fornisce l’identità dell’autore; i chiamanti non possono impostare autore, stato o versione di correzione. Il report originale e le risposte precedenti rimangono invariati. Una risposta riapre i report waiting_on_user, risolti, rifiutati e duplicati; un report “pianificato” mantiene il suo stato. Sono consentiti brevi follow-up.
Le forme delle credenziali sono oscurate e si applicano controlli di sicurezza contro iniezioni/spam. Al massimo 20 risposte totali, ciascuna da 1 a 2000 caratteri. Risposta, stato, evento e ricevuta di ritentativo sono impegnati insieme; ritentativi esatti vengono riprodotti per 24 ore prima che i limiti di ingresso siano consumati, mentre payload modificati restituiscono idempotency_mismatch.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| id | path | obbligatorio | |
| Idempotency-Key | intestazione | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| testo (obbligatorio, stringa) | Testo semplice; ritorno a capo e tabulazione sono gli unici caratteri di controllo. minLength: 1 maxLength: 2000 |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Discussione feedback aggiornata includendo questa risposta. | FeedbackSubmission (application/json); intestazioni: RateLimit-Policy, RateLimit |
| 422 | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
| 429 | Problema rate_limited stabile. Ritenta solo dopo l'intervallo Retry-After autorevole. I dinieghi a finestra fissa includono anche RateLimit-Policy e membri RateLimit applicabili; i dinieghi per concorrenza e budget byte omettono tali divulgazioni opzionali. | Problema (application/problem+json); intestazioni: Retry-After, RateLimit-Policy, RateLimit |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |