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

package/src/__fixtures__/operations/bundled-parameter.ts

@@ -0,0 +1,128 @@
+import { IHttpOperation } from '@stoplight/types';
+import type { JSONSchema7 } from 'json-schema';
+
+export const httpOperation: IHttpOperation & { __bundled__: unknown } = {
+  id: '?http-operation-id?',
+  iid: 'POST_todos',
+  description: 'This creates a Todo object.\n\nTesting `inline code`.',
+  method: 'post',
+  path: '/todos',
+  summary: 'Create Todo',
+  responses: [
+    {
+      id: '?http-response-201?',
+      code: '201',
+      description: '',
+      headers: [],
+      contents: [
+        {
+          id: '?http-media-0?',
+          mediaType: 'application/json',
+          schema: {
+            title: 'Todo Full',
+            allOf: [
+              {
+                title: 'Todo Partial',
+                type: 'object',
+                properties: { name: { type: 'string' }, completed: { type: ['boolean', 'null'] } },
+                required: ['name', 'completed'],
+                'x-tags': ['Todos'],
+              } as JSONSchema7 & { 'x-tags': string[] },
+              {
+                type: 'object',
+                properties: {
+                  id: { type: 'integer', minimum: 0, maximum: 1000000 },
+                  completed_at: { type: ['string', 'null'], format: 'date-time' },
+                  created_at: { type: 'string', format: 'date-time' },
+                  updated_at: { type: 'string', format: 'date-time' },
+                  user: {
+                    title: 'User',
+                    type: 'object',
+                    properties: {
+                      name: { type: 'string', description: "The user's full name." },
+                      age: { type: 'number', minimum: 0, maximum: 150 },
+                    },
+                    required: ['name', 'age'],
+                    'x-tags': ['Todos'],
+                  } as JSONSchema7 & { 'x-tags': string[] },
+                },
+                required: ['id', 'user'],
+              },
+            ],
+            'x-tags': ['Todos'],
+          } as JSONSchema7 & { 'x-tags': string[] },
+          examples: [
+            {
+              id: '?http-example-0?',
+              key: 'application/json',
+              value: {
+                id: 9000,
+                name: "It's Over 9000!!!",
+                completed: null,
+                completed_at: null,
+                created_at: '2014-08-28T14:14:28.494Z',
+                updated_at: '2014-08-28T14:14:28.494Z',
+              },
+            },
+          ],
+        },
+      ],
+    },
+  ],
+  servers: [
+    { id: '?http-server-0?', url: 'https://todos.stoplight.io' },
+    { id: '?http-server-1?', url: 'http://todos.stoplight.io' },
+  ],
+  request: {
+    body: {
+      id: '?http-request-body?',
+      contents: [
+        {
+          id: '?http-media-1?',
+          mediaType: 'application/json',
+          schema: {
+            $ref: '#/__bundled__/paths/~1todos/post/responses/201/schema/allOf/0',
+            examples: [{ id: '?http-example-1?', name: "my todo's name", completed: false }],
+          },
+          examples: [{ id: '?http-example-2?', key: 'default', value: { name: "my todo's name", completed: false } }],
+        },
+      ],
+    },
+  },
+  tags: [{ name: 'Todos' }],
+  security: [
+    [
+      {
+        id: '?http-security-apiKey?',
+        type: 'apiKey',
+        name: 'apikey',
+        in: 'query',
+        description: "Use `?apikey=123` to authenticate requests. It's super secure.",
+        key: 'apikey',
+      },
+    ],
+  ],
+  __bundled__: {
+    paths: {
+      '/todos': {
+        post: {
+          responses: {
+            '201': {
+              schema: {
+                allOf: [
+                  {
+                    title: 'Todo Partial',
+                    type: 'object',
+                    properties: { name: { type: 'string' }, completed: { type: ['boolean', 'null'] } },
+                    required: ['name', 'completed'],
+                    'x-tags': ['Todos'],
+                  },
+                ],
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+};

package/src/__fixtures__/operations/empty-response.ts

@@ -0,0 +1,15 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const operation: any = {
+  id: '?http-operation-id?',
+  iid: 'GET_dummy',
+  method: 'get',
+  path: '/dummy',
+  summary: 'Get dummy empty response',
+  responses: [
+    {
+      code: '204',
+      description: 'Invalid status value',
+    },
+  ],
+};

package/src/__fixtures__/operations/examples-request-body.ts

@@ -0,0 +1,135 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const examplesRequestBody: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'PUT_USERS',
+  method: 'put',
+  path: '/users',
+  summary: 'Put Users',
+  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/json',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                type: 'string',
+              },
+              age: {
+                type: 'number',
+              },
+              trial: {
+                type: 'boolean',
+                readOnly: true,
+              },
+            },
+          },
+          examples: [
+            {
+              id: '?http-example-example-1?',
+              key: 'example-1',
+              value: {
+                name: 'Andrew',
+                age: 19,
+                trial: true,
+              },
+            },
+            {
+              id: '?http-example-named-example?',
+              key: 'named example',
+              value: {
+                name: 'Jane',
+                age: 36,
+                trial: false,
+              },
+            },
+            {
+              id: '?http-example-named-example-3?',
+              key: 'example-3',
+              value: {
+                name: 'Max',
+                age: 23,
+                trial: true,
+              },
+            },
+          ],
+        },
+      ],
+    },
+  },
+};
+
+export const singleExampleRequestBody: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'PUT_USERS',
+  method: 'put',
+  path: '/users',
+  summary: 'Put Users',
+  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/json',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                type: 'string',
+              },
+              age: {
+                type: 'number',
+              },
+              trial: {
+                type: 'boolean',
+                readOnly: true,
+              },
+            },
+          },
+          examples: [
+            {
+              id: '?http-example-example-1?',
+              key: 'example-1',
+              value: {
+                name: 'Andrew',
+                age: 19,
+                trial: true,
+              },
+            },
+          ],
+        },
+      ],
+    },
+  },
+};
+
+export default examplesRequestBody;

package/src/__fixtures__/operations/head-todos.ts

@@ -0,0 +1,49 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const headWithRequestBody: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'HEAD_USERS',
+  method: 'HEAD',
+  path: '/users',
+  summary: 'Head Users',
+  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/json',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                type: 'string',
+              },
+              age: {
+                type: 'number',
+              },
+              trial: {
+                type: 'boolean',
+                readOnly: true,
+              },
+            },
+          },
+        },
+      ],
+    },
+  },
+};
+
+export default headWithRequestBody;

package/src/__fixtures__/operations/invalid-response-example.ts

@@ -0,0 +1,45 @@
+import { HttpParamStyles, IHttpOperation } from '@stoplight/types';
+
+export const invalidOperation: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'GET_dummy',
+  method: 'get',
+  path: '/invalid-response',
+  summary: 'Get dummy invalid response',
+  responses: [
+    {
+      id: '?http-response-200?',
+      code: '200',
+      description: 'Invalid body and headers',
+      headers: [
+        {
+          id: '?http-header-sl-results?',
+          name: 'sl-results',
+          required: true,
+          style: HttpParamStyles.Simple,
+          schema: {
+            type: 'string',
+            pattern: 'X-*$',
+          },
+          examples: [{ id: '?http-example-0?', key: 'example1', value: 'hello' }],
+        },
+      ],
+      contents: [
+        {
+          id: '?http-media-0?',
+          mediaType: 'application/json',
+          examples: [{ id: '?http-example-1?', key: 'example1', value: {} }],
+          schema: {
+            type: 'object',
+            required: ['name', 'surname', 'age'],
+            properties: {
+              name: { type: 'string' },
+              surname: { type: 'string' },
+              age: { type: 'number' },
+            },
+          },
+        },
+      ],
+    },
+  ],
+};

package/src/__fixtures__/operations/multipart-formdata-post.ts

@@ -0,0 +1,61 @@
+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-media-0?',
+          mediaType: 'multipart/form-data',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                type: 'string',
+              },
+              age: {
+                type: 'string',
+              },
+              completed: {
+                type: 'boolean',
+              },
+              someRequiredEnum: {
+                type: 'string',
+                enum: ['a', 'b', 'c'],
+              },
+              someOptionalEnum: {
+                type: 'string',
+                enum: ['a', 'b', 'c'],
+              },
+              someFile: {
+                type: 'string',
+                contentMediaType: 'application/octet-stream',
+              },
+            },
+            required: ['name', 'completed', 'someRequiredEnum'],
+          },
+        },
+      ],
+    },
+  },
+};
+
+export default httpOperation;

package/src/__fixtures__/operations/operation-minimal.ts

@@ -0,0 +1,11 @@
+import { IHttpOperation } from '@stoplight/types';
+
+/**
+ * Operation with minimum information
+ */
+export const operation: IHttpOperation = {
+  id: '?http-operation-id?',
+  method: 'GET',
+  path: '/todos',
+  responses: [],
+};