wso2 / wso2/api-platform

[Bug]: Bottom-Up API Deployment Guide - Updated Status

Open Beginner friendly
#2,002 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area/Management Aspect/API Severity/Minor Type/Bug
Dominant language
Go
Stars
71
Forks
111
Avg merge
1d 14h
Merged PRs (30d)
110

Description

Please select the area the issue is related to

Area/Management (Management API or Management Portal UI)

Please select the aspect the issue is related to

Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)

Description

In the Bottom-Up API Deployment Guide [1] , to check the status it is mentioned as below,

Check Updated Status:

curl -X GET http://localhost:9090/rest-apis/PetStoreAPI \
  -H "Authorization: Basic YWRtaW46YWRtaW4=" | jq '{cpSyncStatus, policies}'

but that gives below response

{
  "origin": null,
  "cpSyncStatus": null
}

Although it was deployed successfully.

[1] - https://github.com/wso2/api-platform/blob/main/docs/gateway/bottom-up-api-deployment-guide.md

Steps to Reproduce

See above

Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)

No response

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 docs/gateway/bottom-up-api-deployment-guide.md and review the status-check example for the PetStoreAPI deployment. Reproduce the documented curl request and compare its response with the guide's expected status, then update the guide so the status check reflects a successful deployment.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.