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.

Sign up for GitHub

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

Jump to bottom

Add a FAQ #550

Merged
merged 4 commits into from
Apr 27, 2018
Merged

Add a FAQ #550

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c2666c
Add a FAQ
achew22 Feb 16, 2018
e8efd6d
Linkify POLA
achew22 Feb 16, 2018
d81af4a
Remove FAQ from README.md
achew22 Apr 27, 2018
5589a82
Address reviewer feedback
achew22 Apr 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/_docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
category: documentation
---

# FAQ

> Why are the models in the swagger specification prefixed with the last part of the proto package name?

The reason to generate the prefixes is that we don't have a guaranteed unique namespace. If two packages produce different Foo messages then we will have trouble.

> Why not strip the prefix?

When a message is added which happens to conflict with another message (e.g. by importing a message with the same name from a different package) it will break code that is very far away from the code that changed. This is in an effort to adhere to the [principle of least astonishment](https://en.wikipedia.org/wiki/Principle_of_least_astonishment).