Purplebricks · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Purplebricks Account API 1 - Platform

16 actions 16 updates documentation extends openapi/purplebricks-account-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/auth'].get
$.paths['/v1/emailconfirmation/getemailconfirmationdata/{token}'].get
$.paths['/v1/expertcreated'].post
$.paths['/v1/marketingpreferences/{publicUserId}'].get
$.paths['/v1/marketingpreferences'].put
$.paths['/v1/phoneverification/status'].get
$.paths['/v1/phoneverification/send'].post
$.paths['/v1/phoneverification/manual-verify/{userId}'].post
$.paths['/v1/phoneverification/verify'].post
$.paths['/v1/user/isusernametaken'].get
$.paths['/v1/user/sendpasswordreset'].post
$.paths['/v1/user/resendemailconfirmation'].post
$.paths['/v1/user/requestaccountdeletion'].post
$.paths['/v1/user/changeemail'].post
$.paths['/v1/user'].post

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Purplebricks Account API 1 - Platform
  version: 1.0.0
extends: openapi/purplebricks-account-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/account-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/account-api/swagger/index.html
- target: $.paths['/v1/auth'].get
  update:
    operationId: getV1Auth
- target: $.paths['/v1/emailconfirmation/getemailconfirmationdata/{token}'].get
  update:
    operationId: getV1EmailconfirmationGetemailconfirmationdataToken
- target: $.paths['/v1/expertcreated'].post
  update:
    operationId: postV1Expertcreated
- target: $.paths['/v1/marketingpreferences/{publicUserId}'].get
  update:
    operationId: getV1MarketingpreferencesPublicUserId
- target: $.paths['/v1/marketingpreferences'].put
  update:
    operationId: putV1Marketingpreferences
- target: $.paths['/v1/phoneverification/status'].get
  update:
    operationId: getV1PhoneverificationStatus
- target: $.paths['/v1/phoneverification/send'].post
  update:
    operationId: postV1PhoneverificationSend
- target: $.paths['/v1/phoneverification/manual-verify/{userId}'].post
  update:
    operationId: postV1PhoneverificationManualVerifyUserId
- target: $.paths['/v1/phoneverification/verify'].post
  update:
    operationId: postV1PhoneverificationVerify
- target: $.paths['/v1/user/isusernametaken'].get
  update:
    operationId: getV1UserIsusernametaken
- target: $.paths['/v1/user/sendpasswordreset'].post
  update:
    operationId: postV1UserSendpasswordreset
- target: $.paths['/v1/user/resendemailconfirmation'].post
  update:
    operationId: postV1UserResendemailconfirmation
- target: $.paths['/v1/user/requestaccountdeletion'].post
  update:
    operationId: postV1UserRequestaccountdeletion
- target: $.paths['/v1/user/changeemail'].post
  update:
    operationId: postV1UserChangeemail
- target: $.paths['/v1/user'].post
  update:
    operationId: postV1User