@api-client/core 0.8.0 → 0.8.2

package/data/apis/example-generator-api/example-generator-api.raml

@@ -0,0 +1,423 @@
+#%RAML 1.0
+title: API demo
+version: v1
+baseUri: http://api.domain.com/
+
+types:
+  ScalarType: string
+  ScalarArray: string[]
+  ArrayType:
+    type: array
+    items: Image
+  UnionType: Image | Imgs
+  ScalarWithExample:
+    type: number
+    example: 5
+  ScalarArrayWithExample:
+    type: number[]
+    example: [1, 5]
+  SimpleInlineExample:
+    type: object
+    properties:
+      testProperty: boolean
+    example:
+      testProperty: true
+  Image:
+    type: object
+    properties:
+      url: string
+      thumb: string
+  Imgs:
+    properties:
+      something: string
+      images:
+        type: Image[]
+        xml:
+          wrapped: true
+  Person:
+    properties:
+      error?:
+        type: boolean
+        xml:
+          attribute: true
+      id:
+        type: string | number
+      name: string
+      birthday: date-only
+      gender:
+        type: string
+        examples:
+          Male: male
+          Female: female
+      url: string
+      tagline: string
+      language:
+        type: string
+        default: PL
+      etag:
+        type: string
+        example: etag example
+      image:
+        type: object
+        properties:
+          url: string
+          thumb: string
+      opt?: Image | string
+    example:
+      error: false
+      id: 1234
+      name: Pawel Psztyc
+      birthday: 20-10-1983
+      tagline: Test example
+      url: https://domain.com
+      language: PL
+      etag: test
+      image:
+        url: https://image.com
+        thumb: https://image.com/thumb
+  JsonExampleInclude:
+    type: Person
+    example: !include example.json
+  XmlExampleInclude:
+    type: Person
+    example: !include example.xml
+  PropertyExamples:
+    properties:
+      xtra:
+        type: string
+        xml:
+          attribute: true
+      firstName:
+        type: string
+        example: Pawel
+      lastName:
+        type: string
+        example: Psztyc
+      address: Address
+      num: number
+      int: integer
+      bool: boolean
+      defVal:
+        type: integer
+        default: 10
+        example: 1
+  Address:
+    properties:
+      street: string
+      zip:
+        type: string
+        example: "94100"
+        default: "00000"
+      house:
+        type: number
+        example: 1
+  TypeExamples:
+    properties:
+      firstName: string
+      lastName: string
+    example:
+      firstName: Pawel
+      lastName: Psztyc
+  ArrayTypeWithExample:
+    type: array
+    items: Image
+    example: [{"url": "url 1", "thumb": "thumb 1"}]
+  ArrayWithoutItems:
+    type: array
+    displayName: Incomplete array
+  Employee:
+    type: object
+    properties:
+      firstName: string
+      lastName: string
+      position: string
+      deskNumber: string
+  DataTypesExample:
+    type: object
+    properties:
+      typeString:
+        type: string
+        example: String example
+      typeNumber:
+        type: number
+        example: 123456
+      typeInt:
+        type: integer
+        example: 1234546
+      typeDecimal:
+        type: number
+        multipleOf: 0.01
+        example: 10.67
+      typeBool:
+        type: boolean
+        example: true
+      typeNull:
+        type: nil
+        example: null
+      typeNegativeInt:
+        type: integer
+        example: -12
+      typeNumberFormatInt64:
+        type: number
+        minimum: 3
+        maximum: 5
+        format: int64
+        multipleOf: 4
+        example: 8
+      typeNumFormatInt32:
+        type: number
+        format: int32
+        example: 109298
+      typeNumFormatInt:
+        type: number
+        format: int
+        example: 11
+      typeNumFormatLong:
+        type: number
+        format: long
+        example: 123456789
+      typeNumFormatFloat:
+        type: number
+        format: float
+        example: 1234567.89
+      typeNumFormatDouble:
+        type: number
+        format: double
+        example: 1234.56789
+      typeNumFormatInt8:
+        type: number
+        format: int8
+        example: 1
+      typeNumFormatInt16:
+        type: number
+        format: int16
+        example: 2
+      typeIntFormatInt8:
+        type: integer
+        minimum: 3
+        maximum: 5
+        format: int8
+        multipleOf: 1
+        example: 12
+
+/IncludedInType:
+  post:
+    body:
+      application/json:
+        type: Person
+      application/xml:
+        type: Person
+/IncludedInline:
+  post:
+    body:
+      application/json:
+        type: Person
+        example:
+          error: false
+          id: 1234
+          name: Inline person
+          birthday: 01-01-1990
+          tagline: Test example
+          url: https://domain.com
+          language: PL
+          etag: test
+          image:
+            url: https://image.com
+            thumb: https://image.com/thumb
+      application/xml:
+        type: !include example.xsd
+        example: !include example.xml
+/IncludedInlineJson:
+  post:
+    body:
+      application/json:
+        type: !include user.raml
+        example: !include user.json
+/typeExamples:
+  post:
+    body:
+      application/json:
+        type: TypeExamples
+      application/xml:
+        type: TypeExamples
+/propertyExamples:
+  post:
+    body:
+      application/json:
+        type: PropertyExamples
+      application/xml:
+        type: PropertyExamples
+/arrayTypeExample:
+  post:
+    body:
+      application/json:
+        type: TypeExamples[]
+/ArrayType:
+  post:
+    body:
+      application/json:
+        type: ArrayType
+      application/xml:
+        type: ArrayType
+/arrayPropertyExamples:
+  post:
+    body:
+      application/json:
+        type: PropertyExamples[]
+      application/xml:
+        type: PropertyExamples[]
+/arrayPropertyGeneratedExamples:
+  post:
+    body:
+      application/json:
+        type: array
+        items:
+          properties:
+            test: boolean
+            other: string
+      application/xml:
+        type: array
+        items:
+          properties:
+            test: boolean
+            other: string
+/wrappedXml:
+  post:
+    body:
+      application/xml:
+        type: Imgs
+/inline-property-example:
+  post:
+    body:
+      application/json:
+        type: object
+        properties:
+          limit: number
+          items:
+            type: string[]
+            example: [test, other]
+      application/xml:
+        type: object
+        properties:
+          limit: number
+          items:
+            type: string[]
+            example: [test, other]
+/union:
+  post:
+    body:
+      application/json:
+        type: Person | PropertyExamples
+      application/xml:
+        type: Person | PropertyExamples
+/scalar:
+  post:
+    body:
+      application/json:
+        type: integer
+/scalarWithExample:
+  post:
+    body:
+      application/json:
+        type: integer
+        example: 1
+/arrayScalar:
+  post:
+    body:
+      application/json:
+        type: array
+        items: [number]
+/arrayScalarWithExample:
+  post:
+    body:
+      application/json:
+        type: array
+        items: [number]
+        example: [1, 2, 3]
+/user-raml-example:
+  post:
+    body:
+      application/json:
+        type: !include user-raml-example.raml
+        examples:
+          User 3:
+            id: uid3
+            username: ppsztyc
+            firstName: Pawel
+            lastName: Psztyc
+            profilePhoto: https://img/domain.com/ppsztyc
+            email: ppsztyc@domain.com
+          User 4:
+            id: uid4
+            username: jdoe
+            firstName: John
+            lastName: Does
+            profilePhoto: https://img/domain.com/jdoe
+            email: jdoe@domain.com
+      application/xml:
+        type: !include user-raml-example.raml
+/user-json-example:
+  post:
+    body:
+      application/json:
+        type: !include user-json-example.raml
+/users-raml-example:
+  post:
+    body:
+      application/json:
+        type: !include users-raml-example.raml
+      application/xml:
+        type: !include users-raml-example.raml
+/users-json-example:
+  post:
+    body:
+      application/json:
+        type: !include users-json-example.raml
+/named-example:
+  post:
+    body:
+      application/json:
+        examples: !include named-example.raml
+      application/xml:
+        examples: !include named-example.raml
+/named-linked-example:
+  post:
+    body:
+      application/json:
+        examples: !include named-example-with-link.raml
+      application/xml:
+        examples: !include named-example-with-link.raml
+/employees:
+  get:
+    body:
+      application/json:
+        type: Employee[]
+        examples: !include examples/employees.raml
+      application/xml:
+        type: Employee[]
+        examples: !include examples/employees.raml
+  post:
+    body:
+      application/json:
+        type: Employee
+        examples: !include examples/employee.raml
+      application/xml:
+        type: Employee
+        examples: !include examples/employee.raml
+  delete:
+    body:
+      application/json:
+        type: Employee
+        examples: !include examples/employee.raml
+  head:
+    body:
+      application/json:
+        type: Employee
+        examples: !include examples/employee.raml
+/data-types:
+  post:
+    body:
+      application/json:
+        type: DataTypesExample
+      application/xml:
+        type: DataTypesExample

package/data/apis/example-generator-api/example.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/example-generator-api/example.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Person error="false">
+  <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>
+  <etag>W\\244m4n5kj3gbn2nj4k4n4</etag>
+</Person>

package/data/apis/example-generator-api/example.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="Person">
+    <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:element name="etag" type="xs:string"></xs:element>
+      </xs:sequence>
+      <xs:attribute name="error" type="xs:boolean" use="required"></xs:attribute>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

package/data/apis/example-generator-api/examples/employee.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 NamedExample
+
+Employee example:
+  firstName: Other Pawel
+  lastName: Psztyc
+  position: Sr Software Engineer
+  deskNumber: None.

package/data/apis/example-generator-api/examples/employees.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 NamedExample
+
+General Use:
+  firstName: Pawel
+  lastName: Psztyc
+  position: Sr Software Engineer
+  deskNumber: None.

package/data/apis/example-generator-api/linked-named-example.raml

@@ -0,0 +1,21 @@
+companyIdentification: !include example-1.raml
+companyName: 'GRAYDON BELGIË NV'
+alternateCompanyName: 'GRAYDON BELGIQUE NV'
+tradeNames:
+  - 'GRAYDON'
+  - 'MARKTSELECT'
+  - 'CREDITEL'
+  - 'ACM'
+  - 'IT FACILITY MANAGEMENT'
+companyAddress: !include example-2.raml
+contactInformation: !include example-3.raml
+legalForm: !include example-4.raml
+size: !include example-5.raml
+industry:
+  - !include example-6.raml
+activities: !include example-7.raml
+isActive: "true"
+foundationDate: 1940-07-11
+dissolutionDate: 2007-01-01
+nonEmailIndicator: true
+#numberOfBranchOffices: 0

package/data/apis/example-generator-api/named-example-with-link.raml

@@ -0,0 +1,5 @@
+#%RAML 1.0 NamedExample
+
+Named example with link:
+  company: !include linked-named-example.raml
+  startDate: '2000-01-01'

package/data/apis/example-generator-api/named-example.raml

@@ -0,0 +1,9 @@
+#%RAML 1.0 NamedExample
+
+Named example:
+  countryCode: "BE"
+  graydonEnterpriseId: 1057155523
+  registrationId: "0422319093"
+  vatNumber: "BE0422319093"
+  graydonCompanyId: "0422319093"
+  isBranchOffice: false

package/data/apis/example-generator-api/user-json-example.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+type: object
+displayName: User
+properties:
+  id:
+    displayName: Id
+  username:
+    displayName: Username
+  firstName:
+    displayName: First Name
+  lastName:
+    displayName: Last Name
+  profilePhoto:
+    displayName: Profile photo
+  email:
+    displayName: Email
+example: !include user.json

package/data/apis/example-generator-api/user-raml-example.raml

@@ -0,0 +1,37 @@
+#%RAML 1.0 DataType
+type: object
+displayName: User
+properties:
+  id:
+    displayName: Id
+  username:
+    displayName: Username
+  firstName:
+    displayName: First Name
+  lastName:
+    displayName: Last Name
+  profilePhoto:
+    displayName: Profile photo
+  email:
+    displayName: Email
+  age: integer
+  newsletter: boolean
+examples:
+  User 1:
+    id: uid1
+    username: ppsztyc
+    firstName: Pawel
+    lastName: Psztyc
+    profilePhoto: https://img/domain.com/ppsztyc
+    email: ppsztyc@domain.com
+    age: 35
+    newsletter: true
+  User 2:
+    id: uid2
+    username: jdoe
+    firstName: John
+    lastName: Does
+    profilePhoto: https://img/domain.com/jdoe
+    email: jdoe@domain.com
+    age: 25
+    newsletter: false

package/data/apis/example-generator-api/user.json

@@ -0,0 +1,8 @@
+{
+  "id": "4b8c4ccd-c8fd-49ff-aa97-cf434d9d4e97",
+  "username": "char",
+  "firstName": "Charlie",
+  "lastName": "Brown",
+  "profilePhoto": "http://my-photos.com/char.jpg",
+  "email": "char@wash.com"
+}

package/data/apis/example-generator-api/user.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 DataType
+type: object
+displayName: User
+properties:
+  id:
+    displayName: Id
+  username:
+    displayName: Username
+  firstName:
+    displayName: First Name
+  lastName:
+    displayName: Last Name
+  profilePhoto:
+    displayName: Profile photo
+  email:
+    displayName: Email
+  age: integer
+  newsletter: boolean

package/data/apis/example-generator-api/users-json-example.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+type: object
+displayName: User
+properties:
+  id:
+    displayName: Id
+  username:
+    displayName: Username
+  firstName:
+    displayName: First Name
+  lastName:
+    displayName: Last Name
+  profilePhoto:
+    displayName: Profile photo
+  email:
+    displayName: Email
+example: !include users.json

package/data/apis/example-generator-api/users-raml-example.raml

@@ -0,0 +1,32 @@
+#%RAML 1.0 DataType
+type: array
+displayName: Users
+items:
+  properties:
+    id:
+      displayName: Id
+    username:
+      displayName: Username
+    firstName:
+      displayName: First Name
+    lastName:
+      displayName: Last Name
+    profilePhoto:
+      displayName: Profile photo
+    email:
+      displayName: Email
+examples:
+  User 1:
+    id: uid1
+    username: ppsztyc
+    firstName: Pawel
+    lastName: Psztyc
+    profilePhoto: https://img/domain.com/ppsztyc
+    email: ppsztyc@domain.com
+  User 2:
+    id: uid2
+    username: jdoe
+    firstName: John
+    lastName: Does
+    profilePhoto: https://img/domain.com/jdoe
+    email: jdoe@domain.com

package/data/apis/example-generator-api/users.json

@@ -0,0 +1,8 @@
+[{
+  "id": "4b8c4ccd-c8fd-49ff-aa97-cf434d9d4e97",
+  "username": "char",
+  "firstName": "Charlie",
+  "lastName": "Brown",
+  "profilePhoto": "http://my-photos.com/char.jpg",
+  "email": "char@wash.com"
+}]

package/data/apis/expanded-api/expanded-api.raml

@@ -0,0 +1,8 @@
+#%RAML 1.0
+title: Simple API
+
+/people:
+  get:
+  post:
+  put:
+  patch:

package/data/apis/flattened-api/flattened-api.raml

@@ -0,0 +1,8 @@
+#%RAML 1.0
+title: Simple API
+
+/people:
+  get:
+  post:
+  put:
+  patch: