feat: update openapi spec with identity and is_anonymous fields #1573
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Adds the
Identity
andis_anonymous
fields to OpenAPI spec. This is so we can use theopenapi.yml
as a sgeneral reference from which to generate Hook Payloads, which containUser
objects.Identity Fields taken from the identity model
More Context
User objects are generated by:
openapi.yml
into JSONSchema. Currently this is done via OpenAI though a modified version of a yml to jsonschema converter should work with modifications as well. We don't use the latter as there's an additional step of converting the output jsonschema into a format that JSON Faker can accept (adding the JSONSchema version etc)Use
The plan is to embed the JSONSchema into each Hook example so developers can copy paste into JSONSchema Faker or similar tool to generate a fake payload.