azurerm_api_management_api fix the bug in example usage

[azarboon]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

The example usage has a bug. I've explained it in detail in the issue #27757. My PR makes the example usage to work seamlessly. I've tested it locally and it worked. The removed section is optional so it can be removed from the example usage. Though, that removed property, probably needs further investigations which can be done separately.

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevent documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Fixes #27757,
Fixes #24379,
Fixes #23130

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

[azarboon]

As I described in the issue, the root cause is invalid url because following worked well. So, we can just change the content_value but I still suggest to remove this block from example usage because the same fate can happen to any new url and confuse the users. This block is just optional and many dont use it at all so it's not worth confusing the rest of users.

  import {
    content_format = "swagger-link-json"
    content_value  = "http://petstore.swagger.io/v2/swagger.json"
  }

[azarboon]

Added following to the doc so readers will be informed about this nuanced error:

The URL must be accessible and return a valid document; otherwise, deployment may fail.

[azarboon]

@stephybun can you please check this PR?

[azarboon]

@stephybun thanks for suggestion. Replaced it with a working link. It should be ready for merge.

[stephybun]

Thanks @azarboon LGTM 👍

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.