Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description of the API is not updated when deploying to APIM #29

Open
iabhee opened this issue May 21, 2021 · 1 comment
Open

Description of the API is not updated when deploying to APIM #29

iabhee opened this issue May 21, 2021 · 1 comment

Comments

@iabhee
Copy link

iabhee commented May 21, 2021

version: 0.0.1
apimServiceName: myAPIMService

apis:
    - name: myApi
      type: http
      _**description: myFirstApi**.  --> (not updated when deployed to APIM)_
      serviceUrl: http://myApiBackendUrl.com

noticed in the generated ARM template the way it constructs the "value" under resources it doesn't include the "Description" when passing the whole open API spec and when i manually added the "Description" it worked.

Could you please add this property so that the tool automatically adds it when the ARM template is generated?

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "ApimServiceName": {
      "type": "string",
      "metadata": {
        "description": "Name of the API Management"
      }
    }
  },
  "variables": {},
  "resources": [
    {
      "properties": {
        "value": "{ }", ---> this doesn't have the description property set
        "format": "openapi+json",
        "Description": "myFirstApi",
        "type": "http",
        "apiRevision": "1",
        "isCurrent": true,
        "subscriptionRequired": false,
        "displayName": "myFirstAPI",
        "serviceUrl": "https://myapp-webapp.azurewebsites.net",
        "path": "find"
      },

@iabhee
Copy link
Author

iabhee commented May 21, 2021

Figured out the issue. After adding the "Description" to the swagger OpenApiInfo it was able to pick up however still seeing the same behavior when adding products (product description is not updated)

                swagger.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "myFirstApi",
                    Version = "v1",
                    Description = "myFirstApi"
                });

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant