added initial yaml versions of the samples and removed description from externally ref:ed tag

Author: Ole Lensmar

guidelines/sample-server/files/models.json

@@ -8,7 +8,6 @@
         "format": "int64"
       },
       "tag": {
-        "description": "a complex, shared property.  Note the absolute reference",
         "$ref": "https://my.company.com/definitions/models.json#/models/Tag"
       }
     }

guidelines/sample-server/files/models.yaml

@@ -0,0 +1,79 @@
+Model:
+  type: "object"
+  description: "A simple model"
+  properties:
+    id:
+      type: "integer"
+      format: "int64"
+    tag:
+      $ref: "https://my.company.com/definitions/models.yaml#/models/Tag"
+Tag:
+  type: "object"
+  description: "A tag entity in the system"
+  properties:
+    name:
+      type: "string"
+Health:
+  type: "object"
+  description: "An object representing the health of a server"
+  required:
+    - "liveThreadCount"
+    - "peakThreadCount"
+    - "startedThreadCount"
+    - "daemonThreadCount"
+    - "jvmMemory"
+  properties:
+    liveThreadCount:
+      type: "integer"
+      format: "int32"
+    peakThreadCount:
+      type: "integer"
+      format: "int32"
+    startedThreadCount:
+      type: "integer"
+      format: "int32"
+    daemonThreadCount:
+      type: "integer"
+      format: "int32"
+    jvmMemory:
+      $ref: "http://localhost:8000/models.yaml#/JVMMemory"
+JVMMemory:
+  type: "object"
+  required:
+    - "allocated"
+    - "max"
+    - "free"
+    - "used"
+    - "percentUsed"
+  properties:
+    allocated:
+      type: "integer"
+      format: "int64"
+    max:
+      type: "integer"
+      format: "int64"
+    free:
+      type: "integer"
+      format: "int64"
+    used:
+      type: "integer"
+      format: "int64"
+    percentUsed:
+      type: "number"
+      format: "double"
+ErrorMessage:
+  type: "object"
+  description: "A shared model for error message"
+  required:
+    - "errorCode"
+    - "reason"
+  properties:
+    errorCode:
+      type: "integer"
+      format: "int64"
+    reason:
+      description: "the reason for this error"
+      type: "string"
+    description:
+      description: "an optional longer description of this error message"
+      type: "string"

guidelines/sample-server/files/operations.yaml

@@ -0,0 +1,16 @@
+health:
+  get:
+    tags:
+      - "admin"
+    summary: "Returns server health information"
+    operationId: "getHealth"
+    produces:
+      - "application/json"
+    parameters: []
+    responses:
+      200:
+        description: "Health information from the server"
+        schema:
+          $ref: "http://localhost:8000/models.yaml#/Health"
+      404:
+        $ref: "http://localhost:8000/responses.yaml#/NotFoundError"

guidelines/sample-server/files/parameters.yaml

@@ -0,0 +1,17 @@
+query:
+  skip:
+    name: "skip"
+    in: "query"
+    description: "Results to skip when paginating through a result set"
+    required: false
+    minimum: 0
+    type: "integer"
+    format: "int32"
+  limit:
+    name: "limit"
+    in: "query"
+    description: "Maximum number of results to return"
+    required: false
+    minimum: 0
+    type: "integer"
+    format: "int32"

guidelines/sample-server/files/responses.yaml

@@ -0,0 +1,4 @@
+NotFoundError:
+  description: "Entity not found"
+  schema:
+    $ref: "http://localhost:8000/models.yaml#/ErrorMessage"

guidelines/sample-server/files/swagger.yaml

@@ -0,0 +1,30 @@
+swagger: "2.0"
+info:
+  description: "Sample server to demonstrate object reuse"
+  version: "1.0.0"
+  title: "Swagger sample"
+paths:
+  /health:
+    $ref: "http://localhost:8000/operations.yaml#/health"
+  /users:
+    get:
+      tags:
+        - "users"
+      summary: "Returns users in the system"
+      operationId: "getUsers"
+      produces:
+        - "application/json"
+      parameters:
+        -
+          $ref: "http://localhost:8000/parameters.yaml#/query/skip"
+        -
+          $ref: "http://localhost:8000/parameters.yaml#/query/limit"
+      responses:
+        200:
+          description: "Users in the system"
+          schema:
+            type: "array"
+            items:
+              $ref: "http://localhost:8000/models.yaml#/Health"
+        404:
+          $ref: "http://localhost:8000/responses.yaml#/NotFoundError"