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

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

@@ -0,0 +1,337 @@
+import { HttpParamStyles, IHttpOperation } from '@stoplight/types';
+
+export const httpOperation: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'PUT_todos',
+  method: 'put',
+  path: '/todos/{todoId}',
+  summary: 'Update Todo',
+  responses: [
+    {
+      id: '?http-response-200?',
+      code: '200',
+      description: '',
+      headers: [
+        {
+          schema: {
+            type: 'string',
+            description: 'Resolver errors.',
+          },
+          name: 'X-Stoplight-Resolver',
+          style: HttpParamStyles.Simple,
+          required: true,
+        },
+      ],
+      contents: [
+        {
+          mediaType: 'application/json',
+          schema: {
+            $schema: 'http://json-schema.org/draft-04/schema#',
+            title: 'Todo Full',
+            allOf: [
+              {
+                $schema: 'http://json-schema.org/draft-04/schema#',
+                title: 'Todo Partial',
+                type: 'object',
+                properties: {
+                  name: {
+                    type: 'string',
+                  },
+                  completed: {
+                    type: ['boolean', 'null'],
+                  },
+                },
+                required: ['name', 'completed'],
+              },
+              {
+                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: {
+                    $schema: 'http://json-schema.org/draft-04/schema#',
+                    title: 'User',
+                    type: 'object',
+                    properties: {
+                      name: {
+                        type: 'string',
+                        description: "The user's full name.",
+                      },
+                      age: {
+                        type: 'number',
+                        minimum: 0,
+                        maximum: 150,
+                      },
+                    },
+                    required: ['name', 'age'],
+                    description: 'Here lies the user model',
+                  },
+                },
+                required: ['id', 'user'],
+              },
+            ],
+          },
+        },
+      ],
+    },
+  ],
+  servers: [
+    {
+      id: '?http-server-todos.stoplight.io?',
+      url: 'https://todos.stoplight.io',
+    },
+  ],
+  request: {
+    query: [
+      {
+        schema: {
+          type: 'number',
+          default: 1,
+          enum: [0, 1, 3],
+          exclusiveMinimum: 0,
+          exclusiveMaximum: 10,
+          minimum: 5,
+          maximum: 10,
+        },
+        deprecated: true,
+        description: 'How many todos to limit?',
+        name: 'limit',
+        style: HttpParamStyles.Form,
+        required: true,
+      },
+      {
+        schema: {
+          type: 'string',
+          default: '1',
+          enum: ['0', '1', '3'],
+          minLength: 0,
+          maxLength: 10,
+        },
+        deprecated: true,
+        description: 'How many string todos to limit?',
+        name: 'value',
+        style: HttpParamStyles.Form,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 5,
+          maxItems: 10,
+        },
+        name: 'items',
+        style: HttpParamStyles.Form,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 1,
+          maxItems: 3,
+        },
+        name: 'items_not_exploded',
+        style: HttpParamStyles.Form,
+        explode: false,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 1,
+          maxItems: 3,
+        },
+        name: 'items_spaces',
+        style: HttpParamStyles.SpaceDelimited,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 1,
+          maxItems: 3,
+        },
+        name: 'items_spaces_not_exploded',
+        style: HttpParamStyles.SpaceDelimited,
+        explode: false,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 1,
+          maxItems: 3,
+        },
+        name: 'items_pipes',
+        style: HttpParamStyles.PipeDelimited,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 1,
+          maxItems: 3,
+        },
+        name: 'items_pipes_not_exploded',
+        style: HttpParamStyles.PipeDelimited,
+        explode: false,
+      },
+      {
+        schema: {
+          type: 'array',
+          minItems: 1,
+          maxItems: 3,
+        },
+        name: 'default_style_items',
+      },
+      {
+        schema: {
+          type: 'object',
+        },
+        name: 'nested',
+        style: HttpParamStyles.Form,
+      },
+      {
+        schema: {
+          type: 'object',
+        },
+        name: 'nested_not_exploded',
+        style: HttpParamStyles.Form,
+        explode: false,
+      },
+      {
+        schema: {
+          type: 'object',
+        },
+        name: 'deep_object',
+        style: HttpParamStyles.DeepObject,
+        explode: true,
+      },
+      {
+        schema: {
+          type: 'boolean',
+          description: 'Only return completed',
+        },
+        name: 'completed',
+        required: false,
+        style: HttpParamStyles.Form,
+      },
+      {
+        schema: {
+          type: 'string',
+          enum: ['something', 'another'],
+        },
+        name: 'type',
+        style: HttpParamStyles.SpaceDelimited,
+      },
+      {
+        name: 'super_duper_long_parameter_name_with_unnecessary_text',
+        schema: {
+          type: 'string',
+          default: 'some interesting string with interesting content, but still pretty long',
+        },
+        style: HttpParamStyles.Form,
+        required: true,
+      },
+      {
+        name: 'optional_value_with_default',
+        schema: {
+          type: 'string',
+          default: 'some default value',
+        },
+        style: HttpParamStyles.Form,
+      },
+    ],
+    headers: [
+      {
+        schema: {
+          type: 'string',
+          description: 'Your Stoplight account id',
+          default: 'account-id-default',
+        },
+        name: 'b-account-id',
+        style: HttpParamStyles.Simple,
+        examples: [
+          {
+            value: 'example id',
+            key: 'example',
+          },
+        ],
+      },
+      {
+        schema: {
+          type: 'string',
+          description: 'Your Stoplight account id',
+          default: 'account-id-default',
+        },
+        name: 'account-id',
+        style: HttpParamStyles.Simple,
+        required: false,
+        examples: [
+          {
+            value: 'example id',
+            key: 'example',
+          },
+        ],
+      },
+      {
+        schema: {
+          type: 'string',
+          description: 'Your Stoplight account id',
+        },
+        name: 'message-id',
+        style: HttpParamStyles.Simple,
+        required: true,
+        examples: [
+          {
+            value: 'example value',
+            key: 'example 1',
+          },
+          {
+            value: 'another example',
+            key: 'example 2',
+          },
+          {
+            value: 'something else',
+            key: 'example 3',
+          },
+        ],
+      },
+    ],
+    path: [
+      {
+        schema: {
+          type: 'string',
+        },
+        name: 'todoId',
+        style: HttpParamStyles.Simple,
+        required: true,
+      },
+      {
+        schema: {
+          type: 'string',
+        },
+        name: 'bAnotherId',
+        style: HttpParamStyles.Simple,
+      },
+      {
+        schema: {
+          type: 'string',
+        },
+        name: 'anotherId',
+        style: HttpParamStyles.Simple,
+        required: false,
+      },
+    ],
+  },
+} as any;
+
+export default httpOperation;

package/src/__fixtures__/operations/operation-with-examples.ts

@@ -0,0 +1,113 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const httpOperation: IHttpOperation = {
+  method: 'GET',
+  path: 'some/path',
+  id: 'some-id',
+  responses: [
+    {
+      id: '?http-response-200?',
+      code: '200',
+      contents: [
+        {
+          id: '?http-media-0?',
+          mediaType: 'application/json',
+          examples: [
+            {
+              id: '?http-example-0?',
+              key: 'First Example',
+              value: { some: 'example' },
+            },
+            {
+              id: '?http-example-1?',
+              key: 'Second Example',
+              value: '{ "another": "example" }',
+            },
+          ],
+        },
+      ],
+    },
+    {
+      id: '?http-response-201?',
+      code: '201',
+      contents: [
+        {
+          id: '?http-media-1?',
+          mediaType: 'application/json',
+          schema: {
+            properties: {
+              someParameter: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      ],
+    },
+    {
+      id: '?http-response-202?',
+      code: '202',
+      contents: [
+        {
+          id: '?http-media-2?',
+          mediaType: 'application/json',
+          examples: [
+            {
+              id: '?http-example-2?',
+              key: 'Only one example',
+              value: { this: 'is an example' },
+            },
+          ],
+        },
+      ],
+    },
+    {
+      id: '?http-response-203?',
+      code: '203',
+      contents: [
+        {
+          id: '?http-media-3?',
+          mediaType: 'application/xml',
+          schema: {
+            properties: {
+              someParameter: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      ],
+    },
+    {
+      id: '?http-response-204?',
+      code: '204',
+      contents: [
+        {
+          id: '?http-media-4?',
+          mediaType: 'application/json',
+          schema: {
+            properties: {
+              writeOnlyParameter: {
+                type: 'string',
+                writeOnly: true,
+              },
+              someOtherParameter: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      ],
+    },
+    {
+      id: '?http-response-404?',
+      code: '404',
+      contents: [
+        {
+          id: '?http-media-5?',
+          mediaType: 'application/json',
+        },
+      ],
+    },
+  ],
+};

package/src/__fixtures__/operations/operation-without-servers.ts

@@ -0,0 +1,16 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const operation: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'GET-simple',
+  method: 'get',
+  path: '/todos',
+  summary: 'Get 200',
+  responses: [
+    {
+      id: '?http-response-200?',
+      code: '200',
+      description: 'OK',
+    },
+  ],
+};

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

@@ -0,0 +1,49 @@
+import { IHttpOperation } from '@stoplight/types';
+
+export const patchWithRequestBody: IHttpOperation = {
+  id: '?http-operation-id?',
+  iid: 'PATCH_USERS',
+  method: 'PATCH',
+  path: '/users',
+  summary: 'Patch 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-request-body-media?',
+          mediaType: 'application/json',
+          schema: {
+            type: 'object',
+            properties: {
+              name: {
+                type: 'string',
+              },
+              age: {
+                type: 'number',
+              },
+              trial: {
+                type: 'boolean',
+                readOnly: true,
+              },
+            },
+          },
+        },
+      ],
+    },
+  },
+};
+
+export default patchWithRequestBody;