@api-client/ui 0.1.9 → 0.2.2

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

@@ -1,17 +0,0 @@
-<?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/demo/apis/demo-api/securitySchemes/basic.raml

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

package/demo/apis/demo-api/securitySchemes/oauth-2-custom-settings.raml

@@ -1,143 +0,0 @@
-#%RAML 1.0 AnnotationTypeDeclaration
-displayName: OAuth 2.0 custom settings
-description: |
-  OAuth 2.0 allows to extend the specification with custom access token types,
-  endpoint parameters, grant types or response types.
-  This annotation allows you to annotate the `settings` property of OAuth 2.0
-  security scheme type to inform applications about additional settings.
-  ## Use case
-  Let's say a authorization server requires to send a `resource` query parameter
-  with the authorization request. The `resource` parameter can be any string.
-  Currently it is impossible to define this property in RAML file.
-  Similar if the code exchange request requires to put the `resource` parameter
-  into the request body.
-  This annotation allows you to define this parameter with the RAML definition
-  and place the parameter in the right request.
-  ## Annotation Target
-  The [annotation target](https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#annotation-targets)
-  for those annotations is `SecuritySchemeSettings`.
-  You can only apply it to Security Scheme `settings` property.
-  ## Example
-  ```yaml
-  annotationTypes:
-    customSettings: !include oauth-2-custom-settings.raml
-  securitySchemes:
-    oauth2:
-      type: OAuth 2.0
-      describedBy:
-        headers:
-          Authorization:
-            example: "Bearer token"
-      settings:
-        (customSettings):
-          authorizationGrants: [custom_grant]
-          ignoreDefaultGrants:
-          authorizationSettings:
-            queryParameters:
-              resource:
-                type: string
-                required: true
-                description: |
-                  A resource ID that defines a domain of authorization.
-            headers:
-              x-auth-resource:
-                type: string
-                required: false
-          accessTokenSettings:
-            body:
-              resource:
-                type: string
-                required: true
-                description: |
-                  A resource ID that defines a domain of authorization.
-        accessTokenUri: https://auth.domain.com/authorize
-        authorizationUri: https://auth.domain.com/token
-        authorizationGrants: [implicit]
-        scopes: profile
-  ```
-  ## API console
-  This annotation is recognized and respected by API console.
-allowedTargets: [ SecuritySchemeSettings ]
-properties:
-  authorizationSettings:
-    description: |
-      Settings to be applied to the `authorizationUri` GET request.
-      Define any query parameters or headers that are required by your OAuth 2.0
-      authorization server implementation.
-      This settings can be applied only to `token` and `code` requests
-    type: object
-    displayName: Authorization settings
-    required: false
-    properties:
-      queryParameters:
-        displayName: Authorization query parameters
-        description: |
-          Query parameters to be applied to the `authorizationUri`.
-          Use the same notation as RAML's `queryParameters`.
-          If you define a parameter that is already defined in OAuth 2.0 specification
-          (RFC6749) it should be ignored by the processor.
-        type: object
-        required: false
-        properties:
-          /a-zA-Z0-9\-\_/*:
-            type: object
-            required: false
-  accessTokenSettings:
-    displayName: Access token settings
-    description: |
-      Settings to be applied to the token endpoint POST request.
-      Define query parameters, headers or custom body paramaeters that should
-      be included into the request.
-      Note, as per RFC6749, the request content type is `application/x-www-form-urlencoded`
-      and the processor has to always assume this content type.
-    type: object
-    required: false
-    properties:
-      queryParameters:
-        displayName: Token query parameters
-        description: |
-          Query parameters to be applied to the `accessTokenUri`.
-          Use the same notation as RAML's `queryParameters`.
-          OAuth 2.0 specification does not specify any query parameters for this
-          type of request.
-        type: object
-        required: false
-        properties:
-          /a-zA-Z0-9\-\_/*:
-            type: object
-            required: false
-      headers:
-        displayName: Token request headers
-        description: |
-          Headers to be set on the token request.
-          Use the same notation as RAML's `headers`.
-        type: object
-        required: false
-        properties:
-          /a-zA-Z0-9\-\_/*:
-            type: object
-            required: false
-      body:
-        displayName: Token body parameters
-        description: |
-          Body parameters to be applied to the `accessTokenUri`.
-          Properties will be applied to the default set of OAuth 2.0 token request
-          parameters.
-          If you define a parameter that is already defined in OAuth 2.0 specification
-          (RFC6749) it should be ignored by the processor.
-        type: object
-        required: false
-  authorizationGrants:
-    type: string[]
-    displayName: Custom authorization grants
-    required: false
-    description: |
-      List of custom authorization granst supported by your OAuth 2.0 server
-  ignoreDefaultGrants:
-    type: nil
-    required: false
-    description: |
-      If set, the processor should not use any of the `authorizationGrants`
-      properties defined in the `settings` and should be replaced by
-      `authorizationGrants` defined in this annotation.
-      This can be used only if this annotation `authorizationGrants` is set.

package/demo/apis/demo-api/securitySchemes/oauth2-header-delivery.raml

@@ -1,13 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 2.0
-displayName: Token delivery described as query parameter only
-settings:
-  accessTokenUri: https://token.com
-  authorizationUri: https://auth.com
-  authorizationGrants: authorization_code
-  scopes: [profile, email]
-describedBy:
-  headers:
-    token:
-      type: string
-      description: Apply access token here.

package/demo/apis/demo-api/securitySchemes/oauth2-no-delivery.raml

@@ -1,8 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 2.0
-displayName: Token delivery described as query parameter only
-settings:
-  accessTokenUri: https://token.com
-  authorizationUri: https://auth.com
-  authorizationGrants: authorization_code
-  scopes: [profile, email]

package/demo/apis/demo-api/securitySchemes/oauth2-no-grants.raml

@@ -1,12 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 2.0
-displayName: This OAuth2 has no auth grants!
-settings:
-  accessTokenUri: https://token.com
-  authorizationUri: https://auth.com
-  scopes: [profile, email]
-describedBy:
-  queryParameters:
-    access_token:
-      type: string
-      description: Apply access token here.

package/demo/apis/demo-api/securitySchemes/oauth2-pkce.raml

@@ -1,13 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 2.0
-displayName: This OAuth2 has PKCE annotation
-settings:
-  (pkce): true
-  accessTokenUri: https://token.com
-  authorizationUri: https://auth.com
-  scopes: [profile, email]
-describedBy:
-  queryParameters:
-    access_token:
-      type: string
-      description: Apply access token here.

package/demo/apis/demo-api/securitySchemes/oauth2-query-delivery.raml

@@ -1,13 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 2.0
-displayName: Token delivery described as query parameter only
-settings:
-  accessTokenUri: https://token.com
-  authorizationUri: https://auth.com
-  authorizationGrants: authorization_code
-  scopes: [profile, email]
-describedBy:
-  queryParameters:
-    access_token:
-      type: string
-      description: Apply access token here.

package/demo/apis/demo-api/securitySchemes/oauth_1_0.raml

@@ -1,8 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 1.0
-description: OAuth 1.0 continues to be supported for all API requests, but OAuth 2.0 is now preferred.
-settings:
-  requestTokenUri: http://api.domain.com/oauth1/request_token
-  authorizationUri: http://api.domain.com/oauth1/authorize
-  tokenCredentialsUri: http://api.domain.com/oauth1/access_token
-  signatures: [RSA-SHA1, HMAC-SHA1]

package/demo/apis/demo-api/securitySchemes/oauth_1_0_no-settings.raml

@@ -1,3 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 1.0
-description: This has no settings.

package/demo/apis/demo-api/securitySchemes/oauth_1_0_no-signature.raml

@@ -1,7 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 1.0
-description: OAuth 1.0 continues to be supported for all API requests, but OAuth 2.0 is now preferred.
-settings:
-  requestTokenUri: http://api.domain.com/oauth1/request_token
-  authorizationUri: http://api.domain.com/oauth1/authorize
-  tokenCredentialsUri: http://api.domain.com/oauth1/access_token

package/demo/apis/demo-api/securitySchemes/oauth_1_0_signature.raml

@@ -1,8 +0,0 @@
-#%RAML 1.0 SecurityScheme
-type: OAuth 1.0
-description: OAuth 1.0 continues to be supported for all API requests, but OAuth 2.0 is now preferred.
-settings:
-  requestTokenUri: http://api.domain.com/oauth1/request_token
-  authorizationUri: http://api.domain.com/oauth1/authorize
-  tokenCredentialsUri: http://api.domain.com/oauth1/access_token
-  signatures: [RSA-SHA1]

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

@@ -1,29 +0,0 @@
-#%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/demo/apis/demo-api/securitySchemes/passthrough-querystring.raml

@@ -1,16 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  This API supports Pass Through Authentication.
-type: Pass Through
-describedBy:
-  queryString:
-    type: object
-    properties:
-      queryStringProperty1:
-        type: number
-        required: true
-      queryStringProperty2:
-        description: Random string
-        type: string
-        required: false

package/demo/apis/demo-api/securitySchemes/passthrough.raml

@@ -1,24 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  This API supports Pass Through Authentication.
-type: Pass Through
-describedBy:
-  queryParameters:
-    query:
-      type: string
-      example: my-value
-      description: |
-        This demonstrates how Pass Through authentication
-        works with `api-authorization-method` component.
-    debugTokenParam:
-      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
-  headers:
-    api_key:
-      type: string
-      pattern: "[0-9a-zA-Z\\.-]+"
-      description: |
-        This headers has pattern included in the definition.

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

@@ -1,33 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  A custom security scheme for authenticating requests.
-  It allows to set `SpecialToken` header from the authorization panel.
-  The same header should be rendered in the headers editor with console using
-  RAML JS parser.
-  With `AMF` console this is separated information.
-  This scheme also sets `debugToken` and `booleanToken` query parameters.
-  Both are enums, however `booleanToken` can only have `true` and `false`
-  values.
-type: x-my-custom
-describedBy:
-  headers:
-    SpecialTokenHeader:
-      description: |
-        Used to send a custom token.
-      type: string
-  queryParameters:
-    debugTokenParam:
-      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
-    booleanTokenParam:
-      description: Just to test boolean values.
-      type: boolean
-      default: true
-  responses:
-    401:
-      description: |
-        Bad token.
-    403:

package/demo/apis/demo-api/securitySchemes/x-other.raml

@@ -1,29 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  Other custom security method for authorization.
-type: x-custom
-describedBy:
-  queryParameters:
-    apiUserIdParam:
-      description: |
-        Your api user ID. Some imaginary value.
-      type: number
-      required: true
-    apiNonceParam:
-      description: Random string
-      type: string
-  responses:
-    401:
-      description: |
-        Bad token autorization.
-      body:
-        application/json:
-          type: object
-          properties:
-            error:
-              type: boolean
-              description: Always true. Indicates that the response is errord.
-            message:
-              type: string
-              description: Human readable message describing the error.

package/demo/apis/demo-api/securitySchemes/x-query-string.raml

@@ -1,16 +0,0 @@
-#%RAML 1.0 SecurityScheme
-
-description: |
-  Tests for queryString RAML's property
-type: x-custom
-describedBy:
-  queryString:
-    type: object
-    properties:
-      queryStringProperty1:
-        type: number
-        required: true
-      queryStringProperty2:
-        description: Random string
-        type: string
-        required: false

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

@@ -1,23 +0,0 @@
-#%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/demo/apis/demo-api/traits/pagination.raml

@@ -1,83 +0,0 @@
-#%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/demo/apis/demo-api/traits/rate-limited.raml

@@ -1,9 +0,0 @@
-#%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

package/demo/apis/demo-api/types/DemoPerson.raml

@@ -1,67 +0,0 @@
-#%RAML 1.0 DataType
-
-displayName: Person
-description: |
-  A person but without examples defined inline.
-
-type: object
-
-properties:
-  id:
-    xml:
-      attribute: true
-    description: A unique identifier for a person. It is a 32 bit string containing alphanumeric characters.
-    type: string
-    example: ad3fd6d4-af89-11eb-8529-0242ac130003
-  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 ]+"
-    xml:
-      attribute: true
-      name: fullname
-  birthday:
-    type: date-only
-    description: The person's date of birth, represented as YYYY-MM-DD.
-    examples:
-      Example 1: 1983-10-20
-      Example 2: 1994-08-29
-  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.
-    example: male
-  url:
-    type: string
-    description: The URL of this person's profile.
-  image: 
-    type: !include ../resourceTypes/image.raml
-    xml:
-      wrapped: true
-  tagline:
-    type: string
-    description: The brief description (tagline) of this person.
-  language:
-    type: string
-    description: The user's preferred language for rendering.
-    example: "Polish"
-  tags:
-    description: Tags added to the person.
-    type: array
-    items: 
-      properties:
-        name: 
-          type: string
-          description: The name of the tag
-          example: Manager
-        id:
-          type: string
-          description: Tag's identifier.
-          example: ad3fda8a-af89-11eb-8529-0242ac130003
-      xml:
-        wrapped: false

package/demo/apis/demo-document/demo-document.raml

@@ -1,21 +0,0 @@
-#%RAML 1.0 DocumentationItem
-title: About
-content: |
-  This is test document.
-
-  ## Example
-  Let's say you want to generate a random number in the request. So the property
-  value like:
-  ```
-  http://www.domain.com/?time=${now}
-  ```
-  can produce:
-  ```
-  http://www.domain.com/?time=12312312312
-  ```
-  ## Build-in magic variables.
-  | Variable | Description | Example |
-  | --- | --- | --- |
-  | `${random}` | Will generate random number in range from 0 to Number.MAX_SAFE_INTEGER | 9007199254740991 |
-  | `${random:NUMBER}` | A variation of `${random}` where the result will be remembered and can be used in other property. If the same `NUMBER` occurs again then previously generated value will be used. | 7199254740 |
-  | `${now}` | Inserts current epoch time | 12312312312 |