wso2 / wso2/docs-apim

Suspending endpoint having invalid information- https://apim.docs.wso2.com/en/3.0.0/learn/design-api/endpoints/resiliency/prevent-api-suspension/#prevent-api-suspension

Open
#1,610 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-3.0.0 Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
Greenshot 2020-08-04 17 50 44

Suggested Labels:
Remove or improve following

_Navigate to the <API-M_HOME>/repository/deployment/server/synapse-configs/default/api directory.

Open the configuration file of the API that has to be prevented from being suspended.

(e.g., admin--testApi_v1.0.0.xml)

Add the following configurations._

From publisher point of view the information is irrelevant. Even if someone try to do that API endpoint element change it will get overridden with API republish

Suggested Assignees:

  • Remove "Info" section, with 2.6.0 onwards endpoints saving to xx-endpoint.xml
  • It's not required synapse level configs, but if required re-arrange content under advance section

Affected Product Version:

APIM 2.x.x
APIM 3.x.x

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked “Prevent API Suspension” documentation page and locate the instructions beginning with navigation to the synapse-configs/default/api directory. Compare the current “Info” section with the suggested endpoint-saving behavior from APIM 2.x and 3.x, then update or rearrange the content as appropriate. Done means the page no longer presents irrelevant publisher-facing endpoint configuration steps.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.