raml_parser 0.1

data/spec/examples/raml/external/mule_sales_enablement.raml

@@ -0,0 +1,148 @@
+#%RAML 0.8
+---
+title: "Muse: Mule Sales Enablement API"
+version: v1
+baseUri: http://vast-coast-7974.herokuapp.com/muse
+schemas:
+  - presentation: |
+      {  "$schema": "http://json-schema.org/draft-03/schema",
+         "type": "object",
+         "description": "A product presentation",
+         "properties": {
+           "id":  { "type": "string" },
+           "title":  { "type": "string" },
+           "description":  { "type": "string" },
+           "fileUrl":  { "type": "string" },
+           "productId":  { "type": "string" }
+         },
+         "required": [ "id", "title", "fileUrl", "productId" ]
+      }
+  - product: |
+      {  "$schema": "http://json-schema.org/draft-03/schema",
+         "type": "object",
+         "description": "A Product",
+         "properties": {
+           "id":  { "type": "string" },
+           "name":  { "type": "string" },
+           "description":  { "type": "string" },
+           "imageUrl":  { "type": "string" },
+           "region": { "type": "string" }
+         },
+         "required": [ "id", "name", "region" ]
+      }
+resourceTypes:
+  - base:
+      get?:
+        responses: &standardResponses
+          200:
+            description: OK
+      put?:
+        responses: *standardResponses
+      patch?:
+        responses: *standardResponses
+      post?:
+          responses:
+            201:
+              description: Created
+      delete?:
+        responses: *standardResponses
+  - collection:
+      type: base
+      get:
+        is: [ paged ]
+      post:
+  - typedCollection:
+      type: collection
+      get:
+        responses:
+          200:
+            body:
+              application/json:
+                schema: <<schema>>
+      post:
+        body:
+          application/json:
+            schema: <<schema>>
+        responses:
+          201:
+            body:
+              application/json:
+                schema: <<schema>>
+  - member:
+      type: base
+      get:
+      put:
+      patch:
+      delete:
+  - typedMember:
+      type: member
+      get:
+        responses:
+          200:
+            body:
+              application/json:
+                schema: <<schema>>
+      put:
+        body:
+          application/json:
+            schema: <<schema>>
+        responses:
+          200:
+            body:
+              application/json:
+                schema: <<schema>>
+      patch:
+        body:
+          application/json:
+            schema: <<schema>>
+        responses:
+          200:
+            body:
+              application/json:
+                schema: <<schema>>
+      delete:
+traits:
+  - paged:
+      displayName: paged
+      queryParameters:
+        start:
+          displayName: start
+          description: The first page to return
+          type: number
+        pages:
+          displayName: pages
+          description: The number of pages to return
+          type: number
+  - secured:
+      displayName: secured
+      headers:
+        Authorization:
+          description: The auth token for this request
+      responses:
+        401:
+          description: Unauthorized
+/presentations: &presentations
+  type: { typedCollection: { schema: presentation } }
+  is: [ secured ]
+  get:
+    queryParameters:
+      title:
+        type: string
+        displayName: title
+        description: Filter by title
+  /{presentationId}:
+    type: { typedMember: { schema: presentation } }
+    is: [ secured ]
+/products:
+  type: { typedCollection: { schema: product } }
+  is: [ secured ]
+  get:
+    queryParameters:
+      region:
+        type: string
+        displayName: region
+        description: Filter by region
+  /{productId}:
+    type: { typedMember: { schema: product } }
+    is: [ secured ]
+    /presentations: *presentations

data/spec/examples/raml/external/multiple-methods.raml

@@ -0,0 +1,11 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: #{test_api_uri}
+/resource:
+  get: !!null
+  post: !!null
+/another-resource:
+  get: !!null
+  put: !!null
+  delete: !!null

data/spec/examples/raml/external/named_parameters.raml

@@ -0,0 +1,85 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://www.example.com/
+/resource:
+  get:
+    queryParameters:
+      displayNameAndTypeDefaults:
+      displayNameProvided:
+        displayName: 'Display Name Provided'
+      withType:
+        type: integer
+      withPattern:
+        pattern: /some regex/
+      minLength:
+        minLength: 8
+      maxLength:
+        maxLength: 20
+      minAndMaxLength:
+        minLength: 8
+        maxLength: 20
+      minimum:
+        type: number
+        minimum: 8
+      maximum:
+        type: number
+        maximum: 20
+      minAndMaximum:
+        type: number
+        minimum: 8
+        maximum: 20
+      repeat:
+        repeat: true
+      simpleShortDescription:
+        description: |
+          This parameter is used to do something.
+      simpleLongDescription:
+        description: |
+          Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
+          eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
+          minim veniam, quis nostrud exercitation ullamco laboris nisi ut
+          aliquip ex ea commodo consequat. Duis aute irure dolor in
+          reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+          culpa qui officia deserunt mollit anim id est laborum.
+      markdownDescription:
+        description: |
+          An explanation of the purpose of this parameter, in **Markdown**!
+
+          # We can have headers
+
+          And text with *all* sorts of formatting.
+
+          * Such
+          * as
+          * lists
+      example:
+        example: 1a79a4d60de6718e8e5b326e338ae533
+      default:
+        default: 0
+      descriptionAndExample:
+        description: This parameter is used to do something.
+        example: 154
+      required:
+        required: true
+      enum:
+        enum:
+          - one
+          - two
+          - three
+      combo:
+        required: true
+        enum:
+          - any
+          - all
+          - exact match
+        description: This parameter does something
+      anotherCombo:
+        required: true
+        type: integer
+        minimum: 5
+        maximum: 20
+        default: 5
+        example: 18
+        description: This explains the function of this parameter.

data/spec/examples/raml/external/requests-responses.raml

@@ -0,0 +1,47 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://example.com
+schemas:
+  - an_xml_schema: !include xml_schema.xsd
+  - a_json_schema: !include json_schema.json
+/resource:
+  post:
+    headers:
+      X-Some-Header:
+        description: This is an example header
+    body:
+      text/xml:
+        schema: an_xml_schema
+        example: !include xml_example.xml
+      application/json:
+        schema: a_json_schema
+        example: |
+          { "figure": true,
+            "out": true,
+            "your": true,
+            "life": true
+          }
+    responses:
+      200:
+        description: |
+          *Success* description
+        headers:
+          X-Some-Header:
+            type: integer
+            example: 5
+            description: A *description* of some header sent as part of the **response**.
+      404:
+        description: |
+          *Error* description
+        body:
+          text/xml:
+            example: |
+              <api-response><status>Error</status></api-response>
+            schema: an_xml_schema
+
+  /sub:
+    description: hi
+    get:
+      description: |
+        ### WHAT

data/spec/examples/raml/external/resource_summary_spacing.raml

@@ -0,0 +1,42 @@
+#%RAML 0.8
+# Use this RAML with a very narrow console to see how the resource summary wraps
+# given the length/presence/absence of various elements
+title: Example
+resourceTypes:
+  - someType: {}
+traits:
+  - someTrait: {}
+/resource/with/a/very/long/name/that/causes/it/to/wrap/which/looks/bad/because:
+  /short:
+    /short:
+      /short:
+  /the/line/height/is/small:
+    get:
+  /some/more/with/ascenders:
+    type: someType
+  /and/padaqalag/with/methods:
+    type: someType
+    is: [someTrait]
+    get:
+    post:
+    put:
+    delete:
+  /and/padaqalaga/with/description:
+    type: someType
+    is: [someTrait]
+    description: |
+      Some text I wrote
+
+      And some more text
+
+      Plus suppose I wrote a bunch of long text that wraps and makes it look like a real paragraph
+    get:
+    post:
+    put:
+    delete:
+/short:
+  type: someType
+/short-with-methods:
+  type: someType
+  get:
+  post:

data/spec/examples/raml/external/simple.raml

@@ -0,0 +1,233 @@
+#%RAML 0.8
+---
+title: Example API
+baseUri: http://example.com
+securitySchemes:
+  - basic:
+      type: Basic Authentication
+traits:
+  - secured:
+      description: Some requests require authentication
+  - unsecured:
+      description: This is not secured
+  - catpictures:
+      description: requires cat headers
+  - anotherTrait: {}
+  - andAnotherTrait: {}
+  - andYetAnotherTrait: {}
+  - aFinalTrait: {}
+  - someParameterizedTrait:
+      description: <<someParameterName>>
+resourceTypes:
+  - longCollectionName:
+      description: |
+        This is a description. It can be long.
+
+        # Headers
+
+        It can have headers, and _italic_, and **bold** text.
+
+        # Length
+
+        Because it is arbitrary markdown, it can be arbitrarily long.
+documentation:
+  - title: Getting Started
+    content: |
+      # Header
+      Content
+      ## Subheader
+      **Bolded content**
+/resource:
+  displayName: First One
+  is: [secured]
+  options:
+    responses:
+      200:
+  connect:
+    responses:
+      200:
+  trace:
+    responses:
+      200:
+  patch:
+    responses:
+      200:
+  delete:
+    responses:
+      200:
+      201:
+      203:
+  put:
+    responses:
+      200:
+      201:
+      203:
+  get:
+    description: get the first one
+    headers:
+      x-custom:
+    responses:
+      200:
+  /{resourceId}:
+    description: This is a resource description *with* some _markdown_ embedded in it
+    uriParameters:
+      resourceId:
+        required: true
+        description: Which resoure would you like to view
+    get:
+      description: |
+        Instagram’s API uses the [OAuth 2.0 protocol](http://tools.ietf.org/html/draft-ietf-oauth-v2-12) for simple, but effective authentication and authorization. OAuth 2.0 is much easier to use than previous schemes; developers can start using the Instagram API almost immediately. The one thing to keep in mind is that all requests to the API must be made over SSL (https:// not http://)
+
+        ## Do you need to authenticate?
+
+        For the most part, Instagram’s API only requires the use of a _client_id). A client_id simply associates your server, script, or program with a specific application. However, some requests require authentication - specifically requests made on behalf of a user. Authenticated requests require an _access_token_. These tokens are unique to a user and should be stored securely. Access tokens may expire at any time in the future.
+
+        Note that in many situations, you may not need to authenticate users at all. For instance, you may request popular photos without authenticating (i.e. you do not need to provide an access_token; just use your client ID with your request). We only require authentication in cases where your application is making requests on behalf of a user (commenting, liking, browsing a user’s feed, etc.).
+
+        ## Receiving an access_token
+      queryParameters:
+        filter:
+          description: What to filter
+          type: string
+      responses:
+        200:
+    post:
+      body:
+        application/json:
+        application/x-www-form-urlencoded:
+          formParameters:
+            name:
+              description: The name of the resource to create
+              type: string
+              example: Comment
+            description:
+              description: A description of the resource to create
+              type: string
+              example: User-generated content pertinent to the associated blog post
+        multipart/form-data:
+          formParameters:
+            name:
+              description: The name of the resource to create
+              type: string
+              example: Comment
+            description:
+              description: A description of the resource to create
+              type: string
+              example: User-generated content pertinent to the associated blog post
+      responses:
+        200:
+        201:
+        203:
+
+/another/resource:
+  displayName: Cats
+  type: longCollectionName
+  is: [secured, catpictures, anotherTrait, andAnotherTrait]
+  connect: !!null
+  head:
+    responses:
+      200:
+      201:
+      203:
+  get:
+    queryParameters:
+      chunk:
+        displayName: page
+        description: Which page to display
+        type: integer
+        example: 1
+        minimum: 1
+        maximum: 100
+        required: true
+      order:
+        description: The sort order of resources
+        type: string
+        enum: ["oldest", "newest"]
+        example: oldest
+        minLength: 5
+        maxLength: 7
+        default: newest
+      query:
+        description: A query parameter
+        repeat: true
+
+/resource-with-headers:
+  displayName: Resource With headers
+  get:
+    headers:
+      x-custom-header:
+        displayName: Custom header
+        description: This header is used to send data that...
+        type: string
+        pattern: ^\w+$
+      x-p-{*}:
+        displayName: Parameterized header
+
+/secured-resource:
+  displayName: SO SECURE
+  get:
+    securedBy: [basic]
+/resource-with-method-level-traits:
+  displayName: First One
+  is: [secured]
+  get:
+    is: [unsecured, catpictures, anotherTrait, andAnotherTrait, andYetAnotherTrait, aFinalTrait, {someParameterizedTrait: { someParameterName: someParameterValue }}]
+    description: get the first one
+/resource-with-form-and-multipart-form-parameters:
+  get:
+    queryParameters:
+      some_query_param:
+            displayName: Some Query Param
+            description: Your value for some thing.
+            type: string
+            required: true
+            example: "my value"
+    body:
+      application/json:
+        example: |
+            {
+              "api_key": "c4f820f0420a013ea143230c290fbf99",
+              ...
+            }
+      application/x-www-form-urlencoded:
+        formParameters:
+          api_key:
+            displayName: API Key
+            description: Your license key for the application. Please contact developer@nzpost.co.nz for a license key
+            type: string
+            required: true
+            example: "c4f820f0420a013ea143230c290fbf99"
+      multipart/form-data:
+        formParameters:
+          api_key:
+            displayName: API Key
+            description: Your license key for the application. Please contact developer@nzpost.co.nz for a license key
+            type: string
+            required: true
+            example: "c4f820f0420a013ea143230c290fbf99"
+/resource-with-repeatable-params:
+  post:
+    queryParameters:
+      someParam:
+        repeat: true
+      notRepeatable:
+    body:
+      application/x-www-form-urlencoded:
+        formParameters:
+          someFormParam:
+            repeat: true
+      multipart/form-data:
+        formParameters:
+          someMultipartFormParam:
+            type: file
+            repeat: true
+          someMultipartFormParamWithMultipleTypes:
+            - type: file
+            - type: string
+              repeat: true
+    headers:
+      someHeader:
+        repeat: true
+      x-meta-{*}:
+        repeat: true
+