Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update openapi spec with identity and is_anonymous fields #1573

Merged
merged 1 commit into from
May 8, 2024

Conversation

J0
Copy link
Contributor

@J0 J0 commented May 7, 2024

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

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. 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

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.

@J0 J0 requested a review from a team as a code owner May 7, 2024 05:24
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8980123992

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 65.474%

Totals Coverage Status
Change from base Build 8973487260: 0.0%
Covered Lines: 8365
Relevant Lines: 12776

💛 - Coveralls

@J0 J0 merged commit 86a79df into master May 8, 2024
3 checks passed
@J0 J0 deleted the j0/update_openapi_schema branch May 8, 2024 04:06
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants