@api-client/core 0.7.12 → 0.8.1

package/data/apis/amf-helper-api/types/dimensions.raml

@@ -0,0 +1,24 @@
+#%RAML 1.0 DataType
+
+description: |
+  A dimmensions of an object like image.
+
+type: object
+properties:
+  width:
+    type: number
+    description: |
+      Width of the shape.
+  height:
+    type: number
+    description: |
+      Height of the shape.
+  unit?:
+    type: string
+    default: px
+    description: |
+      A unit that describes the dimension. It can be, for example, `px` for
+      pixels, `pt` for points, `%` for percentage.
+example:
+  width: 200
+  height: 160

package/data/apis/amf-helper-api/types/external-type.raml

@@ -0,0 +1,7 @@
+#%RAML 1.0 DataType
+description: |
+  An external data-type
+type: object
+properties:
+  prop1:
+    type: string

package/data/apis/amf-helper-api/types/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/amf-helper-api/types/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: "W\\sd3deef3rgrgf4r"

package/data/apis/amf-helper-api/types/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/amf-helper-api/types/standard-request.raml

@@ -0,0 +1,50 @@
+#%RAML 1.0 ResourceType
+
+get:
+  queryParameters:
+    access_token:
+      type: string
+      required: false
+      description: |
+        OAuth 2.0 token for the current user.
+        One possible way to provide an OAuth 2.0 token.
+    callback:
+      type: string
+      required: false
+      description: |
+        Name of the JavaScript callback function that handles the response.
+        Used in JavaScript JSON-P requests.
+    fields:
+      type: string
+      required: false
+      description: |
+        Selector specifying a subset of fields to include in the response.
+        For more information, see the partial response section in the Performance Tips document.
+        Use for better performance.
+    key:
+      type: string
+      required: false
+      description: |
+        Required unless you provide an OAuth 2.0 token.
+        Your API key identifies your project and provides you with API access, quota, and reports.
+        Obtain your project's API key from the Google API Console.
+    prettyPrint:
+      type: boolean
+      required: false
+      description: |
+        Returns response with indentations and line breaks.
+        When this is false, it can reduce the response payload size, which might lead to better performance in some environments.
+      default: true
+    quotaUser:
+      type: string
+      required: false
+      description: |
+        Alternative to `userIp`.
+        Lets you enforce per-user quotas from a server-side application even in cases when the user's IP address is unknown. This can occur, for example, with applications that run cron jobs on App Engine on a user's behalf.
+        You can choose any arbitrary string that uniquely identifies a user, but it is limited to 40 characters.
+        Overrides userIp if both are provided.
+    userIp:
+      type: string
+      required: false
+      description: |
+        IP address of the end user for whom the API call is being made. Lets you enforce per-user quotas when calling the API from a server-side application.

package/data/apis/amf-helper-api/types/user.raml

@@ -0,0 +1,37 @@
+#%RAML 1.0 DataType
+
+displayName: User
+type: object
+description: A representation of a user in Google Drive.
+properties:
+  kind:
+    type: string
+    description: This is always drive#user.
+    enum: [drive#user]
+    default: drive#user
+  displayName:
+    type: string
+    required: false
+    description: A plain text displayable name for this user.
+  picture:
+    type: object
+    description: The user's profile picture.
+    required: false
+    properties:
+      url:
+        type: string
+        required: false
+        description: A URL that points to a profile picture of this user.
+  isAuthenticatedUser:
+    type: boolean
+    required: false
+    description: Whether this user is the same as the authenticated user for whom the request was made.
+    example: false
+  permissionId:
+    type: string
+    required: false
+    description: The user's ID as visible in the permissions collection.
+  emailAddress:
+    type: string
+    required: false
+    description: The email address of the user.

package/data/apis/async-api/async-api.yaml

@@ -0,0 +1,96 @@
+asyncapi: '2.0.0'
+info:
+  title: Hello world application
+  version: '0.1.0'
+servers:
+  production:
+    url: broker.mycompany.com
+    protocol: amqp
+    protocolVersion: 1.0.0
+    description: This is "My Company" broker.
+    security: 
+      - oAuth2: []
+      - foo: []
+channels:
+  hello:
+    publish:
+      message:
+        $ref: '#/components/messages/hello-msg'
+  goodbye:
+    subscribe:
+      message:
+        $ref: '#/components/messages/goodbye-msg'
+components:
+  messages:
+    hello-msg:
+      headers:
+        $ref: '#/components/schemas/hello-headers'
+      payload:
+        type: object
+        properties:
+          name:
+            type: string
+          sentAt:
+            $ref: '#/components/schemas/sent-at'
+    goodbye-msg:
+      headers:
+        type: object
+        oneOf:
+          - $ref: '#/components/schemas/goodbye-headers-1'
+          - $ref: '#/components/schemas/goodbye-headers-2'
+      payload:
+        type: object
+        properties:
+          sentAt:
+            $ref: '#/components/schemas/sent-at'
+  schemas:
+    sent-at:
+      type: string
+      description: The date and time a message was sent.
+      format: datetime
+    hello-headers:
+      type: object
+      properties:
+        x-custom-header:
+          description: You can put whatever you want here
+          type: string
+        Accept:
+          description: You must specificy accept type for response
+          type: string
+        x-request-id:
+          description: Request id for tracing errors
+          type: string
+    goodbye-headers-1:
+      type: object
+      properties:
+        x-first-header:
+          type: string
+        x-second-header:
+          type: string
+    goodbye-headers-2:
+      type: object
+      properties:
+        x-foo:
+          type: string
+        x-bar:
+          type: string
+        x-foo-bar:
+          type: string
+  securitySchemes:
+    foo:
+      type: userPassword
+      description: This is the Foo scheme with username and password config
+    oAuth2:
+      type: oauth2
+      flows:
+        implicit:
+          authorizationUrl: https://example.com/api/oauth/dialog
+          scopes:
+            write:pets: modify pets in your account
+            read:pets: read your pets
+        authorizationCode:
+          authorizationUrl: https://example.com/api/oauth/dialog
+          tokenUrl: https://example.com/api/oauth/token
+          scopes:
+            write:pets: modify pets in your account
+            read:pets: read your pets

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:

package/data/apis/multiple-servers/multiple-servers.yaml

@@ -0,0 +1,112 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+servers:
+  - url: http://petstore.swagger.io/v1
+  - url: http://dev.petstore.swagger.io/v1
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          schema:
+            type: integer
+            format: int32
+      responses:
+        '200':
+          description: A paged array of pets
+          headers:
+            x-next:
+              description: A link to the next page of responses
+              schema:
+                type: string
+          content:
+            application/json:    
+              schema:
+                $ref: "#/components/schemas/Pets"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        '201':
+          description: Null response
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          required: true
+          description: The id of the pet to retrieve
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Expected response to a valid request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Pet"
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+components:
+  schemas:
+    Pet:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: "#/components/schemas/Pet"
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

package/data/model.js

@@ -27,6 +27,11 @@ config.set('recursive/recursive.raml', { type: "RAML 1.0" });
 config.set('oas-types/oas-types.yaml', { type: "OAS 3.0" });
 config.set('oas-date/oas-date.yaml', { type: "OAS 3.0" });
 config.set('oas-unions/oas-unions.yaml', { type: "OAS 3.0" });
+config.set('amf-helper-api/amf-helper-api.raml', { type: "RAML 1.0" });
+config.set('async-api/async-api.yaml', { type: "ASYNC 2.0" });
+config.set('flattened-api/flattened-api.raml', { type: 'RAML 1.0', mime: 'application/yaml', flattened: true });
+config.set('expanded-api/expanded-api.raml', { type: 'RAML 1.0', mime: 'application/yaml', flattened: false });
+config.set('multiple-servers/multiple-servers.yaml', { type: 'OAS 3.0', mime: 'application/yaml' });
 
 const srcFolder = path.join('data', 'apis');
 const descFolder = path.join('data', 'models');