Overviews

Get product overview

Changed on

Returns the AI-generated knowledge page for the product, or null when no overview has been generated yet. The product is resolved by typed prod_… ID. A bare slug resolves only when one org owns it; a slug shared by several orgs returns 409.

get/products/{slug}/overview

Request

  • Base URL: https://api.releases.sh
  • URL: https://api.releases.sh/products/{slug}/overview
  • Auth: none declared

Path parameters

slugstring required

Response

Product overview page, or null when none exists

scope'org' | 'product' required
orgSlugstring nullable
productSlugstring nullable
contentstring required
releaseCountinteger required
lastContributingReleaseAtstring nullable required
generatedAtstring required
updatedAtstring required

Changes

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      response property anyOf[subschema #1]/citations/items/releaseId list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[subschema #1]/citations/items/releaseWebUrl list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[subschema #1]/citations/items/title list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[subschema #1]/lastContributingReleaseAt list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[subschema #1]/orgSlug list-of-types was narrowed by removing types null from media type application/json of response 200

    • info

      response property anyOf[subschema #1]/productSlug list-of-types was narrowed by removing types null from media type application/json of response 200