Skip to content

Add x-auditable information to common.yaml schemas #28

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

arispoloway
Copy link

@arispoloway arispoloway commented Mar 28, 2025

A number of teams reference these schemas internally (particularly uuid and identifier), and it's somewhat challenging to add information about auditability without updating all of those references.

I left off user information aside from username and email, but basically everything else here should be fine to audit.

@kodster28
Copy link

Heyo, looks like this has the same problem as #27

(this is a read-only public repo)

@arispoloway
Copy link
Author

I thought just the openapi.(yaml|json) files were updated automatically? I saw #21 as the last update to this file, so I figured we were supposed to update it here

@kodster28
Copy link

Oh, maybe!

@jacobbednarz would know!

@jacobbednarz
Copy link
Member

we're having a somewhat related conversation internally about these common components as we're looking to limit the amount of reuse we have in the schemas. it's causing modelling issues due to people blindly copy/pasta components and making the documentation and SDKs harder to debug. depending on how urgent this is, i'd hold off in case we remove this in favour of something else.

@arispoloway
Copy link
Author

Gotcha - the reuse has been annoying for us as well - until teams actually stop using the references, there's not really a way for us to mark those fields as auditable beyond updating the referenced components.

I'm happy to hold off for a little bit while y'all settle on a direction here, but I just want to make sure that eventually the teams referencing these components (identifier and uuid especially) have those fields marked as auditable, whether that be through a change here, or replacing all the references, or something else.

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