| Jira Legacy | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
You can add examples to parameters, properties and objects to make OpenAPI specification of your web service clearer. Examples can be read by tools and libraries that process your API in some way. To specify an example, you use the example or examples keys.
Request and Response Body Examples
Here is an example in a request body:
requestBody:
required: true
content:
application/json:
schema:
type: string
examples:
dataSample:
value:
test:bookstore:
bookstore-name: Chapters
categories:
- code: 01
name: SciFi
- code: 02
name: kids
All request and response body examples in CPS will be added at the object level.
...
components:
examples:
dataSample:
value:
test:bookstore:
bookstore-name: Chapters
categories:
- code: 01
name: SciFi
- code: 02
name: kids
summary: A sample data
Sample
...
response
...
using
...
examples
...
defined
...
in
...
components:
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
example:
$ref: 'components.yml#/components/examples/dataSample'
Sample
...
request
...
using
...
examples
...
defined
...
in
...
components:
requestBody:
required: true
content:
application/json:
schema:
type: string
examples:
dataSample:
$ref: 'components.yml#/components/examples/dataSample'
Schema Type for Request and Response
At present most of the requests are defined as schema type String for Request body json. These could be updated to object type. This will introduce below changes:
| S. No | Summary | Current code | Expected code |
|---|---|---|---|
| 1 | Changing the schema type in openapi. | content: | content: |
| 2 | Changes in Controller Changing the datatype to Object | public ResponseEntity<String> createNode | public ResponseEntity<String> createNode |
| Converting jsonData to String while passing the data to service layer | cpsDataService.saveData(dataspaceName, anchorName, jsonData, | cpsDataService.saveData(dataspaceName, anchorName, jsonData.toString(), |
Note: These changes will introduce no changes at the client side. All users can continue to use the API as as they are using currently. This could be verified by executing the CSIT test of cps and dmi-plugin.