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

package/src/__fixtures__/schemas/contact.json

@@ -0,0 +1,293 @@
+{
+   "type": "object",
+   "description": "represents a contact",
+   "title": "Contact",
+   "properties": {
+      "addresseeName": {
+         "type": "object",
+         "description": "Description of the name of a physical person",
+         "title": "Name",
+         "properties": {
+            "firstName": {
+               "description": "First name.",
+               "type": "string"
+            },
+            "lastName": {
+               "description": "Last name.",
+               "type": "string"
+            },
+            "title": {
+               "description": "Contains all the suffixes and prefixes that can be appended to a name - Mr, Miss, Pr. - E.g. \" Mr\".",
+               "type": "string"
+            },
+            "maidenName": {
+               "description": "The name given at birth time and that may have changed after a marriage.",
+               "type": "string"
+            },
+            "middleName": {
+               "description": "Middle name(s), for example \"Lee\" in \"John Lee Smith\".",
+               "type": "string"
+            },
+            "prefix": {
+               "type": "string",
+               "description": "Name prefix (e.g. Doctor)"
+            },
+            "suffix": {
+               "description": "Name suffix (e.g. Junior, III, etc).",
+               "type": "string"
+            },
+            "referenceName": {
+               "description": "Indicator to advise if the name is a reference name",
+               "type": "boolean"
+            },
+            "transliterationMethod": {
+               "type": "string",
+               "description": "The method (if applicated) that was used to transform the name from universal character (e.g. korean characters) to latin characters/phonetic transcription/..."
+            },
+            "nameType": {
+               "type": "string",
+               "description": "the type of the reference name - When several name entities exist for a given Name element(e.g. Universal name, both Native names, Romanized name), the notion of reference name (i.e. active or main name) exists. It can be either the Universal name or the Native name/Phonetic name.",
+               "x-enum-descriptions": {
+                  "universal": "Enum description for universal",
+                  "native": "Enum description for native",
+                  "romanization": "Enum description for romanization"
+               },
+               "enum": [
+                  "universal",
+                  "native",
+                  "romanization"
+               ]
+            },
+            "displayName": {
+               "type": "boolean",
+               "description": "Signifies if the name is displayed on PNR face"
+            },
+            "fullName": {
+               "type": "string",
+               "description": "free flow ,  Concatenation of first/mid/last. No order, no restriction, no pattern, blank separator ...."
+            }
+         }
+      },
+      "phone": {
+         "type": "object",
+         "description": "Phone information.",
+         "properties": {
+            "category": {
+               "description": "Category of the contact element",
+               "type": "string",
+               "enum": [
+                  "BUSINESS",
+                  "PERSONAL",
+                  "OTHER"
+               ],
+               "x-enum-descriptions": {
+                  "BUSINESS": "Enum description for BUSINESS",
+                  "PERSONAL": "Enum description for PERSONAL",
+                  "OTHER": "Enum description for OTHER"
+               }
+            },
+            "addresseeName": {
+               "type": "string",
+               "description": "Adressee name (e.g. in case of emergency purpose it corresponds to name of the person to be contacted).",
+               "pattern": "[a-zA-Z -]"
+            },
+            "deviceType": {
+               "type": "string",
+               "description": "Type of the device (Landline, Mobile or Fax)",
+               "enum": [
+                  "MOBILE",
+                  "LANDLINE",
+                  "FAX"
+               ],
+               "x-enum-descriptions": {
+                  "MOBILE": "Enum description for MOBILE",
+                  "LANDLINE": "Enum description for LANDLINE",
+                  "FAX": "Enum description for FAX"
+               }
+            },
+            "countryCode": {
+               "type": "string",
+               "description": "Country code of the country (ISO3166-1). E.g. \"US\" for the United States",
+               "pattern": "[A-Z]{2}"
+            },
+            "countryCallingCode": {
+               "type": "string",
+               "description": "Country calling code of the phone number, as defined by the International Communication Union. Examples - \"1\" for US, \"371\" for Latvia.",
+               "pattern": "[0-9+]{2,5}"
+            },
+            "areaCode": {
+               "type": "string",
+               "description": "Corresponds to a regional code or a city code. The length of the field varies depending on the area.",
+               "pattern": "[0-9]{1,4}"
+            },
+            "number": {
+               "type": "string",
+               "description": "Phone number. Composed of digits only. The number of digits depends on the country.",
+               "pattern": "[0-9]{1,15}"
+            },
+            "extension": {
+               "type": "string",
+               "description": "Extension of the phone"
+            },
+            "text": {
+               "type": "string",
+               "description": "String containing the full phone number - applicable only when a structured phone (i.e. countryCallingCode + number) is not provided"
+            }
+         },
+         "title": "Phone"
+      },
+      "address": {
+         "type": "object",
+         "description": "Address information",
+         "properties": {
+            "category": {
+               "description": "Category of the contact element",
+               "type": "string",
+               "enum": [
+                  "BUSINESS",
+                  "PERSONAL",
+                  "OTHER"
+               ],
+               "x-enum-descriptions": {
+                  "BUSINESS": "Enum description for BUSINESS",
+                  "PERSONAL": "Enum description for PERSONAL",
+                  "OTHER": "Enum description for OTHER"
+               }
+            },
+            "lines": {
+               "type": "array",
+               "description": "Line 1 = Street address, Line 2 = Apartment, suite, unit, building, floor, etc",
+               "items": {
+                  "type": "string"
+               }
+            },
+            "postalCode": {
+               "type": "string",
+               "description": "Example: 74130"
+            },
+            "countryCode": {
+               "type": "string",
+               "description": "ISO 3166-1 country code",
+               "pattern": "[a-zA-Z]{2}"
+            },
+            "cityName": {
+               "type": "string",
+               "description": "Full city name. Example: Dublin",
+               "pattern": "[a-zA-Z -]{1,35}"
+            },
+            "stateCode": {
+               "type": "string",
+               "description": "State code (two character standard IATA state code)",
+               "pattern": "[a-zA-Z0-9]{1,2}"
+            },
+            "postalBox": {
+               "type": "string",
+               "description": "E.g. BP 220"
+            },
+            "text": {
+               "type": "string",
+               "description": "Field containing a full unformatted address. Only applicable when the fields lines, postalCode, countryCode, cityName are not filled."
+            }
+         },
+         "title": "Address"
+      },
+      "email": {
+         "type": "object",
+         "description": "Email information.",
+         "properties": {
+            "category": {
+               "description": "Category of the contact element",
+               "type": "string",
+               "enum": [
+                  "BUSINESS",
+                  "PERSONAL",
+                  "OTHER"
+               ],
+               "x-enum-descriptions": {
+                  "BUSINESS": "Enum description for BUSINESS",
+                  "PERSONAL": "Enum description for PERSONAL",
+                  "OTHER": "Enum description for OTHER"
+               }
+            },
+            "address": {
+               "type": "string",
+               "description": "Email address (e.g. john@smith.com)"
+            }
+         },
+         "title": "Email"
+      },
+      "notificationType": {
+         "description": "the preferred method of notifying this Contact of events",
+         "type": "string",
+         "enum": [
+            "CALL",
+            "TEXT"
+         ],
+         "x-enum-descriptions": {
+            "CALL": "Enum description for CALL",
+            "TEXT": "Enum description for TEXT"
+         }
+      },
+      "language": {
+         "description": "the preferred language of communication with this Contact",
+         "type": "string"
+      },
+      "purpose": {
+         "description": "the purpose for which this contact is to be used",
+         "type": "array",
+         "items": {
+            "type": "string",
+            "enum": [
+               "STANDARD",
+               "NOTIFICATION",
+               "EMERGENCY"
+            ],
+            "x-enum-descriptions": {
+               "STANDARD": "Enum description for STANDARD",
+               "NOTIFICATION": "Enum description for NOTIFICATION",
+               "EMERGENCY": "Enum description for EMERGENCY"
+            }
+         }
+      },
+      "isDeclined": {
+         "type": "boolean",
+         "description": "Justification why the \"contact\" structure is empty - the subject was asked, if they wish to provide contact details, but they decided to decline to provide it for the purpose listed above"
+      },
+      "comment": {
+         "description": "a general comment about this Contact",
+         "type": "string"
+      },
+      "source": {
+         "description": "The source system which added the Contact information",
+         "type": "string",
+         "enum": [
+            "RESERVATION",
+            "DCS"
+         ],
+         "x-enum-descriptions": {
+            "RESERVATION": "Enum description for RESERVATION",
+            "DCS": "Enum description for DCS"
+         },
+         "example": "DCS"
+      },
+      "priority": {
+         "description": "The priority for this Contact information",
+         "type": "string",
+         "enum": [
+            "HIGH",
+            "MEDIUM",
+            "LOW"
+         ],
+         "x-enum-descriptions": {
+            "HIGH": "Enum description for HIGH",
+            "MEDIUM": "Enum description for MEDIUM",
+            "LOW": "Enum description for LOW"
+         },
+         "example": "HIGH"
+      },
+      "isThirdParty": {
+         "type": "boolean",
+         "description": "If set, this flag indicates that the contact belongs to an other person than the passenger (e.g. friend or family member not part of the trip). This option is only available for mobile phone and email and for a notification purpose."
+      }
+   }
+}

package/src/__fixtures__/schemas/media-entry.json

@@ -0,0 +1,69 @@
+{
+  "properties": {
+    "attribution": {
+      "description": "??? Unknown ???",
+      "type": "string"
+    },
+    "caption": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/CaptionData"
+    },
+    "comments": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/CommentsCollection"
+    },
+    "created_time": {
+      "description": "Media creation UNIX timestamp",
+      "type": "string"
+    },
+    "filter": {
+      "description": "Filter of this media entry",
+      "type": "string"
+    },
+    "id": {
+      "description": "ID of a media entry",
+      "type": "string"
+    },
+    "images": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/ImagesData"
+    },
+    "likes": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/LikesCollection"
+    },
+    "link": {
+      "description": "Fixed URL of this media entry",
+      "type": "string"
+    },
+    "location": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/LocationInfo"
+    },
+    "tags": {
+      "description": "List of tags assigned to this media",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
+    "type": {
+      "description": "Type of this media entry",
+      "enum": ["image", "video"],
+      "type": "string"
+    },
+    "user": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/UserShortInfo"
+    },
+    "user_has_liked": {
+      "description": "Indicates whether authenticated user has liked this media or not",
+      "type": "boolean"
+    },
+    "users_in_photo": {
+      "description": "Users located on this media entry",
+      "items": {
+        "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/UserInPhoto"
+      },
+      "type": "array"
+    },
+    "videos": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/sample-specs/reference/instagram/instagram.yaml/definitions/VideosData"
+    }
+  },
+  "type": "object"
+}

package/src/__fixtures__/schemas/simple.json

@@ -0,0 +1,27 @@
+{
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "name": {
+      "$ref": "#/definitions/name"
+    },
+    "todo": {
+      "$ref": "https://stoplight.io/api/nodes.raw?srn=gh/stoplightio/studio-demo/reference/todos/models/todo-full.v1.json"
+    }
+  },
+  "definitions": {
+    "name": {
+      "type": "object",
+      "properties": {
+        "first_name": {
+          "type": "string"
+        },
+        "last_name": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package/src/__fixtures__/schemas/todo-full.v1.json

@@ -0,0 +1,35 @@
+{
+  "title": "Todo Full",
+  "allOf": [
+    {
+      "$ref": "http://stoplight.io/api/nodes.raw?srn=gh/stoplightio/studio-demo/reference/todos/models/todo-partial.v1.json"
+    },
+    {
+      "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": {
+          "$ref": "http://stoplight.io/api/nodes.raw?srn=gh/stoplightio/studio-demo/reference/todos/models/user.v1.json"
+        }
+      },
+      "required": ["id", "user"]
+    }
+  ],
+  "x-tags": ["Todos"]
+}

package/src/__fixtures__/schemas/todo-partial.v1.json

@@ -0,0 +1,14 @@
+{
+  "title": "Todo Partial",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "completed": {
+      "type": ["boolean", "null"]
+    }
+  },
+  "required": ["name", "completed"],
+  "x-tags": ["Todos"]
+}

package/src/__fixtures__/schemas/user.v1.json

@@ -0,0 +1,17 @@
+{
+  "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"]
+}

package/src/__fixtures__/security-schemes/index.ts

@@ -0,0 +1,38 @@
+import { HttpSecurityScheme } from '@stoplight/types';
+
+export const apiKey: HttpSecurityScheme = {
+  id: '?http-security-apiKey?',
+  key: 'apiKey',
+  type: 'apiKey',
+  in: 'query',
+  name: 'apikey',
+};
+
+export const oauth: HttpSecurityScheme = {
+  id: '?http-security-oauth_scheme?',
+  key: 'oauth_scheme',
+  type: 'oauth2',
+  flows: {
+    implicit: {
+      authorizationUrl: 'https://implicit.authorization-url.com',
+      refreshUrl: 'https://implicit.refresh-url.com',
+      scopes: { 'scope:implicit': 'implicit scope description' },
+    },
+    password: {
+      tokenUrl: 'https://password.token-url.com',
+      refreshUrl: 'https://password.refresh-url.com',
+      scopes: { 'scope:password': 'password scope description' },
+    },
+    clientCredentials: {
+      tokenUrl: 'https://clientCredentials.token-url.com',
+      refreshUrl: 'https://clientCredentials.refresh-url.com',
+      scopes: { 'scope:clientCredentials': 'clientCredentials scope description' },
+    },
+    authorizationCode: {
+      authorizationUrl: 'https://authorizationCode.authorization-url.com',
+      tokenUrl: 'https://authorizationCode.token-url.com',
+      refreshUrl: 'https://authorizationCode.refresh-url.com',
+      scopes: { 'scope:authorizationCode': 'authorizationCode scope description' },
+    },
+  },
+};

package/src/__fixtures__/services/petstore.ts

@@ -0,0 +1,167 @@
+import { IHttpService } from '@stoplight/types';
+
+export const httpService: IHttpService = {
+  id: '?http-service?',
+  name: 'Petstore (OpenAPI v3)',
+  description:
+    'This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters. \n\n',
+  termsOfService: 'https://terms-of-service.com',
+  contact: {
+    name: 'Support',
+    url: 'https://stoplight.io',
+    email: 'support@stoplight.io',
+  },
+  license: {
+    name: 'Apache 2.0',
+    url: 'https://www.apache.org/licenses/LICENSE-2.0.txt',
+  },
+  version: '1.0.0',
+  servers: [
+    {
+      id: '?http-server-0?',
+      url: 'https://api.stoplight.io',
+      description: 'Production API',
+    },
+    {
+      id: '?http-server-1?',
+      url: 'https://api.{environment}.stoplight.io',
+      description: 'Staging API',
+      variables: {
+        environment: {
+          description: 'The kind of a durable test environment',
+          enum: ['staging', 'int'],
+          default: 'staging',
+        },
+      },
+    },
+    {
+      id: '?http-server-3?',
+      url: 'https://localhost:{port}',
+      description: 'Development API',
+      variables: {
+        port: {
+          enum: ['8443', '443'],
+          default: '8443',
+        },
+      },
+    },
+  ],
+  securitySchemes: [],
+  security: [
+    [
+      {
+        id: '?http-security-0?',
+        key: 'oauth_scheme',
+        type: 'oauth2',
+        description:
+          'Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.',
+        flows: {
+          implicit: {
+            authorizationUrl: 'https://implicit.authorization-url.com',
+            refreshUrl: 'https://implicit.refresh-url.com',
+            scopes: { 'scope:implicit': 'implicit scope description' },
+          },
+          password: {
+            tokenUrl: 'https://password.token-url.com',
+            refreshUrl: 'https://password.refresh-url.com',
+            scopes: { 'scope:password': 'password scope description' },
+          },
+          clientCredentials: {
+            tokenUrl: 'https://clientCredentials.token-url.com',
+            refreshUrl: 'https://clientCredentials.refresh-url.com',
+            scopes: { 'scope:clientCredentials': 'clientCredentials scope description' },
+          },
+          authorizationCode: {
+            authorizationUrl: 'https://authorizationCode.authorization-url.com',
+            tokenUrl: 'https://authorizationCode.token-url.com',
+            refreshUrl: 'https://authorizationCode.refresh-url.com',
+            scopes: { 'scope:authorizationCode': 'authorizationCode scope description' },
+          },
+        },
+      },
+    ],
+    [
+      {
+        id: '?http-security-api_key?',
+        key: 'api_key',
+        type: 'apiKey',
+        name: 'API Key',
+        in: 'query',
+        description: "Use `?apikey=123` to authenticate requests. It's super secure.",
+      },
+      {
+        id: '?http-security-api_key2?',
+        key: 'api_key2',
+        type: 'apiKey',
+        name: 'Alternate API key',
+        in: 'query',
+        description: "Use `?apikey=123` to authenticate requests. It's super secure.",
+      },
+    ],
+    [
+      {
+        id: '?http-security-openIdConnectKey?',
+        key: 'openIdConnectKey',
+        type: 'openIdConnect',
+        description:
+          'Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.',
+        openIdConnectUrl: 'http://openIdConnect.com',
+      },
+    ],
+    [],
+    [
+      {
+        id: '?http-security-oauth2Key?',
+        key: 'oauth2Key',
+        type: 'oauth2',
+        description:
+          'Get access to data while protecting your account credentials. OAuth2 is also a safer and more secure way to give you access.',
+        flows: {
+          implicit: {
+            scopes: {
+              'write:pets': 'modify pets in your account',
+              'read:pets': 'read your pets',
+            },
+            refreshUrl: 'http://refreshUrl.com',
+            authorizationUrl: 'http://authorizationUrl.com',
+          },
+          password: {
+            scopes: {
+              'write:pets': 'modify pets in your account',
+              'read:pets': 'read your pets',
+            },
+            refreshUrl: 'http://refreshUrl.com',
+            tokenUrl: 'http://tokenUrl.com',
+          },
+          clientCredentials: {
+            scopes: {
+              'write:pets': 'modify pets in your account',
+              'read:pets': 'read your pets',
+            },
+            refreshUrl: 'http://refreshUrl.com',
+            tokenUrl: 'http://tokenUrl.com',
+          },
+          authorizationCode: {
+            scopes: {
+              'write:pets': 'modify pets in your account',
+              'read:pets': 'read your pets',
+            },
+            refreshUrl: 'http://refreshUrl.com',
+            tokenUrl: 'http://tokenUrl.com',
+            authorizationUrl: 'http://authorizationUrl.com',
+          },
+        },
+      },
+      {
+        id: '?http-security-api_key?',
+        key: 'api_key',
+        type: 'apiKey',
+        name: 'API Key',
+        in: 'query',
+        description: "Use `?apikey=123` to authenticate requests. It's super secure.",
+      },
+    ],
+  ],
+};
+
+export default httpService;