wso2 / wso2/docs-apim

GraphQL API creation documentation is outdated

Open
#9,045 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Description

We need to update the GraphQL API creation doc [1] to reflect the changes added via the "GraphQL API creation using introspection and SDL URL" feature. Since the current doc contains outdated content and screenshots, we need to fix those and add new content related to the feature added via 4.5.0.

[1] https://apim.docs.wso2.com/en/4.5.0/design/create-api/create-a-graphql-api/

Steps to Reproduce

Try out GraphQL API creation by following the documentation [1] mentioned above.

Version

4.5.0

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 the linked GraphQL API creation documentation for version 4.5.0 and compare its instructions and screenshots with the introspection and SDL URL feature described in the issue. Update the outdated content and screenshots, add the new feature details, and verify the documented creation steps end to end.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.