API reference
Update a repository
Dashboard
BetaWe just launched Apps: hosted models, actions and pages, on the same bill as your inference.Read the Apps docs

Update a repository

PATCHhttps://api.inferencebureau.com/v1/auditor/repos/{owner}/{name}

Change one repository's Auditor setup: turn reviews on or off, and set up its Shopify theme previews and theme documentation. Send only what changes; the response is the repository's setup afterwards, as Get a repository returns it.

Body

application/json, up to 64 KiB; every field optional, unknown fields refused
  • enabledbooleanoptional

    Whether Auditor reviews the repository's pull requests. Turning the first repository on sets Auditor up for the team.

  • theme_preview.enabledbooleanoptional

    Theme previews on or off. On needs a store and a way to reach it.

  • theme_preview.storestringoptional

    The store's permanent domain, such as inference-bureau.myshopify.com. A new store needs its Theme Access password in the same request.

  • theme_preview.theme_access_passwordstringoptional

    Checked against the store, then stored encrypted; the repository then reaches the store with it. Never returned.

  • theme_preview.storefront_passwordstring | nulloptional

    For a store behind its password page, used only to load the pages Auditor checks. null removes it.

  • theme_preview.theme_idstring | nulloptional

    Push every pull request to this one unpublished theme instead of a theme each. Null: a theme each.

  • theme_preview.theme_prefixstringoptional

    Put before the branch name in each preview theme's name. Up to 20 characters.

  • theme_preview.pagesstring[]optional

    Storefront paths checked after each deploy, up to 8, replacing the list.

  • theme_preview.buildobject | nulloptional

    { install, command, dir, node }: how the repository becomes a theme. null lets Auditor work it out again on the next deploy.

  • theme_preview.comparebooleanoptional

    Compare the branch with the store's published theme after each deploy.

  • theme_preview.content_checkbooleanoptional

    Check what each pull request removes against the merchant content on the store. Default true.

  • theme_preview.generatedstring[]optional

    Paths inside the theme of files Shopify's AI makes on the store, compared and pulled with the content files.

  • theme_preview.delete_on_close, skip_forks, max_themesoptional

    As on the Shopify tab.

  • theme_docs.enabledbooleanoptional

    Theme documentation on or off. On needs the store set under theme_preview, even with previews off.

  • theme_docs.regenerateobjectoptional

    { push, daily }: when the guide is written again.

  • theme_docs.max_run_usd, captures, nameoptional

    A run's spending limit, whether sections are pictured, and the guide's name. Logos, colours and page edits are set in the console.

Notes

  • Orderoptional

    Passwords are stored first, then the preview and documentation settings, then enabled. A step that is refused stops the rest and answers with why; steps before it stay done.

  • Keyoptional

    Needs a key with Auditor Permissions. Every change is in the team's audit log under that key.

  • Errorsoptional

    400 invalid_request for a setting Auditor cannot take or a password the store refused; 404 not_found for a repository outside the team's installation; 413 payload_too_large for a body over 64 KiB.