Validate RAML and Prepare Payload
post
/mobile/tools/1.0/apis/raml
Validates the RAML descriptor file and prepares the payload for API creation. This operation doesn't create the API.
Request
Supported Media Types
- multipart/form-data
Form Parameters
-
file: file
The RAML descriptor file to upload.
Response
Supported Media Types
- application/json
200 Response
The RAML file was uploaded and validated, and the API metadata preview and validation report were returned.
The API definition representation preview with the RAML descriptor and the RAML-validation result.
Root Schema : apiPreviewRamlValidation
Type:
object
The API definition representation preview with the RAML descriptor and the RAML-validation result.
Match All
Show Source
-
object apiShort
The short API definition representation.
-
object apiPreviewRamlValidation-allOf[1]
Nested Schema : apiShort
Type:
object
The short API definition representation.
Match All
Show Source
-
object assetGet
The asset representation for GET requests.
-
object apiShort-allOf[1]
Nested Schema : apiPreviewRamlValidation-allOf[1]
Type:
Show Source
object
-
ramlValidationReport(optional):
object ramlValidationReport
The result of the RAML validation.
Nested Schema : assetGet
Type:
object
The asset representation for GET requests.
Match All
Show Source
-
object assetUpdate
The asset representation for PUT requests.
-
object assetIdEtag
The asset ID and entity tag (ETag) values.
-
object trash
Indicator of whether the asset is in the trash.
-
object assetGet-allOf[3]
Nested Schema : apiShort-allOf[1]
Type:
Show Source
object
-
basePath(optional):
string
The API base path in the format `/mobile/custom/{apiName}`.
-
hasBusinessObjects(optional):
boolean
Default Value:
false
Indicates whether the API is associated with API Express resources (business objects). -
icon(optional):
object icon
Information about the icon that's associated with the API or connector.
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetIdEtag
Type:
object
The asset ID and entity tag (ETag) values.
Show Source
-
etag(optional):
string
The asset entity tag (ETag) value, which you can use to detect concurrent modification.
-
id:
string
Nested Schema : assetGet-allOf[3]
Type:
Show Source
object
-
createdOn(optional):
string
-
deletedBy(optional):
string
-
deletedOn(optional):
string
-
links(optional):
array entityLinksArray
Minimum Number of Items:
0
An array of links for an entity's metadata. -
modifiedBy(optional):
string
-
modifiedOn(optional):
string
-
published(optional):
boolean
An asset draft or published status representation.
Nested Schema : entityLinksArray
Type:
array
Minimum Number of Items:
0
An array of links for an entity's metadata.
Show Source
-
Array of:
object items
Link to the entity's metadata.
Nested Schema : items
Type:
object
Link to the entity's metadata.
Show Source
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical" ]
Link type.
Nested Schema : icon
Type:
object
Information about the icon that's associated with the API or connector.
Show Source
Nested Schema : ramlValidationReport
Type:
object
The result of the RAML validation.
Show Source
-
valid:
boolean
-
validationResults(optional):
array validationResults
Minimum Number of Items:
0
400 Response
RAML file content is missing.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails(optional):
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.