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

Typo in documentation #23

Closed
JDruery opened this issue Apr 22, 2015 · 3 comments
Closed

Typo in documentation #23

JDruery opened this issue Apr 22, 2015 · 3 comments

Comments

@JDruery
Copy link
Contributor

JDruery commented Apr 22, 2015

Given the RAML example, the linked GET examples should be "GET /users/1/links/posts" (not "linked"). When I made that change everything works as described.

I've also noticed that the example bundle defines a resource type ("collection") but then it doesn't actually use it in main api.raml file. This makes me wonder if resource types are still a work in progress. When I attempted to use the "collection" resource type on a resource I keep getting the following error: "The resource type declaration is neither a string nor a map." I might be doing something wrong, but if it's the case that resource types are not yet supported then it would be helpful it could please be noted in the docs (just to save us from spending too much time on trying to make it work before it's ready).

I realize I've been putting in issues without helping out by contributing any pull requests. I don't feel that confident using git just yet (sorry), but hopefully in future I might learn enough to be able to help. Thanks again for a fantastic bundle, very appreciated.

@skqr
Copy link
Contributor

skqr commented Apr 24, 2015

Hi @JDruery!

Don't worry, any involvement is contribution 😺

I'm currently not maintaining this package, although the guys at GOintegro are.

However - have you checked out the https://github.com/skqr/hateoas-bundle-example project?

It has at least one api.raml example, and might help you.

On the documentation, you're completely right. You can edit that right on the GitHub page. Just browse to that file and hit the pencil icon to edit it on the spot. When saving, you'll be prompted to create a pull request.

Thanks again!

@JDruery
Copy link
Contributor Author

JDruery commented Apr 26, 2015

Thanks, glad to be of help :) Thanks also for the tips. I've been following the example bundle, especially the test cases and it's very helpful. I'll put in the correction for that typo, didn't realize it's so easy to create a pull request.

@acmenna
Copy link
Contributor

acmenna commented Jun 17, 2015

#24

@acmenna acmenna closed this as completed Jun 17, 2015
ben-challis pushed a commit to ben-challis/hateoas that referenced this issue Oct 24, 2016
…hrough-raml

[API-58] RAML YPath (more, still partial)
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

3 participants