KOkobaltlabs
marketing-guidelines

Get Guideline

Changed on

One guideline's requirements, in the order they were extracted.

Polled by the detail view while a decomposition runs, which is exactly when the previous generation has just been retired — so state is not a convenience. Every regeneration leaves another permanent generation behind, and without a filter here the payload carries all of them and the browser discards most of it, on every poll. superseded_with_human_edits is counted separately so the surface can still offer to show them.

Carries no presigned URL: signing is not idempotent, so a URL on a polled payload changes every tick and remounts the document viewer. The viewer gets its URL from usePreviewUrl.

get/marketing/guidelines/documents/{file_id}

Request

  • Base URL
    https://api.kobaltlabs.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.kobaltlabs.com/marketing/guidelines/documents/{file_id}
  • Auth
    none declared

Path parameters

file_idstring uuid required

Query parameters

stateGuidelineRequirementState[] nullable

Response

Successful Response

superseded_with_human_editsinteger required

Changes

  • eb329fb4c94aRevision changes
    • warning

      added the new selecting enum value to the /// response property for the response status

  • 425d5b8a3c17Revision changes
    • breaking

      response property requirements/items/decomposition_id list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      added the new approved enum value to the // response property for the response status

    • warning

      added the new proposed enum value to the // response property for the response status

    • warning

      added the new proposed enum value to the // response property for the response status

    • info

      added the enum value proposed to the property anyOf[subschema #1]/items/ of the query request parameter state

    • info

      added the optional property / to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status