making the changes

cap-js · Sep 10, 2024 · e473871 · e473871
1 parent 93f3015
commit e473871
Show file tree

Hide file tree

Showing 4 changed files with 3,772 additions and 3,573 deletions.
diff --git a/lib/compile/csdl2openapi.js b/lib/compile/csdl2openapi.js
@@ -1638,19 +1638,33 @@ see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-prot
  if (code != 204) {
  const s = getSchema(type);
  r[code].content = {
- 'application/json': {
- schema: type.$Collection
- ? {
- type: 'object',
- title: 'Collection of ' + nameParts(type.$Type || 'Edm.String').name,
- properties: {
- ...(isCount && CountPropertyObj),
- value: s
- }
- }
- : s
- }
+ 'application/json': {}
  };
+
+ if (type.$Collection) {
+ r[code].content['application/json'].schema = {
+ type: 'object',
+ title: 'Collection of ' + nameParts(type.$Type ? type.$Type : 'Edm.String').name,
+ properties: {
+ ...(isCount && CountPropertyObj),
+ value: s
+ }
+ };
+ }
+
+ else if (
+ type.$Type === undefined ||
+ (type.$Type.startsWith("Edm.") &&
+ !["Edm.Stream", "Edm.EntityType", "Edm.ComplexType"].includes(
+ type.$Type,
+ ))
+ ) {
+ r[code].content['application/json'].schema = { type: "object", properties: { value: s } };
+ }
+
+ else {
+ r[code].content['application/json'].schema = s;
+ }
  }
  if (errors) {
  for (const e of errors) {

diff --git a/test/lib/compile/csdl2openapi.test.js b/test/lib/compile/csdl2openapi.test.js
@@ -856,53 +856,123 @@ describe('Edge cases', function () {
  const expected = {
  paths: {
  '/fun()': {
- get: {
- responses: {
- 200: {
- description: 'Success',
- content: {
- 'application/json': {
- schema: {
- type: 'string',
- maxLength: 20
- }
- }
- }
- }
- }
+ "paths": {
+ "/$batch": {
+ "post": {
+ "summary": "Sends a group of requests",
+ "description": "Group multiple requests into a single request payload, see [Batch Requests](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BatchRequests).\n\n*Please note that \"Try it out\" is not supported for this request.*",
+ "tags": [
+ "Batch Requests"
+ ],
+ "requestBody": {
+ "required": true,
+ "description": "Batch request",
+ "content": {
+ "multipart/mixed;boundary=request-separator": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "--request-separator\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nGET undefined HTTP/1.1\nAccept: application/json\n\n\n--request-separator--"
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Batch response",
+ "content": {
+ "multipart/mixed": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "--response-separator\nContent-Type: application/http\n\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{...}\n--response-separator--"
+ }
+ }
+ },
+ "4XX": {
+ "$ref": "#/components/responses/error"
+ }
+ }
+ }
+ },
+ "/fun()": {
+ "get": {
+ "summary": "Invokes function fun",
+ "tags": [
+ "Service Operations"
+ ],
+ "parameters": [],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "string",
+ "maxLength": 20
  }
- },
- "/fun(in={in})": {
- get: {
- responses: {
- 200: {
- description: 'Success',
- content: {
- 'application/json': {
- schema: {
- type: 'object',
- title: 'Collection of String',
- properties: {
- '@odata.count': {
- $ref: '#/components/schemas/count'
- },
- value: {
- type: 'array',
- items: {
- type: 'string',
- maxLength: 20
- }
- }
- }
- }
- }
- }
- }
- }
+ }
+ }
+ }
+ }
+ },
+ "4XX": {
+ "$ref": "#/components/responses/error"
+ }
+ }
+ }
+ },
+ "/fun(in={in})": {
+ "get": {
+ "summary": "Invokes function fun",
+ "tags": [
+ "Service Operations"
+ ],
+ "parameters": [
+ {
+ "required": true,
+ "in": "path",
+ "name": "in",
+ "description": "String value needs to be enclosed in single quotes",
+ "schema": {
+ "type": "string",
+ "pattern": "^'([^']|'')*'$"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Success",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "Collection of String",
+ "properties": {
+ "@odata.count": {
+ "$ref": "#/components/schemas/count"
+ },
+ "value": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 20
+ }
  }
- },
- '/$batch': { post: {} }
+ }
+ }
+ }
  }
+ },
+ "4XX": {
+ "$ref": "#/components/responses/error"
+ }
+ }
+ }
+ }
+ }
  };
  const actual = lib.csdl2openapi(csdl, {odataVersion: '4.0'});
  assert.deepStrictEqual(paths(actual), paths(expected), 'Paths');

diff --git a/test/lib/compile/data/containment.openapi3.json b/test/lib/compile/data/containment.openapi3.json
@@ -2567,9 +2567,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -2614,9 +2619,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -3080,9 +3090,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -3127,9 +3142,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -4351,9 +4371,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -4419,9 +4444,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -4948,9 +4978,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -5016,9 +5051,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }
@@ -5063,9 +5103,14 @@
  "type": "object",
  "properties": {
  "value": {
- "type": "integer",
- "format": "int32",
- "nullable": true
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "integer",
+ "format": "int32",
+ "nullable": true
+ }
+ }
  }
  }
  }