Define RAML properties to allow runing Ra tests

example.raml

@@ -5,127 +5,329 @@ documentation:
     - title: Home
       content: |
         Welcome to the example API.
-baseUri: http://{host}:{port}/{version}
+baseUri: http://localhost:6543/api
 version: v1
 mediaType: application/json
 protocols: [HTTP, HTTPS]
-securitySchemes:
-    - x_token_auth:
-        description: Authorization header token policy
-        type: x-ApiKey
-    - x_ticket_auth:
-        description: Standard Pyramid Auth Ticket policy
-        type: x-Ticket
-        settings:
-            secret: auth_tkt_secret
-            hashalg: sha512
-            cookie_name: ramses_auth_tkt
-            http_only: true
-    - read_only_users:
-        description: ACL that allows authenticated users to read collection
-        type: x-ACL
-        settings:
-            collection: |
-                allow admin all
-                allow authenticated get
-            item: |
-                allow admin all
-                allow authenticated get
-    - read_only_useritem_everyone:
-        description: ACL that allows everyone to read item, authenticated users to read collection
-        type: x-ACL
-        settings:
-            collection: |
-                allow admin all
-                allow authenticated get
-            item: |
-                allow admin all
-                allow everyone get
-                allow {{user_self}} patch
+securitySchemes: !include inclusions/yaml/security_schemes.yaml
 securedBy: [x_ticket_auth]
 
 /stories:
     securedBy: [read_only_users]
     displayName: All stories
     get:
         description: Get all stories
+        queryParameters: !include inclusions/yaml/collection_query_params.yaml
+        responses:
+            200:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/collection_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     post:
         description: Create a new story
+        queryParameters:
+            _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
         body:
             application/json:
-                schema: !include schemas/story.json
+                schema: !include inclusions/schemas/story.json
+                example: !include inclusions/examples/story_body_example.json
+        responses:
+            201:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/story_item_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     patch:
         description: Update multiple stories
-    delete:
-        description: Delete multiple stories
+        queryParameters:
+            _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            _limit:
+                displayName: Limit
+                type: integer
+                required: true
+                example: 5
+        body:
+            application/json:
+                example: !include inclusions/examples/story_body_example.json
+        responses:
+            200:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/collection_patch_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     head:
         description: Determine whether a given resource is available
+        queryParameters: !include inclusions/yaml/collection_query_params.yaml
+        responses:
+            200:
+                headers: !include inclusions/yaml/demo_headers.yaml
     options:
         description: Retrieve the available HTTP verbs for a given resource
-
+        responses: !include inclusions/yaml/options_responses.yaml
+    delete:
+        description: Delete multiple stories
+        queryParameters:
+            q:
+                displayName: Query
+                type: string
+                required: false
+                example: foobar
+                minLength: 1
+            _limit:
+                displayName: Limit
+                type: integer
+                required: true
+                minimum: 1
+                example: 10
+            _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+        responses:
+            200:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/collection_delete_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     /{id}:
         displayName: One story
+        uriParameters:
+           id:
+               displayName: StoryID
+               type: integer
         get:
             description: Get a particular story
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/story_item_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
         delete:
             description: Delete a particular story
+            queryParameters:
+                _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/item_delete_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
         patch:
-        put:
             description: Update a particular story
+            queryParameters:
+                _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            body:
+                application/json:
+                    example: !include inclusions/examples/story_body_example.json
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/story_item_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
+        put:
+            description: Replace a particular story
+            queryParameters:
+                _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            body:
+                application/json:
+                    schema: !include inclusions/schemas/story.json
+                    example: !include inclusions/examples/story_body_example.json
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/story_item_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
         head:
             description: Determine whether a given resource is available
+            responses:
+                200:
+                    headers: !include inclusions/yaml/demo_headers.yaml
         options:
             description: Retrieve the available HTTP verbs for a given resource
+            responses: !include inclusions/yaml/options_responses.yaml
 
 /users:
     securedBy: [read_only_useritem_everyone]
     displayName: All users
     get:
         description: Get all users
+        queryParameters: !include inclusions/yaml/collection_query_params.yaml
+        responses:
+            200:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/collection_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     post:
         description: Create a new user
+        queryParameters:
+            _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
         body:
             application/json:
-                schema: !include schemas/user.json
+                schema: !include inclusions/schemas/user.json
+                example: !include inclusions/examples/user_body_example.json
+        responses:
+            201:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/user_item_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     patch:
         description: Update multiple users
+        queryParameters:
+            _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            _limit:
+                displayName: Limit
+                type: integer
+                required: true
+                example: 5
+        body:
+            application/json:
+                example: !include inclusions/examples/user_body_example.json
+        responses:
+            200:
+                body:
+                    application/json:
+                        schema: !include inclusions/schemas/collection_patch_response.json
+                headers: !include inclusions/yaml/demo_headers.yaml
     head:
         description: Determine whether a given resource is available
+        queryParameters: !include inclusions/yaml/collection_query_params.yaml
+        responses:
+            200:
+                headers: !include inclusions/yaml/demo_headers.yaml
     options:
         description: Retrieve the available HTTP verbs for a given resource
+        responses: !include inclusions/yaml/options_responses.yaml
 
     /{username}:
         displayName: One user
+        uriParameters:
+           id:
+               displayName: Username
+               type: string
         get:
             description: Get a particular user
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/user_item_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
         patch:
-        put:
             description: Update a particular user
+            queryParameters:
+                _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            body:
+                application/json:
+                    example: !include inclusions/examples/user_body_example.json
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/user_item_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
+        put:
+            description: Replace a particular user
+            queryParameters:
+                _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            body:
+                application/json:
+                    schema: !include inclusions/schemas/user.json
+                    example: !include inclusions/examples/user_body_example.json
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/user_item_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
         delete:
             description: Delete a particular user
-
+            queryParameters:
+                _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+            responses:
+                200:
+                    body:
+                        application/json:
+                            schema: !include inclusions/schemas/item_delete_response.json
+                    headers: !include inclusions/yaml/demo_headers.yaml
         /settings:
             displayName: User settings
             get:
                 description: Get all settings of a particular user
+                responses:
+                    200:
+                        body:
+                            application/json:
+                                schema: !include inclusions/schemas/settings_response.json
+                        headers: !include inclusions/yaml/demo_headers.yaml
             post:
                 description: Change a user's settings
-
+                queryParameters:
+                    _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+                body:
+                    application/json:
+                        example: !include inclusions/examples/settings_body_example.json
+                responses:
+                    201:
+                        body:
+                            application/json:
+                                schema: !include inclusions/schemas/settings_response.json
+                        headers: !include inclusions/yaml/demo_headers.yaml
         /groups:
             displayName: User groups
             get:
                 description: Get all groups of a particular user
+                responses:
+                    200:
+                        headers: !include inclusions/yaml/demo_headers.yaml
             post:
                 description: Change a user's groups
+                queryParameters:
+                    _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+                body:
+                    application/json:
+                        example: !include inclusions/examples/groups_body_example.json
+                responses:
+                    201:
+                        headers: !include inclusions/yaml/demo_headers.yaml
 
         /profile:
             displayName: User profile
             get:
                 description: Get a user's profile
+                responses:
+                    200:
+                        body:
+                            application/json:
+                                schema: !include inclusions/schemas/profile_item_response.json
+                        headers: !include inclusions/yaml/demo_headers.yaml
             post:
                 description: Create a user's profile
+                queryParameters:
+                    _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
                 body:
                     application/json:
-                        schema: !include schemas/profile.json
+                        schema: !include inclusions/schemas/profile.json
+                        example: !include inclusions/examples/profile_body_example.json
+                responses:
+                    201:
+                        body:
+                            application/json:
+                                schema: !include inclusions/schemas/profile_item_response.json
+                        headers: !include inclusions/yaml/demo_headers.yaml
+
             patch:
                 description: Update a user's profile
+                queryParameters:
+                    _refresh_index: !include inclusions/yaml/refresh_index_param.yaml
+                body:
+                    application/json:
+                        example: !include inclusions/examples/profile_body_example.json
+                responses:
+                    200:
+                        body:
+                            application/json:
+                                schema: !include inclusions/schemas/profile_item_response.json
+                        headers: !include inclusions/yaml/demo_headers.yaml

inclusions/examples/groups_body_example.json

@@ -0,0 +1 @@
+{"user": "bar", "admin": "foo"}

inclusions/examples/profile_body_example.json

@@ -0,0 +1 @@
+{"address": "Earth, Milky Way"}

inclusions/examples/settings_body_example.json

@@ -0,0 +1 @@
+{"foo": "bar"}