SchemaContract value field is not being populated when calling apiSchema.get

[awaldow]

azure-sdk-for-node/lib/services/apimanagement/lib/models/schemaContract.js

Lines 79 to 81 in d662a28

	required: false,
	serializedName: 'properties.document.value',
	type: {

I was attempting to use the apiManagementClient to pull down the schema for one of my APIs and noticed the returned response did not contain the document itself, just the metadata. Upon further investigation, I noticed that deep down in the _get call for apiSchema.js the document is indeed being returned, but after a pass through serialization.js it is being stripped because (I think) the serializedName in the schema contract is not valid. It is looking for properties.document.value but there is just properties.document and properties.document.definition et al once it passes through a JSON.parse here:

azure-sdk-for-node/lib/services/apimanagement/lib/operations/apiSchema.js

Lines 568 to 572 in d662a28

	let parsedResponse = null;
	try {
	parsedResponse = JSON.parse(responseBody);
	result = JSON.parse(responseBody);
	if (parsedResponse !== null && parsedResponse !== undefined) {

[awaldow]

To provide some additional context, the following screenshots tell the story around line 570 of apiSchema.js.

First, the responseBody object as it is before it's been parsed:

Though I could not show the whole thing, if you were to look through the document object further you would see nothing beyond the definitions child.

Then, the parsedResponse at line 570 looks as follows:

documents contains no value object.

And then, the result object being returned on line 574 after deserializing:

The document object has disappeared in its entirety. I had entertained the notion that maybe a .value at the end of a serializedName just meant "give me this object" but I see nothing in serialization.js to support that assertion. I should also note that apiSchema.listByApi suffers from this issue as well.

[awaldow]

So just to test, I went into my node_modules and removed the '.value' part of the serializedName so it was just 'properties.document'. I was then able to get a json reconstruction of the definitions of the schema. I am wondering how to get the YAML definition in its entirety but sending Content-Type 'application/vnd.oai.openapi' doesn't seem to change anything, I always just get the definitions, but that's a separate issue from this, though I would like some answer as to how one would get that.

[awaldow]

Is there a better place to raise this issue? It seems like the return content type is going to dictate whether you have this issue or not and with no mechanism to change that to get around it my project is essentially on hold.

[amarzavery]

@solankisamir from the api management team can help you in this issue.

[solankisamir]

yes.. this is an issue in the Contract. The schema document should just be properties.document

We also support Wsdl (SOAP) based APIs. For those apis the schema document is accessible at properties.document.value

[solankisamir]

@awaldow we are working on fixing it, give it a week to reach to all clients.

[awaldow]

Thanks guys, this will help me a ton

[solankisamir]

Try this package https://www.npmjs.com/package/azure-arm-apimanagement/v/5.1.0

The properties.Document is now a JObject and you should be able to retrieve it.
https://docs.microsoft.com/en-us/rest/api/apimanagement/apischema/createorupdate#schemacontract