APapicurio
System

Get UI config

Changed on

Returns the UI configuration properties for this server. The registry UI can be connected to a backend using just a URL. The rest of the UI configuration can then be fetched from the backend using this operation. This allows UI and backend to both be configured in the same place.

This operation may fail for one of the following reasons:

  • A server error occurred (HTTP error 500)
get/system/uiConfig

Request

  • The document declares no server URL.
  • Auth
    none declared

Response

The UI config.

Example response

{
  "ui": {
    "contextPath": "/",
    "navPrefixPath": "/",
    "oaiDocsUrl": "https://registry.apicur.io/docs",
    "editorsUrl": "https://registry.apicur.io/editors"
  },
  "auth": {
    "type": "oidc",
    "rbacEnabled": true,
    "obacEnabled": false,
    "options": {
      "url": "https://auth.apicur.io/realms/apicurio",
      "redirectUri": "http://registry.apicur.io",
      "clientId": "apicurio-registry-ui"
    }
  },
  "features": {
    "readOnly": false,
    "breadcrumbs": true,
    "roleManagement": false,
    "settings": true
  }
}

Changes

  • ff9684af2aadRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

  • f17f5df4e79cRevision changes
    • info

      added the optional property to the response with the status