Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepaid recharge docs #203

Merged
merged 8 commits into from
Oct 23, 2024
Merged

Prepaid recharge docs #203

merged 8 commits into from
Oct 23, 2024

Conversation

Arppp
Copy link
Contributor

@Arppp Arppp commented Oct 22, 2024

Preview docs

@github-actions GitHub Actions
Copy link

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist

Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option

aditya-67
aditya-67 requested changes Oct 23, 2024
View reviewed changes
api-references/payments/prepaid-recharge.json Outdated Show resolved Hide resolved
api-references/payments/prepaid-recharge.json Outdated
}
},
"422": {
"description": "422",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a better description for 422 error

api-references/payments/prepaid-recharge.json Outdated
}
},
"500": {
"description": "500",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a better description for 500

api-references/payments/prepaid-recharge.json Outdated
]
}
},
"/mobile-prepaid-recharge/fetch_plans":{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to above path comment, can this be fetch-plans?

Let's drive consistency with our endpoints

api-references/payments/prepaid-recharge.json Outdated
@@ -0,0 +1,1210 @@
{
"info": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently the base URL is using a default example.com. Can we add a host, scheme etc similar to this?

Screenshot 2024-10-23 at 10 26 24

@aditya-67 aditya-67 merged commit ccedd2c into staging Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aditya-67 aditya-67 aditya-67 requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Arppp @aditya-67