Skip to content
This repository has been archived by the owner on Sep 28, 2022. It is now read-only.

Update docs #108

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Update docs #108

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0bdccd6
Update docs
postatum Feb 24, 2016
a533abb
Update raml.rst
jstoiko May 17, 2016
55031a2
Update raml.rst
jstoiko May 17, 2016
b446b7b
Update getting_started.rst
jstoiko May 17, 2016
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
15 changes: 15 additions & 0 deletions docs/source/raml.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,18 @@ You can link your schema definition for each resource by adding it to the ``post
schema: !include schemas/items.json


Generated model names
---------------------

Because ramses automatically generates DB model names from RAML resources, it might be useful to understand how those names are generated.

Here are few examples that should make it self-explanatory:

.. code-block:: yaml

/users -> User
/alienusers -> Alienusers
/alien-users -> AlienUser
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful if some backgrond about the rationale of such mapping is provided.



This might come handy when trying to access models from ramses event handlers for example.