@api-client/core 0.8.2 → 0.8.4

package/data/apis/arc-demo-api/resourceTypes/example-types.raml

@@ -0,0 +1,45 @@
+#%RAML 1.0 Library
+
+types:
+  Org:
+    description: Represents an organization unit.
+    type: object
+    properties:
+      onCall: Alertable # inherits all properties from type `Alertable`
+      Head: Manager # inherits all properties from type `Manager`
+  Person:
+    type: object
+    properties:
+      firstname: string
+      lastname: string
+      title?: string
+      kind: string # may be used to differenciate between classes that extend from `Person`
+    example:
+      firstname: Pawel
+      lastname: Psztyc
+      title: Mr.
+      kind: Manager
+  Phone:
+    type: string
+    pattern: "^[0-9|-]+$" # defines pattern for the content of type `Phone`
+  Manager:
+    type: Person # inherits all properties from type `Person`
+    properties:
+      reports: Person[] # inherits all properties from type `Person`; array type where `[]` is a shortcut
+      phone:  Phone
+      kind:
+        type: string
+        enum: [AcmeManager]
+  Admin:
+    type: Person # inherits all properties from type `Person`
+    properties:
+      kind:
+        type: string
+        enum: [AcmeAdmin]
+      clearanceLevel:
+        enum: [ low, high ]
+  AlertableAdmin:
+    type: Admin # inherits all properties from type `Admin`
+    properties:
+      phone: Phone # inherits all properties from type `Phone`; uses shortcut syntax
+  Alertable: Manager | AlertableAdmin # union type; either a `Manager` or `AlertableAdmin`

package/data/apis/arc-demo-api/resourceTypes/image.raml

@@ -0,0 +1,23 @@
+#%RAML 1.0 DataType
+
+description: |
+  An image object representing an image object strored in the file store.
+  The image can be only included in the response. It has no effect if the Image appear in the
+  request. Endpoint handles image creation on it's own and clients can't process images
+  except of sending image data.
+
+type: object
+properties:
+  url:
+    type: string
+    description: |
+      The URL of the image.
+      To resize the image and crop it to a square, append the query string **?sz=x**, where x is the dimension in pixels of each side.
+  thumb:
+    type: string
+    displayName: Thumbnail
+    description: |
+      An URL to the thumbnail of the image. Thumbnails are 60x60px cropped images of the original image.
+example:
+  url: https://domain.com/profile/pawel.psztyc/image
+  thumb: https://domain.com/profile/pawel.psztyc/image/thumb

package/data/apis/arc-demo-api/resourceTypes/message-sent-type.raml

@@ -0,0 +1,23 @@
+#%RAML 1.0 DataType
+
+type: object
+description: |
+  Message sent by a user object. This represents a message in user's sent folder.
+properties:
+  email:
+    type: string
+    description: Receiver email address. It's a virtual email address assigned to this user. Messages sent to this address will be rerouted to user's original address.
+  message:
+    type: string
+    description: Message body
+  timestamp:
+    type: integer
+    description: Message sent timestamp as a Uxin timestamp.
+  attachements:
+    type: string[]
+    description: List of URLs to the attachments
+    required: false
+  important:
+    type: boolean
+    description: True if the message should be marked as an important.
+    required: false

package/data/apis/arc-demo-api/resourceTypes/message-type.raml

@@ -0,0 +1,33 @@
+#%RAML 1.0 DataType
+
+type: object
+description: An user message object.
+properties:
+  from:
+    type: object
+    description: Object representing sender of the message.
+    required: false
+    properties:
+      uid:
+        type: string
+        description: User ID.
+      name:
+        type: string
+        description: User full name
+      email:
+        type: string
+        description: User emaill address to be used to return the message. It's a virtual email address assigned to this user. Messages sent to this address will be rerouted to user's original address.
+  message:
+    type: string
+    description: Message body
+  timestamp:
+    type: integer
+    description: Message sent timestamp as a Uxin timestamp.
+  attachements:
+    type: string[]
+    description: List of URLs to the attachments
+    required: false
+  important:
+    type: boolean
+    description: True if the message should be marked as an important.
+    required: false

package/data/apis/arc-demo-api/resourceTypes/product.raml

@@ -0,0 +1,52 @@
+#%RAML 1.0 DataType
+
+displayName: A product resource
+description: A single product representing an item in the store.
+type: !include resource.raml
+properties:
+  id:
+    description: |
+      Product id. It is a UUID of the database record.
+      __This property will be ignored when creating an object.__
+      It will be available when the product is stored in the datastore.
+    pattern: "[0-9a-zA-Z-]+"
+  name:
+    type: string
+    description: Product name
+    example: Acme product - mentol flavor, 500 ml.
+    required: true
+  quantity:
+    type: number
+    description: |
+      The quantity of the product in the one unit of measurement.
+      See `unit` property for more information.
+    example: 500
+    required: true
+  unit:
+    type: string
+    description: The unit of measuremet for the quantity property.
+    example: ml
+    required: true
+  upc:
+    type: string
+    pattern: "[0-9]{12,12}"
+    description: |
+      The Universal Produc Code. It consists of 12 numerical digits. However, because of the
+      integer precision limitation in JavaScript it is represented as a string.
+    example: "042100005264"
+    required: true
+  available:
+    type: boolean
+    description: |
+      Product current availability in the store.
+      Product may be not available but the users still can order it with later delivery date.
+    required: true
+    example: true
+example:
+  id: we2322-4f4f4f-f4f4ff-f4f4ff4
+  name: Acme Product
+  quantity: 200
+  unit: ml
+  upc: "123456789101"
+  available: true
+  etag: "Wsd3deef3rgrgf4r"

package/data/apis/arc-demo-api/resourceTypes/resource.raml

@@ -0,0 +1,11 @@
+#%RAML 1.0 DataType
+
+description: |
+  Common properties for all resources returned by the API.
+type: object
+properties:
+  etag:
+    type: string
+    description: |
+      ETag of this resource for caching purposes.
+      __This property will be ignored when creating an object.__

package/data/apis/arc-demo-api/schemas/error-response.xsd

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
+  <xs:element name="resource">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="message" type="xs:string"></xs:element>
+      </xs:sequence>
+      <xs:attribute name="error" type="xs:boolean" use="required"/>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/arc-demo-api/schemas/image.xsd

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
+  <xs:element name="image">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="url" type="xs:string"></xs:element>
+        <xs:element name="thumb" type="xs:string"></xs:element>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/arc-demo-api/schemas/person.json

@@ -0,0 +1,104 @@
+{
+  "$id": "http://example.com/example.json",
+  "type": "object",
+  "definitions": {},
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "properties": {
+    "id": {
+      "$id": "/properties/id",
+      "type": "string",
+      "title": "The Id Schema ",
+      "default": "",
+      "examples": [
+        "R34fg663H9KW9MMSKISI"
+      ]
+    },
+    "name": {
+      "$id": "/properties/name",
+      "type": "string",
+      "title": "The Name Schema ",
+      "default": "",
+      "examples": [
+        "Pawel Psztyc"
+      ]
+    },
+    "birthday": {
+      "$id": "/properties/birthday",
+      "type": "string",
+      "title": "The Birthday Schema ",
+      "default": "",
+      "examples": [
+        "1983-10-20"
+      ]
+    },
+    "gender": {
+      "$id": "/properties/gender",
+      "type": "string",
+      "title": "The Gender Schema ",
+      "default": "",
+      "examples": [
+        "male"
+      ]
+    },
+    "url": {
+      "$id": "/properties/url",
+      "type": "string",
+      "title": "The Url Schema ",
+      "default": "",
+      "examples": [
+        "https://domain.com/profile/pawel.psztyc"
+      ]
+    },
+    "image": {
+      "$id": "/properties/image",
+      "type": "object",
+      "properties": {
+        "url": {
+          "$id": "/properties/image/properties/url",
+          "type": "string",
+          "title": "The Url Schema ",
+          "default": "",
+          "examples": [
+            "https://domain.com/profile/pawel.psztyc/image"
+          ]
+        },
+        "thumb": {
+          "$id": "/properties/image/properties/thumb",
+          "type": "string",
+          "title": "The Thumb Schema ",
+          "default": "",
+          "examples": [
+            "https://domain.com/profile/pawel.psztyc/image/thumb"
+          ]
+        }
+      }
+    },
+    "tagline": {
+      "$id": "/properties/tagline",
+      "type": "string",
+      "title": "The Tagline Schema ",
+      "default": "",
+      "examples": [
+        "Some text about me."
+      ]
+    },
+    "language": {
+      "$id": "/properties/language",
+      "type": "string",
+      "title": "The Language Schema ",
+      "default": "",
+      "examples": [
+        "en_GB"
+      ]
+    },
+    "etag": {
+      "$id": "/properties/etag",
+      "type": "string",
+      "title": "The Etag Schema ",
+      "default": "",
+      "examples": [
+        "W\\244m4n5kj3gbn2nj4k4n4"
+      ]
+    }
+  }
+}

package/data/apis/arc-demo-api/schemas/person.xsd

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
+  <xs:element name="resource">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="id" type="xs:string"></xs:element>
+        <xs:element name="name" type="xs:string"></xs:element>
+        <xs:element name="birthday" type="xs:date"></xs:element>
+        <xs:element name="gender" type="xs:string"></xs:element>
+        <xs:element name="url" type="xs:string"></xs:element>
+        <xs:element name="image">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="url" type="xs:string"></xs:element>
+              <xs:element name="thumb" type="xs:string"></xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+        <xs:element name="tagline" type="xs:string"></xs:element>
+        <xs:element name="language" type="xs:string"></xs:element>
+      </xs:sequence>
+      <xs:attribute name="error" type="xs:boolean" use="required"></xs:attribute>
+      <xs:attribute name="type" type="xs:string" use="required"></xs:attribute>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/arc-demo-api/schemas/product.xsd

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
+  <xs:element name="resource">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="id" type="xs:string"></xs:element>
+        <xs:element name="name" type="xs:string"></xs:element>
+        <xs:element name="quantity" type="xs:double"></xs:element>
+        <xs:element name="unit" type="xs:string"></xs:element>
+        <xs:element name="upc" type="xs:string"></xs:element>
+        <xs:element name="available" type="xs:string"></xs:element>
+      </xs:sequence>
+      <xs:attribute name="error" type="xs:string"></xs:attribute>
+      <xs:attribute name="type" type="xs:string"></xs:attribute>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/arc-demo-api/securitySchemes/basic.raml

@@ -0,0 +1,5 @@
+#%RAML 1.0 SecurityScheme
+
+description: |
+  This API supports Basic Authentication for staging environment.
+type: Basic Authentication

package/data/apis/arc-demo-api/securitySchemes/oauth_2_0.raml

@@ -0,0 +1,29 @@
+#%RAML 1.0 SecurityScheme
+type: OAuth 2.0
+description: This API supports OAuth 2.0 for authenticating all API requests.
+describedBy:
+  queryParameters:
+    access_token:
+      type: string
+      description: Used to send a valid OAuth 2 access token. Do not use with the "Authorization" header.
+      required: false
+  headers:
+    authorization:
+      type: string
+      example: ya.2453vfDb3cJHisdf.*&H
+      description: Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
+      required: false
+  responses:
+    401:
+      description: Bad or expired token. This can happen if the user or Dropbox revoked or expired an access token. To fix, re-authenticate the user.
+      body:
+        application/json:
+    403:
+      description: Bad OAuth request (wrong consumer key, bad nonce, expired timestamp...). Unfortunately, re-authenticating the user won't help here.
+      body:
+        application/json:
+settings:
+  accessTokenUri: http://api.domain.com/oauth2/token
+  authorizationUri: http://api.domain.com/oauth2/auth
+  authorizationGrants: ["authorization_code", "implicit"]
+  scopes: ["profile", "email"]

package/data/apis/arc-demo-api/securitySchemes/x-custom.raml

@@ -0,0 +1,26 @@
+#%RAML 1.0 SecurityScheme
+
+description: |
+  A custom security scheme for authenticating requests.
+type: x-custom
+describedBy:
+  headers:
+    SpecialToken:
+      description: |
+        Used to send a custom token.
+      type: string
+  queryParameters:
+    debugToken:
+      description: Select one of available values to run the request in the debug mode with selected level.
+      enum: [Info, Log, Warning, Error, Critical]
+      type: string
+      required: false
+    booleanToken:
+      description: Just to test boolean values.
+      type: boolean
+      default: true
+  responses:
+    401:
+      description: |
+        Bad token.
+    403:

package/data/apis/arc-demo-api/traits/adminable.raml

@@ -0,0 +1,23 @@
+#%RAML 1.0 Trait
+
+#displayName: Adminable
+description: Use this to mark a resource that can be changed only by users with admin level.
+
+usage: |
+  Some resources can be changed only by users with Admin clerance level. This resources will be
+  marked with the header `X-Admin-Resource` when requesting it. It means that every attemp to
+  update the resource by non-admin user will result with 401 response.
+
+responses:
+  200:
+    headers:
+      X-Amin-Resource:
+        displayName: Admin resource mark header
+        type: boolean
+        default: false
+        description: This header is not set if the resource can be changed by non-admin users.
+  401:
+    description: |
+      The 401 response will be returned when trying to update the resource with
+      non-admin clerance level. Resources that requires admin privileges are marked with
+      `X-Admin-Resource` header when getting the resource.

package/data/apis/arc-demo-api/traits/pagination.raml

@@ -0,0 +1,83 @@
+#%RAML 1.0 Trait
+
+# displayName: Paginated
+description: The collection of <<resourcePathName>>.
+usage: |
+  This trait is to be used when the resource is paginated that is the edpoint producses
+  a list of resources in the response.
+  Every paginated response contains a `nextPageToken` property that should be used in pagination
+  to request for next page of the results and `items` which is a list of resources.
+  The `items` property is always defined, even if the response is empty. Therefore the `404`
+  response in this case is not possible. Clients need to handle empty responses by their own.
+  It is crutial that the subsequent requests contain the same set of parameters (like `limit`
+  or `start`) because if this values will change then the `nextPageToken` will be revalidated
+  and pagination will start from the first page.
+queryParameters:
+  limit:
+    type: number
+    description: Limit in the response list
+    maximum: 300
+    minimum: 1
+    example: 100
+    default: 25
+    required: false
+  start:
+    type: number
+    description: The start entry of the list
+    minimum: 0
+    example: 25
+    default: 0
+    required: false
+  nextPageToken:
+    type: string
+    example: CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA
+    description: |
+      The `nextPageToken` is a web safe encoded cursor to the next entry in the database.
+      It can be obtained by requesting paginated resource and used in next request to get
+      next results page.
+    pattern: "[a-zA-Z0-9]+"
+    required: false
+responses:
+  200:
+    description: |
+      Paginated response containing a single page of the result.
+      By default one page of the results contains 25 items. You can extend it by setting a
+      `limit` query parameter in your request.
+      When changing parameters while using the `nextPageToken` the `nextPageToken` will be ignored
+      and new query will be performed. Queries with `nextPageToken` should contain the same set
+      of parameters as the first request.
+    body:
+      application/json:
+        type: object
+        properties:
+          items:
+            type: array
+            required: true
+            description: Contains a list of objects for this method.
+            items: <<resourceType>>
+          nextPageToken:
+            type: string
+            required: true
+            example: CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA
+            description: |
+              The next page token is a web safe encoded cursor to the next entry in the database.
+              Use it in the next request to obtain next page of the results.
+  400:
+    description: |
+      The error response when one of the parameters is invalid and can't be parsed.
+      Nothing can be done at this time except correcting the request to send valid data.
+    body:
+      application/json:
+        displayName: Invalid
+        type: object
+        properties:
+          error:
+            type: boolean
+            required: true
+            example: true
+            description: Indicate that the response is errored.
+          message:
+            type: string
+            description: The error message associated with the error.
+            example: The `limit` parameter is invalid. Please, provide a number between 1 and 300.
+            required: true

package/data/apis/arc-demo-api/traits/rate-limited.raml

@@ -0,0 +1,9 @@
+#%RAML 1.0 Trait
+
+displayName: RateLimited
+usage: TO be used when the API has a rate limit on the API gateway.
+headers:
+  x-rate-client-id:
+    description: he client ID to use for the rate limit.
+    example: 5757gh76
+    required: true