RAML API (v1)

http://localhost:8081/{version}

Table of contents

RAML API

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

/_/ramls

GET /_/ramls

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

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

    Path to specific RAML

    Example:

    users.raml

Response 200

RAML

Body

Media type: application/json

Type: any

Example:

[
  "proxiesFor.raml",
  "users.raml",
  "addressTypes.raml",
  "groups.raml"
]

Media type: application/raml+yaml

Type: any

Response 404

RAML 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