HM Courts & Tribunals Service · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Crime Hearing Results Document Subscription API

9 actions 9 updates update extends ../openapi/_original/hmcts-crime-hearing-results-document-subscription-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for HM Courts & Tribunals Service's API. It is a proposal applied on top of the contract, not a document HM Courts & Tribunals Service publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-hintx-providerx-api-evangelist

Targets 9

$.info
$.paths['/event-types'].get
$.paths['/client-subscriptions'].post
$.paths['/client-subscriptions/{clientSubscriptionId}'].get
$.paths['/client-subscriptions/{clientSubscriptionId}'].put
$.paths['/client-subscriptions/{clientSubscriptionId}'].delete
$.paths['/notifications'].post
$.paths['/client-subscriptions/{clientSubscriptionId}/secret/rotate'].post
$.paths['/client-subscriptions/{clientSubscriptionId}/documents/{documentId}'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Crime Hearing Results Document Subscription API
  version: 1.0.0
extends: ../openapi/_original/hmcts-crime-hearing-results-document-subscription-openapi.yml
x-generated: '2026-10-09'
x-method: generated
actions:
- target: $.info
  update:
    x-provider: HM Courts & Tribunals Service
    x-api-evangelist:
      aid: hmcts
      profiled: '2026-10-09'
      source_repo: https://github.com/api-evangelist/hmcts
- target: $.paths['/event-types'].get
  update:
    x-agent-hint:
      readOnly: true
      destructive: false
- target: $.paths['/client-subscriptions'].post
  update:
    x-agent-hint:
      readOnly: false
      destructive: false
- target: $.paths['/client-subscriptions/{clientSubscriptionId}'].get
  update:
    x-agent-hint:
      readOnly: true
      destructive: false
- target: $.paths['/client-subscriptions/{clientSubscriptionId}'].put
  update:
    x-agent-hint:
      readOnly: false
      destructive: false
- target: $.paths['/client-subscriptions/{clientSubscriptionId}'].delete
  update:
    x-agent-hint:
      readOnly: false
      destructive: true
- target: $.paths['/notifications'].post
  update:
    x-agent-hint:
      readOnly: false
      destructive: false
- target: $.paths['/client-subscriptions/{clientSubscriptionId}/secret/rotate'].post
  update:
    x-agent-hint:
      readOnly: false
      destructive: false
- target: $.paths['/client-subscriptions/{clientSubscriptionId}/documents/{documentId}'].get
  update:
    x-agent-hint:
      readOnly: true
      destructive: false