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

ref: Remove generate-schema command and JSON schema #3974

Merged
merged 2 commits into from
Sep 2, 2024

Conversation

jan-auer
Copy link
Member

@jan-auer jan-auer commented Sep 2, 2024

As it was not used in an automated context, we're removing the generated JSON
schema for the event protocol. This resolves inconsistencies in the
documentation of our event protocol and also improves our compile times through
fewer derives.

We will subsequently improve the documentation of Relays types and work on a
replacement mechanism to publish docs for these types. In the meanwhile,
documentation can be viewed here:
https://getsentry.github.io/relay/relay_event_schema/protocol/index.html

See also getsentry/sentry-docs#11201

@jan-auer jan-auer force-pushed the ref/remove-jsonschema branch from 03c3624 to e4b8f72 Compare September 2, 2024 13:39
Copy link
Member

@jjbayer jjbayer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed offline, if we're going to link to Relay docs from SDK / develop docs we should go over all the event fields and document whether they are supposed to be set by the SDK or Relay-only.

@jan-auer jan-auer enabled auto-merge (squash) September 2, 2024 13:47
@jan-auer jan-auer merged commit 743d4b1 into master Sep 2, 2024
23 checks passed
@jan-auer jan-auer deleted the ref/remove-jsonschema branch September 2, 2024 13:53
jjbayer added a commit that referenced this pull request Sep 3, 2024
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.

3 participants