Overview

The above image shows the Admin interface for Restspace. This is a generalised and extensible interface for viewing, editing, uploading and downloading resources to Restspace. You can find the admin site for any Restspace domain at <subdomain>.restspace.io/admin.

The Admin interface is made up of a Service & Resource Navigation panel on the left and on the right forms and editors related to the currently selected resource on the right

Navigation panel

The Navigation panel corresponds to data found in the /services.json file of the Restspace site (see Service configuration), which specifies all the services to run on the site. These services can be configured by editing the JSON shown when you click the Site Bar at the top of the Navigation.

Services which have APIs which the Admin interface knows how to handle will be listed at the top level of the tree hierarchy shown in the Navigation panel (labelled Service).

Expanding a Service will show the resources immediately on the base path of the Service, and subdirectories which can be further expanded. Clicking on a Service will show in the Editor space configuration for that service. E.g. for a JSON data service, this will show the default JSON Schema for the JSON file resources. Similarly clicking on any subdirectory will show the configuration in force for that directory. Sometimes configuration is taken from the nearest parent directory with a configuration file, in which case the configuration file from that directory is shown. In this case a Create Local button allows you to create a new configuration file in the local directory which then supercedes the one in the parent directory. See documentation for the relevant service to find out what configuration is shown.

Every folder has a '+' button, which adds a new resource, and a folder '+' button, which creates a subdirectory in the current directory. Every resource or subdirectory has a 'x' button which deletes the resource (only visible when hovering or on the selected item). Subdirectories can only be deleted once all their resources have been deleted.

Editor panel

The Resource Editor panel contains one untabbed or multiple tabbed pages for the resource you have selected. This may include code editor, data form, preview and possibly others. Refer to the service in question to see what is shown for each resource.

Notice that the path to the current resource preceded by '/admin' is the path of the admin page where it can be edited. This enables navigation between resources in the editor with browser back/forward and deep linking to Admin pages.

When the resource is a JSON file with a form editor, the name of the resource will be extracted from the fields of the data entered according to the 'pathPattern' top level property of the JSON schema. Otherwise the user enters the resource name in a box at the top of the editor.

The editor will have a SUBMIT button which goes red when a change is made and you will receive a warning if you try and navigate away from a form with unsaved changes.