feat: update openapi spec with identity and is_anonymous fields #1573
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull Request Test Coverage Report for Build 8980123992Details
💛 - Coveralls |
kangmingtay
approved these changes
May 7, 2024
J0
pushed a commit
that referenced
this pull request
May 22, 2024
🤖 I have created a release *beep* *boop* --- ## [2.152.0](v2.151.0...v2.152.0) (2024-05-22) ### Features * new timeout writer implementation ([#1584](#1584)) ([72614a1](72614a1)) * remove legacy lookup in users for one_time_tokens (phase II) ([#1569](#1569)) ([39ca026](39ca026)) * update chi version ([#1581](#1581)) ([c64ae3d](c64ae3d)) * update openapi spec with identity and is_anonymous fields ([#1573](#1573)) ([86a79df](86a79df)) ### Bug Fixes * improve logging structure ([#1583](#1583)) ([c22fc15](c22fc15)) * sms verify should update is_anonymous field ([#1580](#1580)) ([e5f98cb](e5f98cb)) * use api_external_url domain as localname ([#1575](#1575)) ([ed2b490](ed2b490)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
uxodb
pushed a commit
to uxodb/auth
that referenced
this pull request
Nov 13, 2024
…base#1573) ## What kind of change does this PR introduce? Adds the `Identity` and `is_anonymous` fields to OpenAPI spec. This is so we can use the `openapi.yml` as a sgeneral reference from which to generate Hook Payloads, which contain `User` objects. Identity Fields taken from the [identity model](https://github.com/supabase/auth/blob/master/internal/api/identity.go) ## More Context User objects are generated by: 1. Converting the `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](https://www.npmjs.com/package/yaml-to-json-schema). 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) 2. Using [JSONSchema to generate a fake payload](https://json-schema-faker.js.org/) ## 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.
uxodb
pushed a commit
to uxodb/auth
that referenced
this pull request
Nov 13, 2024
🤖 I have created a release *beep* *boop* --- ## [2.152.0](supabase/auth@v2.151.0...v2.152.0) (2024-05-22) ### Features * new timeout writer implementation ([supabase#1584](supabase#1584)) ([72614a1](supabase@72614a1)) * remove legacy lookup in users for one_time_tokens (phase II) ([supabase#1569](supabase#1569)) ([39ca026](supabase@39ca026)) * update chi version ([supabase#1581](supabase#1581)) ([c64ae3d](supabase@c64ae3d)) * update openapi spec with identity and is_anonymous fields ([supabase#1573](supabase#1573)) ([86a79df](supabase@86a79df)) ### Bug Fixes * improve logging structure ([supabase#1583](supabase#1583)) ([c22fc15](supabase@c22fc15)) * sms verify should update is_anonymous field ([supabase#1580](supabase#1580)) ([e5f98cb](supabase@e5f98cb)) * use api_external_url domain as localname ([supabase#1575](supabase#1575)) ([ed2b490](supabase@ed2b490)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Identityandis_anonymousfields to OpenAPI spec. This is so we can use theopenapi.ymlas a sgeneral reference from which to generate Hook Payloads, which containUserobjects.Identity Fields taken from the identity model
More Context
User objects are generated by:
openapi.ymlinto 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.