-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
added language section #639
Conversation
Perhaps we could reference a spec like http://tools.ietf.org/html/rfc1766 to define the valid values of the language property. |
type: string | ||
enum: | ||
- en-us | ||
- es |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, why not simply a map of links?
languages:
current: en-us
supportedLanguages:
es: ./openapi.yaml?lang=es
en-us: ./openapi.yaml?lang=en-us
Is this trying to avoid mentioning the own file-name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
many use the header, so you can't describe it like such. I'll see if we can use a filename optionally.
Perhaps this should move under the Regardless, I don't think this answers #70. It seems to talk about the API data, not the spec itself and its descriptions. Not sure this should make it in, seems a bit fringe (unless I don't follow the use case). |
@OAI/tdc looking into this more, I'm going to propose we close it and don't merge. If that's fine, please reject this PR. |
👎 |
I worry about confusion between language support in the API vs in the documentation. For example, there are only certain languages supported in some APIs (where localized content is provided), but the docs might only be in English (http://developer.uship.com is a great example of this, albeit hard to look at their docs). Additionally, it would need to made clear how to change that APIs language (i.e. Even if we were to include this, I would rename it to something like IMO there is a bigger discussion about documentation-specifics leaking into the spec, vs API contract (which is a way higher priority). I'm 👎 on this as it stands. |
I believe this needs more thought. Closing per feedback. |
👎 |
The need coming from the #70 issue is do describe the language used in the data returned by the API. |
Fixes #70