/* tslint:disable */
/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */

/**
 * Metadata describing a signature commons resource
 */
export type LandingUi = {
  /**
   * URI to schema or module for validation of this instance
   */
  $validator: string;
  [k: string]: any;
} & {
  /**
   * favicon props
   */
  favicon?: {
    /**
     * The src of the image
     */
    src: string;
    /**
     * The alt string of the image
     */
    alt: string;
    /**
     * The title to use with the favicon
     */
    title: string;
    [k: string]: any;
  };
  /**
   * favicon props
   */
  header_info?: {
    /**
     * text to display on the left of the header image
     */
    header_left?: string;
    /**
     * text to display on the right of the header image
     */
    header_right?: string;
    /**
     * icon props
     */
    icon?: {
      /**
       * The src of the image
       */
      src: string;
      /**
       * The alt string of the image
       */
      alt: string;
      /**
       * style props
       */
      style?: {
        [k: string]: any;
      };
      [k: string]: any;
    };
    /**
     * props to pass to the menu
     */
    menu_props?: {
      [k: string]: any;
    };
    [k: string]: any;
  };
  /**
   * props to pass for the background
   */
  background_props?: {
    [k: string]: any;
  };
  /**
   * Props for navigation
   */
  nav?: {
    /**
     * Props for metadata search
     */
    MetadataSearch?: {
      /**
       * Tells if the endpoint is active
       */
      active?: boolean;
      /**
       * Metadata search endpoint (/ prefix)
       */
      endpoint?: string;
      /**
       * Metadata search text
       */
      navName?: string;
      /**
       * props to pass to metadata search
       */
      props?: {
        /**
         * models to use for searching
         */
        models_tabs?: ("resources" | "libraries" | "signatures" | "entities")[];
        /**
         * model to start searching on
         */
        entry_model?: "resources" | "libraries" | "signatures" | "entities";
        /**
         * placeholder for the search box
         */
        placeholder?: string;
        /**
         * Sample searches
         */
        examples?: {
          /**
           * Example for each model
           *
           * This interface was referenced by `undefined`'s JSON-Schema definition
           * via the `patternProperty` ".*".
           */
          [k: string]: string[];
        };
        [k: string]: any;
      };
      [k: string]: any;
    };
    /**
     * Props for Signature search
     */
    SignatureSearch?: {
      /**
       * Tells if the endpoint is active
       */
      active?: boolean;
      /**
       * Signature search endpoint (/ prefix)
       */
      endpoint?: string;
      /**
       * Signature search text
       */
      navName?: string;
      /**
       * props to pass to Signature search
       */
      props?: {
        /**
         * sigsearch types
         */
        types?: {
          /**
           * Overlap Props
           */
          Overlap?: {
            /**
             * Make the overlap search active
             */
            active?: boolean;
            /**
             * Placeholder of the up textbox
             */
            up_placeholder?: string;
            /**
             * Placeholder of the down textbox
             */
            down_placeholder?: string;
            /**
             * Name of the switch button
             */
            switch?: string;
            /**
             * list of examples
             */
            examples?: {
              /**
               * label of the example
               */
              label?: string;
              /**
               * external link for the example
               */
              link?: string;
              /**
               * sample input
               */
              input?: {
                /**
                 * newline separated entities
                 */
                up_entities?: string;
                /**
                 * newline separated entities
                 */
                down_entities?: string;
                [k: string]: any;
              };
              [k: string]: any;
            }[];
            [k: string]: any;
          };
          /**
           * Overlap Props
           */
          Rank?: {
            /**
             * Make the overlap search active
             */
            active?: boolean;
            /**
             * Placeholder of the textbox
             */
            placeholder?: string;
            /**
             * Name of the switch button
             */
            switch?: string;
            /**
             * list of examples
             */
            examples?: {
              /**
               * label of the example
               */
              label?: string;
              /**
               * external link for the example
               */
              link?: string;
              /**
               * sample input
               */
              input?: {
                /**
                 * newline separated entities
                 */
                entities?: string;
                [k: string]: any;
              };
              [k: string]: any;
            }[];
            [k: string]: any;
          };
          [k: string]: any;
        };
        [k: string]: any;
      };
      [k: string]: any;
    };
    /**
     * Props for Resources
     */
    Resources?: {
      /**
       * Tells if the endpoint is active
       */
      active?: boolean;
      /**
       * Resources endpoint (/ prefix)
       */
      endpoint?: string;
      /**
       * Resources text
       */
      navName?: string;
      [k: string]: any;
    };
    /**
     * Props for API
     */
    API?: {
      /**
       * Tells if the endpoint is active
       */
      active?: boolean;
      /**
       * API endpoint (/ prefix)
       */
      endpoint?: string;
      /**
       * API text
       */
      navName?: string;
      [k: string]: any;
    };
    [k: string]: any;
  };
  /**
   * Extra navigation props
   */
  extraNav?: (
    | {
        /**
         * type of navigation
         */
        type: "external";
        /**
         * endpoint to point to
         */
        endpoint: string;
        /**
         * name of the tab
         */
        navName: string;
        [k: string]: any;
      }
    | {
        /**
         * type of navigation
         */
        type: "markdown";
        /**
         * src to use for the markdown
         */
        src: string;
        /**
         * name of the tab
         */
        navName: string;
        [k: string]: any;
      }
    | {
        /**
         * type of navigation
         */
        type: "iframe";
        /**
         * name of the tab
         */
        navName: string;
        /**
         * iframes to use
         */
        iframe: {
          /**
           * iframe props
           *
           * This interface was referenced by `undefined`'s JSON-Schema definition
           * via the `patternProperty` ".*".
           */
          [k: string]: {
            /**
             * src of the iframe
             */
            src?: string;
            /**
             * id of the iframe
             */
            id?: string;
            /**
             * name of the iframe
             */
            name?: string;
            /**
             * frame border
             */
            frameBorder?: number;
            /**
             * height
             */
            height?: number;
            [k: string]: any;
          };
        };
        [k: string]: any;
      })[];
  /**
   * preferred name for the models
   */
  preferred_name?: {
    /**
     * preferred name for resources
     */
    resources?: string;
    /**
     * preferred name for libraries
     */
    libraries?: string;
    /**
     * preferred name for signatures
     */
    signatures?: string;
    /**
     * preferred name for entities
     */
    entities?: string;
    [k: string]: any;
  };
  /**
   * preferred name for the models
   */
  preferred_name_singular?: {
    /**
     * preferred name for resources
     */
    resources?: string;
    /**
     * preferred name for libraries
     */
    libraries?: string;
    /**
     * preferred name for signatures
     */
    signatures?: string;
    /**
     * preferred name for entities
     */
    entities?: string;
    [k: string]: any;
  };
  /**
   * links to put in footer
   */
  footer_links?: {
    /**
     * src to use for the image
     */
    src?: string;
    /**
     * alt to use for the image
     */
    alt?: string;
    /**
     * external link
     */
    href?: string;
    [k: string]: any;
  }[];
  /**
   * Material UI theme changes https://material-ui.com/customization/default-theme/#default-theme
   */
  theme_mod?: {
    [k: string]: any;
  };
  /**
   * link to use for github
   */
  github?: string;
  /**
   * link to use for github issues
   */
  github_issues?: string;
  /**
   * Modifies the ordering of the resource
   */
  resource_order?: {
    /**
     * iframe props
     *
     * This interface was referenced by `undefined`'s JSON-Schema definition
     * via the `patternProperty` ".*".
     */
    [k: string]: {
      /**
       * label
       */
      label?: string;
      /**
       * priority
       */
      priority?: number;
      [k: string]: any;
    };
  };
  /**
   * link to about markdown
   */
  about?: string;
  /**
   * link to terms markdown
   */
  terms?: string;
  [k: string]: any;
};