heyGRC Docs

Пов'язаний документ

Вкажіть heyGRC на DPA або політику, яку ви вже зберігаєте. Цей документ дозволяє короткі цитати з нього в коментарях до pull request, включаючи публічні репозиторії.

heyGRC ніколи не є основним місцем зберігання DPA або політики. Ви зберігаєте цей документ там, де вже керуєте ним. Пов'язаний документ , це знімок, який heyGRC зчитує з цього джерела, щоб pull request, який конфліктує з ним, міг цитувати ваші власні слова, а не запитувати, чи існує DPA.

Пов'язаний документ є необов'язковим. Організація без нього отримує звичайний поточний огляд.

Картка знаходиться на сторінці Компанії на app.heygrc.com, поруч із зобов'язаннями щодо впровадження.


У консолі

Відкрийте Компанія та використайте картку Пов'язаний документ.

  1. Вставте HTTPS-посилання або завантажте файл (текст, Markdown, HTML або PDF, максимум 8 МіБ). PDF через URL відхиляється, завантажте PDF замість цього.
  2. Прочитайте попередження: цей документ використовується в усіх підключених репозиторіях організації, і короткі цитати можуть з'являтися в коментарях до pull request, включаючи публічні репозиторії.
  3. Натисніть Використати цей документ. Вставка посилання або вибір файлу не діє до цього кліку.

Цей клік уповноважує heyGRC зчитувати джерело та, якщо знімок пройшов перевірку, активувати його. Немає списку умов, прапорців для вибору або кроків підтвердження.

Після цього картка може мати один із таких станів:

  • Зчитування. heyGRC отримує та обробляє дані. Якщо в вас уже був активний знімок, огляди продовжують його використовувати, поки оновлення зчитується.
  • Активний. Джерело (URL або ім'я файлу) і дата останнього зчитування. Оновлення вручну: heyGRC не відстежує URL у фоновому режимі.
  • Не вдалося зчитати. Причина, безпечна для публічного доступу, і кнопка Повторити. Огляди залишаються такими, якими були (тільки фреймворк або попередній активний знімок, якщо це було оновлення).
  • Документ прочитано, інтерпретацію утримано Компілятор зафіксував прогалини в інтерпретації, тому неповний знімок ніколи не використовується. Картка відображає причини компілятора. Якщо повʼязаний документ є скороченням, додайте посилання або завантажте повний документ.

Якщо оновлення не вдалося: попередній знімок залишається активним. Картка повідомляє про це разом із датою останнього зчитування.

Видалити зупиняє використання документа в нових оглядах. Коментарі, які вже опубліковані на GitHub, включаючи цитати, залишаються незмінними.

Версія 1.1 не підключається до Google Drive, SharePoint або Vanta. Автоматичне оновлення за розкладом відсутнє.

Як огляд його використовує

Фреймворки все ще працюють. Пов'язаний документ вступає в дію лише тоді, коли diff стосується того, про що йдеться в документі (названий процесор, правило зберігання, регіон, мета).

  • PR лише з CSS або тестами: накладка неактивна. Огляд проводиться за звичайною процедурою.
  • PR, який конфліктує з документом: знахідка цитує короткий дослівний уривок вашого джерела (максимум 120 символів), а не переказ або тіло контракту.
  • PR, який раніше викликав "Я не бачу DPA для цього постачальника", якщо пов'язаний документ покриває цього постачальника: нагадування може зникнути.
  • Постачальник, якого документ ніколи не згадує, вважається невідомим, а не забороненим. Звичайні знахідки фреймворку все ще можуть спрацьовувати.

Короткі цитати вашого документа у ваших pull request , це і є мета, включаючи публічні репозиторії. Не розміщуйте секрети в DPA, який ви пов'язуєте.

Як код (будь-який агент або середовище)

Завантаження доступне лише через консоль. Агенти прикріплюють активне HTTPS-посилання. Для запису потрібен ключ з config:write. Для зчитування потрібен config:read.

GET /v1/review-packs повертає метадані пакета, а також чернетки та підтверджені знімки. Він ніколи не повертає витягнутого тексту джерела.

Надсилання. use за замовчуванням дорівнює true: те саме уповноваження, що й Використати цей документ. Коли компіляція пройшла перевірку, працівник активує знімок. Кінцевої точки підтвердження немає.

curl -X POST https://api.heygrc.com/v1/review-packs \
  -H "Authorization: Bearer $HEYGRC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Vendor DPA 2026",
    "source": { "type": "url", "url": "https://example.com/dpa.md" },
    "use": true
  }'

source.type має бути url. HTTP-URL, облікові дані в URL, приватні або локальні хости відхиляються. Встановіть "use": false, лише якщо ви хочете чернетку, яка не активується (консоль ніколи не робить цього).

Опитуйте GET /v1/review-packs, поки confirmed не з'явиться, або поки чернетка compiler_status не буде failed або needs_review. needs_review ніколи не активується.

DELETE /v1/review-packs видаляє пов'язаний документ. Попередні огляди зберігають цитований текст, який вони вже опублікували, а нові огляди припиняють його використання.

Природний запит для агента: "Наш DPA знаходиться за цим HTTPS-посиланням. Надсилайте його до heyGRC /v1/review-packs із короткою міткою та use true. Опитуйте GET, поки не буде встановлено confirmed або поки чернетка не зазнає збою. Не викликайте /confirm. Не завантажуйте файл. Не розміщуйте тіло контракту на GitHub."

Обмеження

  • Один пов'язаний документ на організацію.
  • Ліміт компіляції: 10 зчитувань на організацію на добу за UTC (429 compile_cap_exceeded).
  • Мітка: від 1 до 80 символів, без керуючих символів.
  • Лише HTTPS-URL, від 12 до 2048 символів, без облікових даних.
  • Завантаження (консоль): текст, Markdown, HTML або PDF, до 8 МіБ.
  • Цитати на GitHub: дослівні уривки джерела, максимум 120 символів, максимум 3 цитати або 360 символів на огляд.

On this page