@api-client/core 0.8.2 → 0.8.4

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

@@ -0,0 +1,468 @@
+#%RAML 1.0
+title: API body demo
+version: v1
+baseUri: http://{instance}.domain.com/
+
+mediaType: [application/json, application/xml]
+protocols: [HTTP, HTTPS]
+
+description: |
+  This is a description of demo API.
+
+  This is **markdown**.
+
+baseUriParameters:
+  instance:
+    description: |
+      The execution environments. Can be one of:
+      - development
+      - staging
+      - qa
+      - production
+    type: string
+    enum: [development, staging, qa, production]
+    pattern: (development|staging|qa|production)
+    default: production
+annotationTypes:
+  deprecated: string
+  annotationTest: nil
+  clearanceLevel:
+    properties:
+      level:
+        enum: [ low, medium, high ]
+        required: true
+      signature:
+        pattern: "\\d{3}-\\w{12}"
+        required: true
+uses:
+  ExampleType: resourceTypes/example-types.raml
+  myLib: library.raml
+types:
+  Image: !include resourceTypes/image.raml
+  Resource: !include resourceTypes/resource.raml
+  AppPerson: !include resourceTypes/app-person.raml
+  Product: !include resourceTypes/product.raml
+  ErrorResource:
+    description: A response that is errored
+    type: object
+    properties:
+      error:
+        type: boolean
+        required: true
+        example: true
+        default: true
+        description: Indicate that the response is errored.
+      message:
+        type: string
+        description: The error message associated with the error.
+        required: true
+  Feature:
+    description: A feature to test enum values in the URI parameters.
+    type: string
+    enum:
+      - A
+      - B
+      - C
+
+resourceTypes:
+  ResourceNotFound:
+    get:
+      responses:
+        404:
+          body:
+            application/json:
+              displayName: Not found response
+              type: ErrorResource
+            application/xml:
+              displayName: Not found response
+              type: !include schemas/error-response.xsd
+              example: !include examples/e404.xml
+  UnauthorizedResponse:
+    get:
+      responses:
+        404:
+          body:
+            application/json:
+              displayName: Unauthorized response
+              type: ErrorResource
+            application/xml:
+              displayName: Unauthorized response
+              type: !include schemas/error-response.xsd
+              example: !include examples/e401.xml
+  RequestErrorResponse:
+    get:
+      responses:
+        400:
+          description: The error response when one of the parameters is invalid and can't be parsed. Nothing can be done at the time except correcting the request to send valid data.
+          body:
+            application/json:
+              displayName: Invalid request
+              type: ErrorResource
+            application/xml:
+              displayName: Invalid request
+              type: !include schemas/error-response.xsd
+              example: !include examples/e400.xml
+traits:
+  Paginated: !include traits/pagination.raml
+  Adminable: !include traits/adminable.raml
+  RateLimited: !include traits/rate-limited.raml
+securitySchemes:
+  oauth_2_0: !include securitySchemes/oauth_2_0.raml
+  x-custom: !include securitySchemes/x-custom.raml
+  basic: !include securitySchemes/basic.raml
+
+documentation:
+  - title: Test doc
+    content: Test content
+
+securedBy: [basic]
+
+/test-parameters/{feature}:
+  (deprecated): This endpoint is deprecated and will be removed.
+  securedBy: [myLib.oauthLib]
+  uriParameters:
+    feature:
+      type: string
+      enum:
+        - A
+        - B
+        - C
+  get:
+    (deprecated): This method is deprecated and will be removed.
+    (clearanceLevel):
+      level: high
+      signature: 230-ghtwvfrs1itr
+    description: To test enum values in the URI parameters for inline type declaration.
+    queryParameters:
+      testRepeatable:
+        (deprecated): Test parameter will be removed in next version of the API.
+        required: true
+        type: string[]
+        example: [value1, value2]
+      numericRepeatable:
+        required: true
+        type: integer[]
+        examples:
+          Some-test-example: [123, 456]
+          Other-example: [1011, 1213]
+      notRequiredRepeatable:
+        (annotationTest):
+        type: array
+        items: date-only
+        required: false
+  /{typeFeature}:
+    (annotationTest):
+    (deprecated): This method will be removed in future release of the API.
+    uriParameters:
+      typeFeature:
+        (annotationTest):
+        type: Feature
+    get:
+      (deprecated): This endpoint is deprecated and will be removed.
+      description: To test enum values in the URI parameters for global type declaration.
+/people:
+  displayName: People
+  type: RequestErrorResponse
+  is: [RateLimited]
+  get:
+    (annotationTest):
+    displayName: List people
+    description: Use this method to list all the people.
+    is: [Paginated: {resourceType: AppPerson}]
+    headers:
+      x-people-op-id:
+        (annotationTest):
+        type: string
+        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
+        description: People ops ID. It is UUID v4 string
+        example: 9719fa6f-c666-48e0-a191-290890760b30
+  post:
+    (deprecated): |
+      This method is not deprecated. And this is only an annotation test.
+    displayName: Create a person
+    description: Use this method to add new person
+    body:
+      application/json:
+        (deprecated): This response type is deprecated and soon will be replaced.
+        type: AppPerson
+      application/xml:
+        type: !include schemas/person.xsd
+        example: !include examples/person.xml
+  put:
+    displayName: Update a person
+    description: Updates the person in the datastore.
+    body:
+      application/json:
+        schema: !include schemas/person.json
+        example: !include examples/person.json
+      application/xml:
+        type: !include schemas/person.xsd
+        example: !include examples/person.xml
+    responses:
+      200:
+        (deprecated): This response type is deprecated and soon will be replaced.
+        description: |
+          Success response for the body
+        headers:
+          X-Frame-Options:
+            type: string
+            examples:
+              Deny: DENY
+              SameOrigin: SAMEORIGIN
+        body:
+          application/json:
+            schema: !include schemas/person.json
+            example: !include examples/person.json
+          application/xml:
+            type: !include schemas/person.xsd
+            example: !include examples/person.xml
+  /{personId}:
+    securedBy: x-custom
+    type: ResourceNotFound
+    displayName: A person
+    description: The endpoint to access information about the person
+    uriParameters:
+      personId:
+        type: integer
+        required: true
+        description: The ID of the person in the system. It is generated by the database numeric value for the person.
+        example: 1234
+    get:
+      displayName: Get a person
+      description: Returns a person
+      headers:
+        x-client-id:
+          (deprecated): This will be replaced
+          example: 123456-acme.client.com
+          description: The application id used to make a request. It can be obtained in the developer console.
+          type: string
+          required: true
+        x-people-op-id:
+          (annotationTest):
+          type: string
+          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
+          description: People ops ID. It is UUID v4 string
+          example: 9719fa6f-c666-48e0-a191-290890760b30
+      responses:
+        200:
+          body:
+            application/json:
+              type: AppPerson
+            application/xml:
+              type: !include schemas/person.xsd
+              example: !include examples/person.xml
+    delete:
+      displayName: Remove a person
+      description: Removes the person from the datastore. This method do not returns any data in 200 response.
+      responses:
+        204:
+      headers:
+        x-people-op-id:
+          (annotationTest):
+          type: string
+          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
+          description: People ops ID. It is UUID v4 string
+          example: 9719fa6f-c666-48e0-a191-290890760b30
+    put:
+      displayName: Update a person
+      description: Updates the person in the datastore.
+      queryParameters:
+        testPatam: string
+      body:
+        application/json:
+          type: AppPerson
+        application/xml:
+          type: !include schemas/person.xsd
+          example: !include examples/person.xml
+      responses:
+        200:
+      headers:
+        x-people-op-id:
+          (annotationTest):
+          type: string
+          pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[4][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
+          description: People ops ID. It is UUID v4 string
+          example: 9719fa6f-c666-48e0-a191-290890760b30
+/products:
+  displayName: Products
+  description: The API is to be used to access data about the products.
+  type: RequestErrorResponse
+  post:
+    displayName: Create product
+    description: |
+      Creates a product in the store.
+      While creating a product the `id` and `etag` properties will be ignored.
+
+      The endpoint will reject the request if exactly the same product is already defined in the
+      datastore (all properties of both objects equals). Newly created product is available
+      for listing but **it won't be available for ordering API** until it's availability is not set.
+    body:
+      application/json:
+        type: Product
+      application/xml:
+        type: !include schemas/product.xsd
+        example: !include examples/product.xml
+    responses:
+      200:
+        body:
+          application/json:
+            type: Product
+            examples:
+              Product:
+                id: d697f5cea85011e680f576304dec7eb7
+                name: Super product
+                quantity: 125
+                unit: ml
+                upc: "123456789101"
+                available: true
+                etag: "W/\"686897696a7c876b7e\""
+              OtherProduct:
+                id: 123e4567e89b12d3a456426655440000
+                name: Acme Product
+                quantity: 1
+                unit: kg
+                upc: "223456789101"
+                available: true
+                etag: "W/\"123456789\""
+          application/xml:
+            type: !include schemas/product.xsd
+            example: !include examples/product.xml
+      400:
+        description: The request has been rejected. Probably the product already exists in the datastore.
+/orgs:
+  /{orgId}:
+    is: [RateLimited]
+    get:
+      displayName: Get organization
+      description: Returns an organization info.
+      responses:
+        200:
+          body:
+            application/json:
+              type: ExampleType.Org
+              properties:
+                id:
+                  type: string
+                  description: UUID generated ID
+              example:
+                id: "12345"
+                onCall:
+                  firstname: nico
+                  lastname: ark
+                  kind: AcmeAdmin
+                  clearanceLevel: low
+                  phone: "12321"
+                Head:
+                  firstname: nico
+                  lastname: ark
+                  kind: AcmeManager
+                  reports:
+                    -
+                      firstname: nico
+                      lastname: ark
+                      kind: admin
+                  phone: "123-23"
+    put:
+      body:
+        application/json:
+          type: ExampleType.Org
+          properties:
+            id:
+              type: string
+              description: UUID generated ID
+      responses:
+        200:
+          body:
+            application/json:
+              type: ExampleType.Org
+    /managers:
+      get:
+        responses:
+          200:
+            body:
+              application/json:
+                type: ExampleType.Manager[]
+/messages:
+  securedBy: [oauth_2_0]
+  post:
+    description: Create a new message
+    is:  [Adminable]
+    body:
+      application/json:
+        type: object
+        properties:
+          receiver:
+            type: string
+            description: receiver of the message
+            required: true
+          body:
+            type: string
+            description: A message body
+            required: true
+          important:
+            type: boolean
+            description: If true then the message will be marked as important
+            default: false
+            required: true
+  get:
+    description: |
+      List user messages. It returns an array of messages for last of 7 days if
+      `since` property is not set.
+      You can use `since` and `until` query parameters to control messages time
+      span.
+    queryParameters:
+      until:
+        (annotationTest):
+        type: date-only
+        description: Date right limit of the messages query.
+        example: 2017-05-12
+      since:
+        type: date-only
+        description: Date left limit of the messages query.
+        example: 2017-05-10
+    responses:
+      200:
+        body:
+          application/json:
+            type: array
+            items: !include resourceTypes/message-type.raml
+            example: !include examples/messages-example.json
+  /bulk:
+    post:
+      description: Bulk create messages.
+      is:  [Adminable]
+      body:
+        application/json:
+          (annotationTest):
+          type: array
+          items: !include resourceTypes/message-sent-type.raml
+          examples:
+            Example1: !include examples/messages-sent-example.json
+/arrayBody:
+  post:
+    body:
+      application/json:
+        (deprecated): This response type is deprecated and soon will be replaced.
+        description: |
+          This demonstrates a body as an Array
+        type: AppPerson[]
+/multipleTypeInheritance:
+  get:
+    description: |
+      The response body inherits the following types:
+
+      - AppPerson
+      - AlertableAdmin
+    responses:
+      200:
+        body:
+          application/json:
+            type:
+              - AppPerson
+              - ExampleType.AlertableAdmin
+/typeFromLibraryEndpoint:
+  post:
+    body:
+      type: myLib.TypeFromLibray
+    responses:
+      200:

package/data/apis/arc-demo-api/examples/e400.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource error="true">
+  <message>Invalid request</message>
+</resource>

package/data/apis/arc-demo-api/examples/e401.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource error="true">
+  <message>Unauthorized</message>
+</resource>

package/data/apis/arc-demo-api/examples/e404.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource error="true">
+  <message>Not found</message>
+</resource>

package/data/apis/arc-demo-api/examples/image.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<image>
+  <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image</url>
+  <thumb>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image/thumb</thumb>
+</image>

package/data/apis/arc-demo-api/examples/messages-example.json

@@ -0,0 +1,22 @@
+[
+  {
+    "from": {
+      "uid": "a7917e3c-4abf-11e7-a919-92ebcb67fe33",
+      "name": "Pawel Psztyc",
+      "email": "bea3d5e8-4abf-11e7-a919-92ebcb67fe33-em-vbc@domain.com"
+    },
+    "message": "This is an example message. Hello.",
+    "timestamp": 1496757380,
+    "attachements": [
+      "https://attc.domain.com/01332c24-4ac0-11e7-a919-92ebcb67fe33"
+    ]
+  }, {
+    "from": {
+      "uid": "15e64d90-4ac0-11e7-a919-92ebcb67fe33",
+      "name": "John Doe",
+      "email": "220ce9bc-4abf-11e7-a919-92ebcb67fe33-oa-vbc@domain.com"
+    },
+    "message": "Howdy?",
+    "timestamp": 1496757498
+  }
+]

package/data/apis/arc-demo-api/examples/messages-sent-example.json

@@ -0,0 +1,15 @@
+[
+  {
+    "email": "bea3d5e8-4abf-11e7-a919-92ebcb67fe33-em-vbc@domain.com",
+    "message": "This is an example message. Hello.",
+    "timestamp": 1496757380,
+    "attachements": [
+      "https://attc.domain.com/01332c24-4ac0-11e7-a919-92ebcb67fe33"
+    ]
+  }, {
+    "email": "220ce9bc-4abf-11e7-a919-92ebcb67fe33-oa-vbc@domain.com",
+    "message": "Howdy?",
+    "timestamp": 1496757498,
+    "important": true
+  }
+]

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

@@ -0,0 +1,14 @@
+{
+  "id": "R34fg663H9KW9MMSKISI",
+  "name": "Pawel Psztyc",
+  "birthday": "1983-10-20",
+  "gender": "male",
+  "url": "https://domain.com/profile/pawel.psztyc",
+  "image": {
+    "url": "https://domain.com/profile/pawel.psztyc/image",
+    "thumb": "https://domain.com/profile/pawel.psztyc/image/thumb"
+  },
+  "tagline": "Some text about me.",
+  "language": "en_GB",
+  "etag": "W\\244m4n5kj3gbn2nj4k4n4"
+}

package/data/apis/arc-demo-api/examples/person.url.encoded

@@ -0,0 +1 @@
+id=R34fg663H9KW9MMSKISI&name=Pawel%20Psztyc&birthday=1983-10-20&gender=male&url=https%3A%2F%2Fdomain.com%2Fprofile%2Fpawel.psztyc&tagline=Some%20text%20about%20me.&language=en_GB&etag=W\244m4n5kj3gbn2nj4k4n4

package/data/apis/arc-demo-api/examples/person.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource error="false" type="AppPerson">
+  <id>Qawer63J73HJ6khjswuqyq62382jG21s</id>
+  <name>John Smith</name>
+  <birthday>1990-10-12</birthday>
+  <gender>male</gender>
+  <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s</url>
+  <image>
+    <url>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image</url>
+    <thumb>https://www.domain.com/people/Qawer63J73HJ6khjswuqyq62382jG21s/image/thumb</thumb>
+  </image>
+  <tagline>Hi, I'm John!</tagline>
+  <language>en_US</language>
+</resource>

package/data/apis/arc-demo-api/examples/product.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<resource error="false" type="Product">
+  <id>f2f7933a-a9ce-11e6-80f5-76304dec7eb7</id>
+  <name>Acme product - mentol flavor, 500 ml.</name>
+  <quantity>500</quantity>
+  <unit>ml</unit>
+  <upc>042100005264</upc>
+  <available>true</available>
+</resource>

package/data/apis/arc-demo-api/library.raml

@@ -0,0 +1,36 @@
+#%RAML 1.0 Library
+usage: This is a Library raml
+
+types:
+  TypeFromLibray:
+    properties:
+      age: number
+securitySchemes:
+  oauthLib:
+    type: OAuth 2.0
+    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/resourceTypes/app-person.raml

@@ -0,0 +1,49 @@
+#%RAML 1.0 DataType
+
+displayName: A person resource
+description: |
+  An object representing a person in the API.
+  This object will be used in all methods returning a Person or list of people.
+
+type: !include resource.raml
+example:
+  id: "R34fg663H9KW9MMSKISI"
+  name: "Pawel Psztyc"
+  birthday: "1983-10-20"
+  gender: male
+  url: "https://domain.com/profile/pawel.psztyc"
+  image:
+    url: https://domain.com/profile/pawel.psztyc/image
+    thumb: https://domain.com/profile/pawel.psztyc/image/thumb
+  tagline: Some text about me.
+  language: en_GB
+  etag: "W\\244m4n5kj3gbn2nj4k4n4"
+properties:
+  id:
+    description: A unique identifier for a person. It is a 32 bit string containing alphanumeric characters.
+  name:
+    required: true
+    example: John Smith
+    description: Person full name. The input will be rejected if this property is not set while creating new object.
+    type: string
+    pattern: "[0-9a-zA-Z ]+"
+  birthday:
+    type: string
+    description: The person's date of birth, represented as YYYY-MM-DD.
+  gender?:
+    type: string
+    description: |
+      The person's gender. Possible values includes, but are not limited to, the following values:
+      * "male" - Male gender.
+      * "female" - Female gender.
+      * "other" - Other.
+  url:
+    type: string
+    description: The URL of this person's profile.
+  image: !include image.raml
+  tagline:
+    type: string
+    description: The brief description (tagline) of this person.
+  language:
+    type: string
+    description: The user's preferred language for rendering.