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

What does it mean to be self-contained? I think it suggests that you must consider carefully how you manage the protos and leverage shared definitions. But OpenAPI is more relaxed, and it is possible that your document is a description not a definition. #172

Open
rofrankel opened this issue Apr 19, 2024 · 0 comments

Comments

@rofrankel
Copy link
Collaborator

          What does it mean to be self-contained? I think it suggests that you must consider carefully how you manage the protos and leverage shared definitions. But OpenAPI is more relaxed, and it is possible that your document is a description not a definition. 

What if we refocused this AEP to describe how to use shared components across multiple APIs? Something like:

  • When might you wish to share responsibility for describing or defining an API across multiple documents?
  • What processes might you need to ensure that any upstream changes make their way to production, documentation, and other downstream artifacts?
  • What special review processes may apply in these shared responsibility situations?

Originally posted by @earth2marsh in #134 (comment)

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

No branches or pull requests

1 participant