Update test project with recursive schema

Deadarius · Deadarius · commit c7aa9d903cbd · 2019-05-01T11:19:38.000+12:00
diff --git a/test/project/models/RecursiveResponse.json b/test/project/models/RecursiveResponse.json
@@ -0,0 +1,31 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "folder": {
+      "type": "object",
+      "title": "Folder Schema",
+      "properties": {
+        "id": {
+          "type": "string",
+          "example": "3ba1c69c-3c81-4d6d-b304-873d898b2e3c",
+          "format": "uuid"
+        },
+        "folders": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/folder"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": ["id", "name", "folders", "checklists"]
+    }
+  },
+  "type": "object",
+  "title": "Folders Response Schema",
+  "properties": {
+    "data": {
+      "$ref": "#/definitions/folder"
+    }
+  }
+}
diff --git a/test/project/openapi.yml b/test/project/openapi.yml
@@ -1,6 +1,91 @@
-openapi: 3.0.0-RC1
+openapi: 3.0.0
 components:
   schemas:
+    meta:
+      description: >-
+        Non-standard meta-information that can not be represented as an
+        attribute or relationship.
+      type: object
+      additionalProperties: true
+    links:
+      description: >-
+        A resource object **MAY** contain references to other resource objects
+        ("relationships"). Relationships may be to-one or to-many. Relationships
+        can be specified by including a member in a resource's links object.
+      type: object
+      properties:
+        self:
+          description: >-
+            A `self` member, whose value is a URL for the relationship itself (a
+            "relationship URL"). This URL allows the client to directly
+            manipulate the relationship. For example, it would allow a client to
+            remove an `author` from an `article` without deleting the people
+            resource itself.
+          type: string
+          format: uri
+        related:
+          $ref: '#/components/schemas/link'
+      additionalProperties: true
+    link:
+      description: >-
+        A link **MUST** be represented as either: a string containing the link's
+        URL or a link object.
+      oneOf:
+        - description: A string containing the link's URL.
+          type: string
+          format: uri
+        - type: object
+          required:
+            - href
+          properties:
+            href:
+              description: A string containing the link's URL.
+              type: string
+              format: uri
+            meta:
+              $ref: '#/components/schemas/meta'
+    error:
+      type: object
+      properties:
+        id:
+          description: A unique identifier for this particular occurrence of the problem.
+          type: string
+        links:
+          $ref: '#/components/schemas/links'
+        status:
+          description: >-
+            The HTTP status code applicable to this problem, expressed as a
+            string value.
+          type: string
+        code:
+          description: 'An application-specific error code, expressed as a string value.'
+          type: string
+        title:
+          description: >-
+            A short, human-readable summary of the problem. It **SHOULD NOT**
+            change from occurrence to occurrence of the problem, except for
+            purposes of localization.
+          type: string
+        detail:
+          description: >-
+            A human-readable explanation specific to this occurrence of the
+            problem.
+          type: string
+        source:
+          type: object
+          properties:
+            pointer:
+              description: >-
+                A JSON Pointer [RFC6901] to the associated entity in the request
+                document [e.g. "/data" for a primary data object, or
+                "/data/attributes/title" for a specific attribute].
+              type: string
+            parameter:
+              description: A string indicating which query parameter caused the error.
+              type: string
+        meta:
+          $ref: '#/components/schemas/meta'
+      additionalProperties: false
     ErrorResponse:
       title: JSON API Schema
       description: >-
@@ -13,142 +98,12 @@ components:
         errors:
           type: array
           items:
-            type: object
-            properties:
-              id:
-                description: >-
-                  A unique identifier for this particular occurrence of the
-                  problem.
-                type: string
-              links:
-                description: >-
-                  A resource object **MAY** contain references to other resource
-                  objects ("relationships"). Relationships may be to-one or
-                  to-many. Relationships can be specified by including a member
-                  in a resource's links object.
-                type: object
-                properties:
-                  self:
-                    description: >-
-                      A `self` member, whose value is a URL for the relationship
-                      itself (a "relationship URL"). This URL allows the client
-                      to directly manipulate the relationship. For example, it
-                      would allow a client to remove an `author` from an
-                      `article` without deleting the people resource itself.
-                    type: string
-                    format: uri
-                  related:
-                    description: >-
-                      A link **MUST** be represented as either: a string
-                      containing the link's URL or a link object.
-                    oneOf:
-                      - description: A string containing the link's URL.
-                        type: string
-                        format: uri
-                      - type: object
-                        required:
-                          - href
-                        properties:
-                          href:
-                            description: A string containing the link's URL.
-                            type: string
-                            format: uri
-                          meta:
-                            description: >-
-                              Non-standard meta-information that can not be
-                              represented as an attribute or relationship.
-                            type: object
-                            additionalProperties: true
-                additionalProperties: true
-              status:
-                description: >-
-                  The HTTP status code applicable to this problem, expressed as
-                  a string value.
-                type: string
-              code:
-                description: >-
-                  An application-specific error code, expressed as a string
-                  value.
-                type: string
-              title:
-                description: >-
-                  A short, human-readable summary of the problem. It **SHOULD
-                  NOT** change from occurrence to occurrence of the problem,
-                  except for purposes of localization.
-                type: string
-              detail:
-                description: >-
-                  A human-readable explanation specific to this occurrence of
-                  the problem.
-                type: string
-              source:
-                type: object
-                properties:
-                  pointer:
-                    description: >-
-                      A JSON Pointer [RFC6901] to the associated entity in the
-                      request document [e.g. "/data" for a primary data object,
-                      or "/data/attributes/title" for a specific attribute].
-                    type: string
-                  parameter:
-                    description: >-
-                      A string indicating which query parameter caused the
-                      error.
-                    type: string
-              meta:
-                description: >-
-                  Non-standard meta-information that can not be represented as
-                  an attribute or relationship.
-                type: object
-                additionalProperties: true
-            additionalProperties: false
+            $ref: '#/components/schemas/error'
           uniqueItems: true
         meta:
-          description: >-
-            Non-standard meta-information that can not be represented as an
-            attribute or relationship.
-          type: object
-          additionalProperties: true
+          $ref: '#/components/schemas/meta'
         links:
-          description: >-
-            A resource object **MAY** contain references to other resource
-            objects ("relationships"). Relationships may be to-one or to-many.
-            Relationships can be specified by including a member in a resource's
-            links object.
-          type: object
-          properties:
-            self:
-              description: >-
-                A `self` member, whose value is a URL for the relationship
-                itself (a "relationship URL"). This URL allows the client to
-                directly manipulate the relationship. For example, it would
-                allow a client to remove an `author` from an `article` without
-                deleting the people resource itself.
-              type: string
-              format: uri
-            related:
-              description: >-
-                A link **MUST** be represented as either: a string containing
-                the link's URL or a link object.
-              oneOf:
-                - description: A string containing the link's URL.
-                  type: string
-                  format: uri
-                - type: object
-                  required:
-                    - href
-                  properties:
-                    href:
-                      description: A string containing the link's URL.
-                      type: string
-                      format: uri
-                    meta:
-                      description: >-
-                        Non-standard meta-information that can not be
-                        represented as an attribute or relationship.
-                      type: object
-                      additionalProperties: true
-          additionalProperties: true
+          $ref: '#/components/schemas/links'
       additionalProperties: false
     PutDocumentResponse:
       title: Empty Schema
@@ -160,11 +115,35 @@ components:
           properties:
             SomeAttribute:
               type: string
+    folder:
+      type: object
+      title: Folder Schema
+      properties:
+        id:
+          type: string
+          example: 3ba1c69c-3c81-4d6d-b304-873d898b2e3c
+          format: uuid
+        folders:
+          type: array
+          items:
+            $ref: '#/components/schemas/folder'
+      additionalProperties: false
+      required:
+        - id
+        - name
+        - folders
+        - checklists
+    RecursiveResponse:
+      type: object
+      title: Folders Response Schema
+      properties:
+        data:
+          $ref: '#/components/schemas/folder'
   securitySchemes: {}
 info:
   title: ''
   description: ''
-  version: 442d95b9-dcc5-4e6e-a354-a561b8904c08
+  version: 249c21ac-b279-4665-8f59-4873a4c151a2
 paths:
   /create:
     post:
@@ -184,33 +163,3 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
-      parameters:
-        - name: username
-          in: path
-          description: The username for a user to create
-          required: true
-          schema:
-            type: string
-            pattern: '^[-a-z0-9_]+$'
-        - name: membershipType
-          in: query
-          description: The user's Membership Type
-          required: false
-          allowEmptyValue: false
-          schema:
-            type: string
-            enum:
-              - premium
-              - standard
-        - name: SessionId
-          in: cookie
-          description: A Session ID variable
-          required: false
-          schema:
-            type: string
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/PutDocumentRequest'
-        description: A user information object
diff --git a/test/project/package.json b/test/project/package.json
@@ -1,6 +1,6 @@
 {
   "name": "openapi-test-package",
   "devDependencies": {
-    "serverless": "^1.16.1"
+    "serverless": "^1.39.0"
   }
 }
diff --git a/test/project/serverless.docs.yml b/test/project/serverless.docs.yml
@@ -23,7 +23,7 @@ endpoints:
     cookieParams:
       - name: SessionId
         description: A Session ID variable
-        schema: 
+        schema:
           type: string
     methodResponses:
       - statusCode: 201
@@ -60,3 +60,7 @@ documentation:
             properties:
               SomeAttribute:
                 type: string
+    - name: RecursiveResponse
+      description: Recursive response example
+      contentType: application/json
+      schema: ${file(models/RecursiveResponse.json)}
diff --git a/test/project/serverless.yml b/test/project/serverless.yml
@@ -5,7 +5,9 @@ provider:
   runtime: nodejs6.10
 
 plugins:
-  - serverless-openapi-documentation
+  localPath: /Users/alex/dev/serverless-openapi-documentation
+  modules:
+    - build
 
 functions:
   createUser:
@@ -76,3 +78,8 @@ custom:
               properties:
                 SomeAttribute:
                   type: string
+
+      - name: RecursiveResponse
+        description: Recursive response example
+        contentType: application/json
+        schema: ${file(models/RecursiveResponse.json)}
diff --git a/test/project/yarn.lock b/test/project/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "openapi-test-package",`
`3`	`3`	`"devDependencies": {`
`4`		`- "serverless": "^1.16.1"`
	`4`	`+ "serverless": "^1.39.0"`
`5`	`5`	`}`
`6`	`6`	`}`