Skip to content
This repository has been archived by the owner on Oct 1, 2018. It is now read-only.

Snowcrash should detect identifiers with disallowed characters and warn #340

Closed
kylef opened this issue Jul 14, 2015 · 2 comments
Closed

Comments

@kylef
Copy link
Member

kylef commented Jul 14, 2015

Take the following blueprint:

## Test Resource [/test]
### Testing action (foo) [GET]

adfsdf

This will result in a single resource without any actions. The action is silently treated as the description because it is using characters not permitted in the identifier.

{
  "element": "resource",
  "name": "Test Resource",
  "description": "### Testing action (foo) [GET]\n\nadfsdf"
}

I think instead, we should detect the [GET] and understand the user probably wants this to be an action. In this case throw a warning that the action name is using the reserved characters ( and ).

@zdne
Copy link
Contributor

zdne commented Jul 21, 2015

I believe this should be covered by the issues of this milestone https://github.com/apiaryio/snowcrash/milestones/Keywords%20&%20Identifiers , can you confirm?

@kylef
Copy link
Member Author

kylef commented Jul 21, 2015

Yes, this is a dupe of #41.

@kylef kylef closed this as completed Jul 21, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants