@stoplight/elements-core 9.0.11 → 9.0.12-beta-0.1

package/src/__fixtures__/articles/multiple-try-its.md

@@ -0,0 +1,54 @@
+---
+title: Using the TODO API
+---
+
+1. Create a TODO
+
+```json http
+{
+  "method": "post",
+  "url": "/todos",
+  "baseUrl": "https://todos.stoplight.io",
+  "headers": {},
+  "query": {
+    "api_key": ["123"],
+  },
+  "body": {
+    "name": "Fetch this TODO",
+    "completed": false
+  }
+}
+```
+
+2. Use the "id" from the previous response to fetch the TODO
+
+
+```json http
+{
+  "method": "get",
+  "url": "/todos/{id}",
+  "baseUrl": "https://todos.stoplight.io",
+  "headers": {},
+  "query": {
+    "api_key": ["123"],
+  }
+}
+```
+
+3. Update the TODO to be completed
+
+```json http
+{
+  "method": "put",
+  "url": "/todos/{id}",
+  "baseUrl": "https://todos.stoplight.io",
+  "headers": {},
+  "query": {
+    "api_key": ["123"],
+  },
+  "body": {
+    "name": "[Completed] Fetch this TODO",
+    "completed": true
+  }
+}
+```

package/src/__fixtures__/articles/schema-with-refs.ts

@@ -0,0 +1,82 @@
+export const schemaWithRefs = `---
+title: Schema with refs
+---
+
+# Schema with refs (Swr)
+
+### Schema
+
+This is bundled schema with refs
+
+\`\`\`json jsonSchema
+{
+  "title": "DerefTest",
+  "type": "object",
+  "description": "Dereferencing test object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "inner": {
+      "description": "Inner object",
+      "title": "Inner",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "referencedObject": {
+          "$ref": "#/properties/referencedObject",
+          "description": "Inner referenced object"
+        }
+      },
+      "required": [
+        "id",
+        "bookingRate"
+      ]
+    },
+    "referencedObject": {
+      "description": "Referenced object",
+      "title": "ReferencedObject",
+      "type": "object",
+      "required": [
+        "property1",
+        "property2",
+        "property3"
+      ],
+      "properties": {
+        "property1": {
+          "type": "integer",
+          "description": "Property 1"
+        },
+        "property2": {
+          "type": "string",
+          "description": "Property 2"
+        },
+        "property3": {
+          "type": "boolean",
+          "description": "Property 3"
+        },
+        "property4": {
+          "type": "string",
+          "enum": [
+            "BUSINESS",
+            "PERSONAL",
+            "OTHER"
+          ],
+          "x-enum-descriptions": {
+            "BUSINESS": "Enum description for BUSINESS",
+            "PERSONAL": "Enum description for PERSONAL",
+            "OTHER": "Enum description for OTHER"
+          }
+        }
+      }
+    }
+  },
+  "required": [
+    "id",
+    "inner",
+    "referencedObject"
+  ]
+}
+\`\`\``;

package/src/__fixtures__/http-request.json

@@ -0,0 +1,11 @@
+{
+  "method": "get",
+  "url": "/gifs/search",
+  "baseUrl": "http://api.giphy.com/v1",
+  "headers": {},
+  "query": {
+    "api_key": ["dc6zaTOxFJmzC"],
+    "limit": ["1"],
+    "bear": "cave"
+  }
+}

package/src/__fixtures__/models/model-with-no-examples.json

@@ -0,0 +1,15 @@
+{
+  "title": "Error",
+  "type": "object",
+  "description": "A standard error object.",
+  "properties": {
+    "code": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    }
+  },
+  "required": ["code"],
+  "x-tags": ["Common"]
+}

package/src/__fixtures__/models/model-with-one-example.json

@@ -0,0 +1,23 @@
+{
+  "title": "Error",
+  "type": "object",
+  "description": "A standard error object.",
+  "properties": {
+    "code": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    }
+  },
+  "required": ["code"],
+  "x-tags": ["Common"],
+  "x-examples": {
+    "Example 1": {
+      "value": {
+        "code": "error",
+        "message": "Something bad happened!"
+      }
+    }
+  }
+}

package/src/__fixtures__/models/model-with-three-examples.json

@@ -0,0 +1,35 @@
+{
+  "title": "Error",
+  "type": "object",
+  "description": "A standard error object.",
+  "properties": {
+    "code": {
+      "type": "string"
+    },
+    "message": {
+      "type": "string"
+    }
+  },
+  "required": ["code"],
+  "x-tags": ["Common"],
+  "x-examples": {
+    "Example 1": {
+      "value": {
+        "code": "error",
+        "message": "Something bad happened!"
+      }
+    },
+    "Example 2": {
+      "value": {
+        "code": "error",
+        "message": "Something else happened!"
+      }
+    },
+    "Example 3": {
+      "value": {
+        "code": "error",
+        "message": "Another bad thing happened!"
+      }
+    }
+  }
+}

package/src/__fixtures__/operations/application-octet-stream-post.ts

@@ -0,0 +1,39 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const httpOperation: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'POST_todos',
+  method: 'post',
+  path: '/todos',
+  summary: 'Upload File',
+  responses: [
+    {
+      id: '?http-response-200?',
+      code: '200',
+    },
+  ],
+  servers: [
+    {
+      id: '?http-server-todos.stoplight.io?',
+      url: 'https://todos.stoplight.io',
+    },
+  ],
+  request: {
+    body: {
+      id: '?http-request-body?',
+      contents: [
+        {
+          id: '?http-media-0?',
+          mediaType: 'application/octet-stream',
+          schema: {
+            type: 'string',
+            format: 'binary',
+            $schema: 'http://json-schema.org/draft-07/schema#',
+          },
+        },
+      ],
+    },
+  },
+};
+
+export default httpOperation;

package/src/__fixtures__/operations/base64-file-upload.ts

@@ -0,0 +1,43 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const httpOperation: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'POST_todos',
+  method: 'post',
+  path: '/todos',
+  summary: 'Create Todo',
+  responses: [
+    {
+      id: '?http-response-200?',
+      code: '200',
+    },
+  ],
+  servers: [
+    {
+      id: '?http-server-todos.stoplight.io?',
+      url: 'https://todos.stoplight.io',
+    },
+  ],
+  request: {
+    body: {
+      id: '?http-request-body?',
+      contents: [
+        {
+          id: '?http-request-body-media?',
+          mediaType: 'multipart/form-data',
+          schema: {
+            type: 'object',
+            properties: {
+              someFile: {
+                type: 'string',
+                contentEncoding: 'base64',
+              },
+            },
+          },
+        },
+      ],
+    },
+  },
+};
+
+export default httpOperation;