JSON Schema API (v1)

http://localhost:8081/{version}

Table of contents

JSON Schema API

This documents the API calls that can be made to get JSON Schemas of a module defined by X-Okapi-Module-Id header

/_/jsonSchemas

GET /_/jsonSchemas

Get JSON Schemas for the given module defined by header X-Okapi-Module-Id. Without path query param will return list of JSON Schema paths. With path query param will return the specific JSON Schema with resolvable references.

GET /_/jsonSchemas
Query Parameters
  • path: (string)

    Path to specific JSON Schema

    Example:

    userdata.json

Response 200

JSON Schema

Body

Media type: application/json

Type: any

Example:

[
  "userdataCollection.json",
  "usergroups.json",
  "proxyfor.json",
  "userdata.json",
  "proxyforCollection.json",
  "usergroup.json",
  "addresstype.json",
  "addresstypeCollection.json"
]

Media type: application/schema+json

Type: any

Response 404

JSON Schema with a given path not found

Body

Media type: text/plain

Type: any

Response 500

Internal server error

Body

Media type: text/plain

Type: any

Example:

Internal server error, contact administrator