Open API to CentraSite REST API Mappings
This section describes how the Open API objects and properties (as described in the Open API specification) are mapped in the CentraSite REST data model. It shows the relationships between the Open API root section, parameters, body fields, and their REST data model. It also lists the relationships between Open API resources, methods, reference documentation, and security schemes, and how these values are mapped in REST API.
Note:
CentraSite supports Open API version 3.0.1.
The following tables list the correspondences (mappings) between the fields of a RESTful API and Open API document.
Open API Root Section Fields
The Root section of the Open API definition describes the basic information of a RESTful API, such as its title, external documents, security schemes and references.
OpenAPI Root Section Field | REST API Field | Notes |
Open API | | Currently, CentraSite does not support mapping the Open API version in the REST API's details page. |
title | Name | The title property is represented by the Name field in the REST API's details page. |
description | Description | The description property is represented by the Description field in the REST API's details page. |
termsOfServiceUrl | | Currently, CentraSite does not support mapping the termsOfServiceUrlat the API level. |
contact | | Currently, CentraSite does not support mapping the contact property at the API level. |
license | | Currently, CentraSite does not support mapping the license property at the API level. |
licenseUrl | | Currently, CentraSite does not support mapping the licenseUrl at the API level. |
externalDocs | | The externalDocs are not explicitly mapped to the REST API; instead, the external documentation is attached as a file attribute to the Specification profile in the REST API details page. |
servers | | The servers property is represented by the Add Endpoint field in theTechnical Details profile. |
server Url | | The Server Url property is represented in the Add Endpoint page in the Technical Details profile. |
server variables | | Server Variables is a field of Server object in OpenAPI specification. |
paths | REST Resource | The paths property is represented by a collection of resources, wherein each of the resources have its path value mapped by the Name field of a REST Resource. |
components | Components | Components property holds a set of reusable objects for different aspects of the OAS. All the objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. CentraSite supports the following components objects at the API level.  SchemasResponses Parameters Examples RequestBodies Headers Links Callbacks Currently, CentraSite does not support mapping the securitySchemes at the API level. |
security | | Currently, CentraSite does not support mapping the security at the API level. However, it is represented by the Supported Access Token Types field in the API Portal Information profile. |
OpenAPI Parameter Fields
The following tables show the mappings between various Open API parameter types and attributes and how they are used by REST API. The mappings are grouped into tables for OpenAPI Parameter Types, and Open API Parameter Attributes.
OpenAPI Parameter Types
OpenAPI Parameter Field | REST API Field | Notes |
in | Parameter of type, Query, Header, Path or Cookie | The in property is represented by the "Query", "Header", "Path" or "Cookie" option in the Parameter Type field of a REST Parameter. Currently, CentraSite does not support mapping parameters of the type "Cookie". |
Open API Parameter Attributes
Open API Attribute Field | REST API Field | Notes |
name | Name | The Display Name property is represented by the Name field of a REST Parameter. |
description | Description | The Description property is represented by the Description field of a REST Parameter. |
in | | The in property is represented by the Parameter Type field of a REST Parameter. |
required | Required | The required property is represented by the Required field of a REST Parameter. |
type type=[string, number, boolean, array, file] | Data Type | The type property is represented by the Data Type field of a REST Parameter. Currently, CentraSite does not support mapping parameters of the data type "file". |
format format=[int32, int64, float, double, byte, date, date-time, email, uuid] | Data Type | The format property is represented by the Data Type field of a REST Parameter. Currently, CentraSite does not support mapping parameters of the data type "file". |
items | Possible Values | The enum property is represented by the Possible Values field of a REST Parameter. Limitation: Currently, CentraSite supports the Possible Values field only for a "string" data type. |
collectionFormat | | Currently, CentraSite does not support the collectionFormat attribute. |
default | Default Value | The default property is represented by the Default Value field of a REST Parameter. |
maximum | | Currently, CentraSite does not support the maximum attribute. |
exclusivemaximum | | Currently, CentraSite does not support the maximum attribute. |
minimum | | Currently, CentraSite does not support the minimum attribute. |
exclusiveminimum | | Currently, CentraSite does not support the minimum attribute. |
minLength | | Currently, CentraSite does not support the minLength attribute. |
maxLength | | Currently, CentraSite does not support the maxLength attribute. |
enum | Possible Values | The enum property is represented by the Possible Values field of a REST Parameter. |
pattern | | Currently, CentraSite does not support the pattern attribute. |
maxItems | | Currently, CentraSite does not support the maxItems attribute. |
minItems | | Currently, CentraSite does not support the minItems attribute. |
uniqueItems | | Currently, CentraSite does not support the uniqueItems attribute. |
multipleOf | | Currently, CentraSite does not support the multipleOf attribute. |
Open API Resource Fields
Open API resource properties (data) are mapped to the REST API resource fields. The following table shows the resource mappings between a Open API definition and a REST API:
Open API Resource Field | REST API Field | Notes |
$ref | | Currently, CentraSite does not support the $ref property. However, the $ref property is represented by mapping the contained REST Resources and attaching the referenced files to the Specification profile in the API details page. |
get, put,post,delete, options,head,patch | REST Method | The get property is represented as the REST Method object. |
parameters | REST Parameter | The parameter property is represented as a REST Parameter object. |
Open API Method Fields
Open API method properties (data) are mapped to the REST API method fields. The following table shows the resource mappings between a Open API definition and a REST API:
Open API Method Field | REST API Field | Notes |
tags | | Currently, CentraSite does not support the tags property. |
summary | Name | The summary property is represented by the Name field of a REST Method. |
description | Description | The description property is represented by the Description field of a REST Method. |
externalDocs | | The externalDocs are not explicitly mapped to the REST API; instead, the external documentation is attached as a file attribute to the Specification profile. |
operationId | | Currently, CentraSite does not support the operationId property. |
security | | Currently, CentraSite does not support mapping the security at the API level. However, it is represented by the Supported Access Token Types field in the API Portal Information profile. |
parameters | Parameter | The parameter property is represented by the Parameter field of a REST Method. |
responses | Status Code | The responses property is represented by the Status Code field of a REST Method. |
requests | Requests | The requests property is represented by the Add Request field of a REST Method. |
callbacks | Callbacks | The callbacks property is represented by the Add Callbacks field of a REST Method. |
server | | Currently, CentraSite does not support mapping the server at the API level. |
deprecated | Deprecated | The deprecated property is propagated to the taxonomy structure named Deprecated and represented by the API Maturity Status property defined in the API Portal Information profile. |
Open API Status Code Fields
Open API status code properties (data) are mapped to the REST API status code fields. The following table shows the resource mappings between a Open API definition and a REST API:
Open API Method Field | REST API Field | Notes |
code | Status Code | The HTTP status code property is represented by the Status Code field of a REST Method. |
description | Description | The description property is represented by the Description field of a REST Method level. |
media type | Schemas, Example and Encoding | Each media typeobject provides schema and examples for the media type identified by its key. CentraSite support Schemas as REST Schema, Example as REST Example, Encoding as REST Encoding. |
headers | | The headers property is supported in CentraSite as REST Parameter with paramtype as header. |
links | | The links property is supported in CentraSite as REST Links. |