wso2 / wso2/docs-apim

Update docs on API key revocation

Open
#4,430 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-3.0.0 API-M-3.1.0 API-M-3.2.0 API-M-4.0.0 API-M-Master help wanted Type/Improvement
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description:
We have a REST API for API key revocation. But it is not coming up when searching the docs as this is available in the REST API section.
https://apim.docs.wso2.com/en/3.0.0/develop/product-apis/devportal-apis/devportal-v1/devportal-v1/#/API%20Keys/post_applications__applicationId__api_keys__keyType__revoke

We can add a section about API key revocation in here https://apim.docs.wso2.com/en/3.0.0/learn/api-security/api-authentication/secure-apis-using-api-keys/#secure-apis-with-api-keys

These changes applies to all the APIM versions which support API key.

Suggested Labels:

Suggested Assignees:

Affected Product Version:

OS, DB, other environment details and versions:

Steps to reproduce:

Related Issues:

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

Start with the secure APIs using API keys documentation section and compare it with the linked REST API reference for the revoke endpoint. Add a searchable API key revocation section across the APIM versions that support API keys, then verify the documentation links and wording are consistent.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.