@api-client/ui 0.0.1

package/demo/apis/navigation-api/navigation-api.raml

@@ -0,0 +1,357 @@
+#%RAML 1.0
+title: Navigation demo API
+
+version: v2
+baseUri: https://api.mulesoft.com/{version}
+mediaType: application/json
+
+uses:
+  lib: library.raml
+
+securitySchemes:
+  basic:
+    type: Basic Authentication
+    description: |
+      Test basic auth method
+  other:
+    displayName: Digest
+    type: Digest Authentication
+
+documentation:
+  - title: How to begin
+    content: |
+      Example content
+  - title: Other documentation entry
+    content: |
+      Example content
+types:
+  Image: !include types/image.raml
+  Resource: !include types/resource.raml
+  AppPerson: !include types/app-person.raml
+  Product: !include types/product.raml
+  Picture:
+    displayName: Pic
+    type: object
+    description: The user's profile picture.
+    properties:
+      url:
+        type: string
+        required: false
+        description: A URL that points to a profile picture of this user.
+  Property:
+    type: object
+
+    properties:
+      kind:
+        type: string
+        description: This is always drive#property.
+        default: drive#property
+        enum: [drive#property]
+      etag:
+        type: string
+        description: ETag of the property.
+      selfLink:
+        type: string
+        description: The link back to this property.
+      key:
+        type: string
+        description: The key of this property.
+      visibility:
+        type: string
+        description: The visibility of this property.
+      value:
+        type: string
+        description: The value of this property.
+  ImportFormat:
+    properties:
+      source:
+        type: string
+        description: The imported file's content type to convert from.
+        required: true
+      targets:
+        description: The possible content types to convert to.
+        type: string[]
+        required: true
+  Unionable:
+    type: ImportFormat | Picture
+  Arrable:
+    type: array
+    items: Picture
+/files:
+  displayName: Files
+  post:
+    displayName: Insert
+    description: |
+      Insert a new file.
+      This method supports an /upload URI and accepts uploaded media with the following characteristics:
+
+      - Maximum file size: 5120GB
+      - Accepted Media MIME types: */*
+
+      Note: Apps creating shortcuts with files.insert must specify the MIME type `application/vnd.google-apps.drive-sdk`.
+
+      Apps should specify a file extension in the title property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like `"title": "cat.jpg"` in the metadata.
+
+      Subsequent GET requests include the read-only fileExtension property populated with the extension originally specified in the title property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Google Drive attempts to determine the extension based on the file's MIME type.
+
+      ### HTTP request
+
+      This method provides media upload functionality through two separate URIs. For more details, see the document on media upload.
+
+      - Upload URI, for media upload requests: `POST https://www.googleapis.com/upload/drive/v2/files`
+      - Metadata URI, for metadata-only requests: `POST https://www.googleapis.com/drive/v2/files`
+  get:
+    securedBy: [basic]
+    displayName: list
+    description: |
+      Lists the user's files. Try it now or see an example.
+
+      Requests with `files.list` accept the `q` parameter, which is a search query combining one or more search terms. For more information, see Search for files.
+
+      Note: Note: This method returns all files by default. This includes files with trashed=true in the results. Use the trashed=false query parameter to filter these from the results.
+  /{fileId}:
+    displayName: Get file
+    get:
+      description: "Gets a file's metadata by ID."
+    patch:
+      description: Updates file metadata. This method supports patch semantics.
+    put:
+      description: Updates file metadata and/or content.
+    delete:
+      description: Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file.
+    /copy:
+      post:
+        description: Creates a copy of the specified file.
+    /touch:
+      post:
+        description: "Set the file's updated time to the current server time."
+    /trash:
+      post:
+        description: Moves a file to the trash. The currently authenticated user must own the file.
+    /untrash:
+      post:
+        description: Restores a file from the trash.
+    /parents:
+      get:
+        description: "Lists a file's parents."
+      post:
+        description: Adds a parent folder for a file.
+      /{parentId}:
+        uriParameters:
+          parentId:
+            type: string
+            description: The ID of the parent.
+        get:
+          description: Gets a specific parent reference.
+        delete:
+          description: Removes a parent from a file.
+    /permissions:
+      get:
+        description: "Lists a file's permissions."
+      post:
+        description: |
+          Inserts a permission for a file.
+
+          Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.
+      /{permissionId}:
+        uriParameters:
+          permissionId:
+            type: string
+            description: The ID for the permission.
+        get:
+          description: Gets a permission by ID.
+        put:
+          description: |
+            Updates a permission.
+
+            **Warning**: Concurrent permissions operations on the same file are not supported; only the last update is applied.
+        delete:
+          description: |
+            Deletes a permission from a file.
+
+            Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.
+          responses:
+            204:
+        patch:
+          description: |
+            Updates a permission. This method supports patch semantics.
+
+            **Warning**: Concurrent permissions operations on the same file are not supported; only the last update is applied.
+    /revisions:
+      get:
+      /{revisionId}:
+        uriParameters:
+          revisionId:
+            type: string
+            description: The ID of the revision.
+        get:
+
+        put:
+
+        delete:
+
+        patch:
+
+    /comments:
+      get:
+
+      post:
+        description: Creates a new comment on the given file.
+      /{commentId}:
+        get:
+          description: Gets a comment by ID.
+
+        put:
+
+        delete:
+          description: Deletes a comment.
+
+        patch:
+
+        /replies:
+          get:
+
+          post:
+
+          /{replyId}:
+            uriParameters:
+              replyId:
+                type: string
+                description: The ID of the reply.
+            get:
+              description: Gets a reply.
+
+            put:
+              description: Updates an existing reply.
+
+            delete:
+              description: Deletes a reply.
+
+            patch:
+              description: Updates an existing reply. This method supports patch semantics.
+
+    /realtime:
+
+      get:
+        description: Exports the contents of the Realtime API data model associated with this file as JSON.
+
+      put:
+        displayName: update
+        description: |
+          Overwrites the Realtime API data model associated with this file with the provided JSON data model.
+
+          This method supports an /upload URI and accepts uploaded media with the following characteristics:
+
+          - **Maximum file size**: 10MB
+          - **Accepted Media MIME** types: */*
+
+    /properties:
+      get:
+        description: "Lists a file's properties."
+
+      post:
+        description: Adds a property to a file.
+
+      /{propertyKey}:
+        uriParameters:
+          propertyKey:
+            type: string
+            description: The key of the property.
+        get:
+
+        put:
+
+        delete:
+
+        patch:
+
+  /trash:
+    delete:
+      description: "Permanently deletes all of the user's trashed files."
+  /{folderId}/children:
+    post:
+      description: Inserts a file into a folder.
+
+    get:
+      description: "Lists a folder's children. To list all children of the root folder, use the alias root for the folderId value."
+
+    /{childId}:
+      delete:
+        description: Removes a child from a folder.
+      get:
+        description: Gets a specific child reference.
+/about:
+  displayName: About
+  get:
+    description: Gets the information about the current user along with Drive API settings.
+
+/changes:
+  displayName: Changes
+  get:
+
+  /{changeId}:
+    uriParameters:
+      changeId:
+        type: string
+        description: The ID of the change.
+    get:
+      description: Gets a specific change.
+
+  /watch:
+    post:
+      queryParameters:
+        spaces:
+          type: string
+          required: false
+          description: |
+            A comma-separated list of spaces to query. Supported values are:
+
+            - **drive**
+            - **appDataFolder**
+            - **photos**
+      description: "Watch for all changes to a user's Drive."
+
+/permissionIds/{email}:
+  uriParameters:
+    email:
+      type: string
+      description: The email address for which to return a permission ID
+  get:
+    description: Returns the permission ID for an email address.
+
+/apps:
+  displayName: Apps
+  get:
+    description: "Lists a user's installed apps."
+  /{appId}:
+    uriParameters:
+      appId:
+        type: string
+        description: The ID of the app.
+    get:
+      description: Gets a specific app.
+/channels/stop:
+  post:
+    description: |
+      Stop watching for changes to a resource.
+      If successful, this method returns an empty response body.
+/teamdrives:
+  displayName: Teamdrives
+  post:
+    displayName: insert
+    description: Creates a new Team Drive.
+
+  get:
+    displayName: list
+    description: Lists the user's Team Drives.
+  /{teamDriveId}:
+    uriParameters:
+      teamDriveId:
+        description: The ID of the Team Drive
+    delete:
+      description: |
+        Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.
+    get:
+      description: Gets a Team Drive's metadata by ID.
+    put:
+      description: Updates a Team Drive's metadata

package/demo/apis/navigation-api/types/app-person.raml

@@ -0,0 +1,101 @@
+#%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: "R34fg663H9KW9MMSKISIhTs1dR7Hss7e"
+  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"
+  favouriteNumber: 10
+  favouriteTime: 10:29:52
+  nillable: null
+
+properties:
+  id:
+    description: |
+      A unique identifier of a person.
+
+      It is a 32 bit string containing alphanumeric characters.
+    minLength: 32
+    maxLength: 32
+    pattern: "[A-Za-z0-9]*"
+  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: date-only
+    description: The person's date of birth, represented as YYYY-MM-DD.
+  favouriteTime:
+    type: time-only
+    description: The person's favourite time of day
+  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.
+    enum: [male, female, other]
+    examples:
+      Women: female
+      Man: male
+      Elmo: other
+  favouriteNumber:
+    type: number
+    minimum: 0
+    maximum: 9999
+    multipleOf: 5
+    required: true
+    displayName: Favourite number
+    example: 25
+  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.
+  newsletter:
+    type: boolean
+    required: false
+    default: false
+  age:
+    type: integer
+    required: false
+    description: |
+      Very unpractical property to have in a data store.
+  created:
+    type: datetime-only
+    required: false
+    example: 2018-04-09T19:10:15
+  fietype:
+    required: false
+    type: file
+    fileTypes:
+      - image/png
+      - image/jpeg
+      - image/jpg
+      - image/gif
+    minLength: 10
+    maxLength: 1000
+  nillable:
+    type: string | nil
+    default: null

package/demo/apis/navigation-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/demo/apis/navigation-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/demo/apis/navigation-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/demo/apis/new-oas3-types/new-oas3-types.yaml

@@ -0,0 +1,84 @@
+openapi: 3.0.1
+info:
+  title: New OAS 3 types API
+  version: v1
+components:
+  schemas:
+    Person:
+      type: object
+      properties:
+        pets:
+          type: array
+          items:
+            $ref: '#/components/schemas/Pet'
+    Pet:
+      oneOf:
+        - $ref: '#/components/schemas/Cat'
+        - $ref: '#/components/schemas/Dog'
+        - $ref: '#/components/schemas/Tiger'
+    Animal:
+      type: object
+      discriminator:
+        propertyName: petType
+      properties:
+        name:
+          type: string
+        petType:
+          type: string
+      required:
+        - name
+        - petType
+    Monster:
+      anyOf:
+        - $ref: '#/components/schemas/Cat'
+        - $ref: '#/components/schemas/Dog'
+        - $ref: '#/components/schemas/Tiger'
+    Cat:  ## "Cat" will be used as the discriminator value
+      description: A representation of a cat
+      allOf:
+        - $ref: '#/components/schemas/Animal'
+        - type: object
+          properties:
+            huntingSkill:
+              type: string
+              description: The measured skill for hunting
+              enum:
+                - clueless
+                - lazy
+                - adventurous
+                - aggressive
+          required:
+            - huntingSkill
+    Dog:  ## "Dog" will be used as the discriminator value
+      description: A representation of a dog
+      allOf:
+        - $ref: '#/components/schemas/Animal'
+        - type: object
+          properties:
+            packSize:
+              type: integer
+              format: int32
+              description: the size of the pack the dog is from
+              default: 0
+              minimum: 0
+          required:
+            - packSize
+    Tiger:
+      description: A representation of a Tiger
+      type: object
+      properties:
+        deadliness:
+          type: number
+paths:
+  /pets:
+    get:
+      description: Returns all available pets
+      responses:
+        '200':
+          description: List of pets
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Pet'