Skip to content
This repository has been archived by the owner on Feb 17, 2024. It is now read-only.

Remove displayName on API root level #222

Closed
sichvoge opened this issue Jan 11, 2016 · 4 comments
Closed

Remove displayName on API root level #222

sichvoge opened this issue Jan 11, 2016 · 4 comments
Assignees
Milestone

Comments

@sichvoge
Copy link
Contributor

Reading through the RAML 1.0 spec and comparing that to the previous version I wonder why RAML 1.0 allows to have displayName on the API root level now? I believe in 0.8 its been only used to give a "friendly" name to resources, but I don't understand why we should do the same on the API root level since we have title already.

@usarid
Copy link
Contributor

usarid commented Jan 11, 2016

I can't imagine why it would allow that - I don't know where that snuck in but, unless someone can remind us and make a compelling case, let's take it out so it doesn't come back.

On Mon, Jan 11, 2016 at 7:43 AM -0800, "Christian Vogel" notifications@github.com wrote:

Reading through the RAML 1.0 spec and comparing that to the previous version I wonder why RAML 1.0 allows to have displayName on the API root level now? I believe in 0.8 its been only used to give a "friendly" name resources, but I don't understand why we should do the same on the API root level since we have title already.


Reply to this email directly or view it on GitHub.

@sichvoge sichvoge changed the title RAML 1.0 allows displayName on API root level, why? Remove displayName on API root level Feb 17, 2016
@sichvoge
Copy link
Contributor Author

Changed the title to remove the displayName in our next release.

@sichvoge
Copy link
Contributor Author

That is the same for:

  • Library
  • ... (updated if I will find more)

@usarid usarid assigned usarid and sichvoge and unassigned usarid Feb 28, 2016
@sichvoge
Copy link
Contributor Author

consolidated list:

Library -> no displayName
Api -> no displayName (same for all other fragments)
Overlay -> no displayName
Extension -> no displayName
Documentation -> no displayName
Example -> displayName
Type Declaration -> displayName 
Response -> no displayName
Security Scheme -> displayName
Resource Type -> displayName
Resource -> displayName
Trait -> displayName
Method -> displayName
Annotation Type -> displayName

@usarid please let me know if I missed something.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

No branches or pull requests

2 participants