zowe / zowe/api-layer

Improve onboarding of internal APIs

Open
#2,557 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help-wanted Priority: High size/L
Dominant language
Java
Stars
92
Forks
81
Avg merge
1d 9h
Merged PRs (30d)
46

Description

Use Case

As a System Programmer, I want to ensure that all our internal APIs are available via the API Catalog and that we can benefit from the SSO functionalities and the visualization of all the APIs in the same place.

Acceptance Criteria

  • As a System Programmer, I will be able to find in the Catalog a way to onboard my services
  • As a System Programmer, I will be able to recognize the right way to onboard the internal services
  • As a System Programmer, I will be able to understand how I can save the static file

Notes

  • There will be another button specifically for static onboarding
  • The enablers will be renamed to SDK or some other meaningful way
  • The menu with the options in the API Catalog will be more understandable
  • The wizard for static onboarding will be cleansed from the current bugs
  • When I am in the static wizard I will always see the Save button and if I don't have the rights it will tell me what I need to do to get them.

Contributor guide

Open the contributing guide

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

Review the API Catalog onboarding menu and the static onboarding wizard first; the issue names no files or tests. Compare the current flow with the three acceptance criteria, including service onboarding, static-file saving, the persistent Save button, and permission guidance. Done means the onboarding paths are understandable and those criteria are demonstrably satisfied.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.