apicollective/ui

UI for https://www.apibuilder.io

ui's Issues

Make sidebar header sticky on scroll

JsonDoc has trailing commas

Add request body documentation for PUT and POST endpoints

Fade long sidebar items if they are too long

Add description + card layout + styles for Org/App

• Create new component that has title + description of Org/App

Hover is broken

When hovering over a field within a resource, hover doesn't show over the resource properly

Revert blue h1 background to white

The descriptions will have markdown and code in them, so we should revert this to standard.

Consumption of markdown

Links of help:

• Markdown parser - supports Github flavour
• Injecting raw HTML in React

When on a model page the top nav should have the Model name displayed

Handle spec imports

JsonDoc should display arrays with [ ]

Types of Fields in ParameterList's should be clickable to Model Page

Tests

Put back pretty icons

Put back the icons in the side bar.

Scroll down to active sidebar item on location change

Description of body in resources for arrays doesn't display.

Link to original api.json and service.json

It would be nice to have a link to the original json and service json file.

When navigating to a new app, the old app is (spec) is displayed for a bit

Detect when changing app - display a spinner and fade in new app

Add `... / GET /url/:param` to NavBar

When on an operation page the Top Nav should have the Operation displayed

Support generic documentation

We should add support for organisation level documentation which is markdown. A json file will be reading containing:

[{org:"movio.cinema", name: "High level doc", link: "link to github file (markdown)"}]

Or something similar, this would be rendered on the sidebar in a Organization and the git repos would be pulled down manually.

Some of the Movio operations don't work

http://localhost:8080/org/movio.cinema/app/cinema-core/r/Cinema/m/post/p/v2tenantcinema

All descriptions should support markdown formatting

• Org
• App
• Resource
• Model
• Fields

Lists of operations on the application intro page should be clickable

When on a resource or model page the side nav should have current page highlighted

JsonDoc when a field doesn't have a description - clear documentation

JsonDoc should have good defaults

Use default value
or example
or name of field
or 123
or first value in enum

Change all box line widths to 2px

Hosting non-locally

Fix Navbar link staying highlighted after mouseout

JsonDoc Enum hover is not working

Improve loading page

ApplicationHome changes

• Add descriptions to ResourceCards

Add Enum support to Models Page

Currently model details only support 'Model' not 'Enum'

Top nav should have white "/" and should align with new design

Add Model to Field description in JsonDoc

Implement documentation section for headers

An api.json can specify the required and optional headers used by that service.

Sort out imports navigation

Should we navigate to the actual import spec? APIDoc does currently.

• Imports clutter the sidebar if there's a lot.
• Do we need a link on an imported model page to take you to the actual spec?

Clicking on a resource that has been exported from another application doesn't work

When clicking on a field within a resource that has been exported by another application, there is an error and the app becomes unresponsive.

(index):37 Uncaught TypeError: Cannot read property 'name' of undefined

Resource Content changes

• Remove Application name/description from all resource content pages.
• Replace with Resource Card for specific operation

Remove coloured boxes from Sidebar

• Resource methods
• Model/Enum identifiers

Change hover colour of Navbar links to be darker

Request/Response types should be clickable

if a request/response returns a model/enum you should be able to click it.

Higher level documentation

• Documentation Link
• Make sure links conform to new app

Description in resources should go underneath JsonDoc

The body parameter in resources should have the description underneath the JsonDoc

Remove descriptions from the Org's page

Org's can't have descriptions

Can't link directly to operations

http://localhost:8080/org/movio.cinema/app/cinema-core/r/HealthCheck/m/get/p/_internal_healthCheck

SideBar changes

Fade in/out loading page

Model / Enum pages should state if they are enums or models (possibly with visual + color)

When backends fail handle errors properly