wso2 / wso2/docs-apim

[APIM 3.0.0][Devporta][v1]Mandatory field is not mentioned

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

Nobody has claimed this yet.

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

Description

Description:
In APIM 3.0.0, when subscribing through the REST API v1 POST /subscription, the API Type is mandatory
https://github.com/wso2/carbon-apimgt/blob/v6.5.349/components/apimgt/org.wso2.carbon.apimgt.rest.api.store.v1/src/main/java/org/wso2/carbon/apimgt/rest/api/store/v1/impl/SubscriptionsApiServiceImpl.java#L186-L191

But in the documentation, it has not been mentioned as a mandatory field.

Check the model in the relevant resource

https://apim.docs.wso2.com/en/3.0.0/develop/product-apis/devportal-apis/devportal-v1/devportal-v1/#/Subscriptions/post_subscriptions

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

Compare the Subscriptions POST model on the linked DevPortal v1 documentation page with the API Type validation in SubscriptionsApiServiceImpl.java at lines 186-191. Update the relevant documentation so API Type is identified as mandatory, then verify the rendered endpoint model reflects that requirement.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.