API PUBLISHER - RAML FILE

Root Properties

RAML Root Property Description
title API Name
description API Description
version API Version
baseUri Base URI of your API gateway
(annotations.context) API Context
(annotations.serviceUrl) Service endpoint
(annotations.status) API Status (See API Lifecycle)
(annotations.scopes) Oauth 2.0 scopes.
key is a unique identifier for the scope.
name is displayed on the grant page during the Oauth 2.0 flow
documentation Sections being displayed on the API Documentation
mediaType Media types to use for request and response bodies
uses Imported libraries for use within the API.

Endpoint Properties

RAML Endpoint Property Description
displayName Endpoint name
description Endpoint description
is List of traits to apply to all methods declared for this resource.
is List of traits to apply to all methods declared for this resource.
securedBy Security schemes that apply to all methods declared.
User-restricted: [ sec.oauth_2_0: { scopes: [ "scope_key" ] } ]
Application-restricted: [ sec.x-application ]
Unrestricted: absent
headers Headers required in the request.
responses Information about the expected responses to a request.