{"openapi":"3.1.0","info":{"title":"Bay Parcel: addresses, deliveries and ForgetMe v1","version":"1"},"servers":[{"url":"https://company.forget.stellarminds.ai"}],"components":{"securitySchemes":{"poppy":{"type":"oauth2","description":"Account access per Poppy 1.0 section 4. Every request also carries the Poppy-Session header (section 5).","flows":{"clientCredentials":{"tokenUrl":"https://company.forget.stellarminds.ai/oauth/token","scopes":{"forget-me:item":"Withdraw a record you shared, by the opaque reference Bay Parcel issued for it, and read the evidence","forget-me:account":"Withdraw everything Bay Parcel holds for your account; granted separately, never implied","addresses":"See the delivery addresses Bay Parcel holds for you, share one, and book a delivery"}}}}}},"paths":{"/api/addresses":{"get":{"summary":"The addresses and deliveries held for the account","security":[{"poppy":["addresses"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}},"post":{"summary":"Share an address (a reference comes back)","security":[{"poppy":["addresses"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}},"/api/deliveries":{"post":{"summary":"Book a delivery to a held address","security":[{"poppy":["addresses"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}},"/api/lookup":{"get":{"summary":"Where the courier would deliver now","security":[{"poppy":["addresses"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}},"/api/addresses/{id}/restore":{"post":{"summary":"The undo path a withdrawal must defeat","security":[{"poppy":["addresses"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}},"/forget-me/v1/preview":{"post":{"summary":"ForgetMe v1 preview: what a withdrawal would touch; no side effects","security":[{"poppy":["forget-me:item"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}},"/forget-me/v1/submit":{"post":{"summary":"ForgetMe v1 submit: destructive; performed only with an approval of its exact terms","security":[{"poppy":["forget-me:item"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required; approval_required with the operation, or approval_declined (Operations extension, version 3)"},"202":{"description":"the approved operation, accepted"}}}},"/forget-me/v1/operations/{id}":{"get":{"summary":"ForgetMe v1 operation status (owner-scoped)","security":[{"poppy":["forget-me:item"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}},"/forget-me/v1/operations/{id}/evidence":{"get":{"summary":"ForgetMe v1 evidence: the portable receipts (owner-scoped)","security":[{"poppy":["forget-me:item"]}],"responses":{"200":{"description":"OK"},"400":{"description":"invalid_session, session_ended, version_unsupported, or a ForgetMe error"},"401":{"description":"no or invalid access token (WWW-Authenticate)"},"403":{"description":"insufficient_scope or extension_required"}}}}},"x-forget-me":{"index":"https://company.forget.stellarminds.ai/forget-me/v1","contract":"https://github.com/Sharathvc23/forgetproof/blob/main/docs/extension.md"}}