Purplebricks · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Purplebricks.Viewings.Api 1.0 - Customer Experience

16 actions 16 updates documentation extends openapi/purplebricks-viewings-v1-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Purplebricks's API. It is a proposal applied on top of the contract, not a document Purplebricks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-apievangelist-sourcex-apievangelist-harvestedx-apievangelist-accessx-apievangelist-swagger-ui

Targets 16

$.info
$.paths['/v1/accessdetails/{propertyId}'].get
$.paths['/v1/accessdetails/{propertyId}'].post
$.paths['/v1/accessdetails/{propertyId}/summary'].get
$.paths['/v1/accessdetails/{propertyId}/revealkeysafecode'].get
$.paths['/v1/appointments'].post
$.paths['/v1/appointments/cancel'].post
$.paths['/v1/bland/viewing'].post
$.paths['/v1/bland/viewing/confirmrequestslot'].post
$.paths['/v1/bland/viewing/reschedulerequestslot'].post
$.paths['/v1/properties/{propertyId}/opendays/upcoming'].get
$.paths['/v1/properties/{propertyId}/opendays/past'].get
$.paths['/v1/properties/{propertyId}'].get
$.paths['/v1/creatio/properties/{propertyId}/viewings'].get
$.paths['/v1/creatio/users/{userId}/viewings'].get
$.paths['/v1/creatio/users/{userId}/viewings/feedback'].get

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Purplebricks.Viewings.Api 1.0 - Customer Experience
  version: 1.0.0
extends: openapi/purplebricks-viewings-v1-openapi.yml
x-generated: '2026-07-26'
x-method: generated
x-note: Adds provenance metadata, a verified servers[] entry where the harvested document omitted or malformed it,
  and 15 derived operationId values. The upstream Purplebricks documents declare almost no operationIds, summaries
  or descriptions; this overlay never mutates the harvested original.
actions:
- target: $.info
  update:
    x-apievangelist-source: https://api.purplebricks.co.uk/viewings-api/swagger/v1/swagger.json
    x-apievangelist-harvested: '2026-07-26'
    x-apievangelist-access: publicly-served, Bearer-token protected, no public key issuance and no developer programme
    x-apievangelist-swagger-ui: https://api.purplebricks.co.uk/viewings-api/swagger/index.html
- target: $.paths['/v1/accessdetails/{propertyId}'].get
  update:
    operationId: getV1AccessdetailsPropertyId
- target: $.paths['/v1/accessdetails/{propertyId}'].post
  update:
    operationId: postV1AccessdetailsPropertyId
- target: $.paths['/v1/accessdetails/{propertyId}/summary'].get
  update:
    operationId: getV1AccessdetailsPropertyIdSummary
- target: $.paths['/v1/accessdetails/{propertyId}/revealkeysafecode'].get
  update:
    operationId: getV1AccessdetailsPropertyIdRevealkeysafecode
- target: $.paths['/v1/appointments'].post
  update:
    operationId: postV1Appointments
- target: $.paths['/v1/appointments/cancel'].post
  update:
    operationId: postV1AppointmentsCancel
- target: $.paths['/v1/bland/viewing'].post
  update:
    operationId: postV1BlandViewing
- target: $.paths['/v1/bland/viewing/confirmrequestslot'].post
  update:
    operationId: postV1BlandViewingConfirmrequestslot
- target: $.paths['/v1/bland/viewing/reschedulerequestslot'].post
  update:
    operationId: postV1BlandViewingReschedulerequestslot
- target: $.paths['/v1/properties/{propertyId}/opendays/upcoming'].get
  update:
    operationId: getV1PropertiesPropertyIdOpendaysUpcoming
- target: $.paths['/v1/properties/{propertyId}/opendays/past'].get
  update:
    operationId: getV1PropertiesPropertyIdOpendaysPast
- target: $.paths['/v1/properties/{propertyId}'].get
  update:
    operationId: getV1PropertiesPropertyId
- target: $.paths['/v1/creatio/properties/{propertyId}/viewings'].get
  update:
    operationId: getV1CreatioPropertiesPropertyIdViewings
- target: $.paths['/v1/creatio/users/{userId}/viewings'].get
  update:
    operationId: getV1CreatioUsersUserIdViewings
- target: $.paths['/v1/creatio/users/{userId}/viewings/feedback'].get
  update:
    operationId: getV1CreatioUsersUserIdViewingsFeedback