UNPKG

generator-anubhav-build-cap

Version:

Anubhav Trainings - Build BPA CAP App

468 lines 12.2 kB
{ "openapi": "3.0.2", "info": { "title": "Use @title: '...' on your CDS service to provide a meaningful title.", "description": "Use @Core.LongDescription: '...' on your CDS service to provide a meaningful description.", "version": "" }, "x-sap-api-type": "ODATAV4", "x-odata-version": "4.01", "x-sap-shortText": "Use @Core.Description: '...' on your CDS service to provide a meaningful short text.", "servers": [ { "url": "/api/v1" } ], "tags": [], "paths": { "/addQuotes(value='{value}')": { "get": { "summary": "addQuotes", "tags": [ "Service Operations" ], "parameters": [ { "required": true, "in": "path", "name": "value", "description": "String value needs to be enclosed in single quotes", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataString" } ], "nullable": true } } } }, "4XX": { "$ref": "#/components/responses/error" } } } }, "/getListOfTodos()": { "get": { "summary": "get list of dodos", "tags": [ "Service Operations" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataListArray" } ], "nullable": true } } } }, "4XX": { "$ref": "#/components/responses/error" } } } }, "/listToString": { "post": { "summary": "listToString", "tags": [ "Service Operations" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataString" } ], "nullable": true } } } }, "4XX": { "$ref": "#/components/responses/error" } }, "requestBody": { "description": "Action parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "responseArray": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataList" } ], "nullable": true } }, "field": { "type": "string", "nullable": true } } } } } } } }, "/toInteger(value='{value}')": { "get": { "summary": "toInteger", "tags": [ "Service Operations" ], "parameters": [ { "required": true, "in": "path", "name": "value", "description": "String value needs to be enclosed in single quotes", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataInteger" } ], "nullable": true } } } }, "4XX": { "$ref": "#/components/responses/error" } } } }, "/toNumber(value='{value}')": { "get": { "summary": "toNumber", "tags": [ "Service Operations" ], "parameters": [ { "required": true, "in": "path", "name": "value", "description": "String value needs to be enclosed in single quotes", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataNumber" } ], "nullable": true } } } }, "4XX": { "$ref": "#/components/responses/error" } } } }, "/toStr(value={value})": { "get": { "summary": "toString", "tags": [ "Service Operations" ], "parameters": [ { "required": true, "in": "path", "name": "value", "schema": { "anyOf": [ { "type": "number", "format": "double,null" }, { "type": "string" } ], "example": 3.14, "nullable": true, "default": "" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataString" } ], "nullable": true } } } }, "4XX": { "$ref": "#/components/responses/error" } } } } }, "components": { "schemas": { "catalogservice.DataInteger": { "title": "DataInteger", "type": "object", "properties": { "value": { "type": "integer", "format": "int32", "nullable": true } } }, "catalogservice.DataList": { "title": "DataList", "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "title": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int32", "nullable": true }, "completed": { "type": "boolean", "nullable": true } } }, "catalogservice.DataListArray": { "title": "DataListArray", "type": "object", "properties": { "responseArray": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/catalogservice.DataList" } ], "nullable": true } } } }, "catalogservice.DataNumber": { "title": "DataNumber", "type": "object", "properties": { "value": { "anyOf": [ { "type": "number", "format": "double" }, { "type": "string" } ], "example": 3.14, "nullable": true } } }, "catalogservice.DataString": { "title": "DataString", "type": "object", "properties": { "value": { "type": "string", "nullable": true } } }, "count": { "anyOf": [ { "type": "number" }, { "type": "string" } ], "description": "The number of entities in the collection. Available when using the [$count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount) query option." }, "error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "target": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "target": { "type": "string" } } } }, "innererror": { "type": "object", "description": "The structure of this object is service-specific" } } } } } }, "parameters": { "top": { "name": "$top", "in": "query", "description": "Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)", "schema": { "type": "integer", "minimum": 0 }, "example": 50 }, "skip": { "name": "$skip", "in": "query", "description": "Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)", "schema": { "type": "integer", "minimum": 0 } }, "count": { "name": "$count", "in": "query", "description": "Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)", "schema": { "type": "boolean" } }, "search": { "name": "$search", "in": "query", "description": "Search items by search phrases, see [Searching](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch)", "schema": { "type": "string" } } }, "responses": { "error": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error" } } } } } } }