Skip to content

docs: Add api docs for create and update course#63

Open
dhaanesh-stack wants to merge 2 commits intomasterfrom
course_create_api
Open

docs: Add api docs for create and update course#63
dhaanesh-stack wants to merge 2 commits intomasterfrom
course_create_api

Conversation

@dhaanesh-stack
Copy link

@dhaanesh-stack dhaanesh-stack commented Feb 27, 2026

  • Added Course create and update API endpoints documentation
  • Included detailed request parameters, authentication requirements, and sample JSON responses.

Basecamp link:

@gemini-code-assist
Copy link

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the API documentation for course management by introducing comprehensive guides for creating and updating courses. This improves clarity for developers integrating with these endpoints, ensuring they have all necessary information regarding request structures, authentication, and expected responses.

Highlights

  • API Documentation Added: Documentation for the POST /api/v2.5/admin/courses/create/ endpoint has been added, detailing request parameters, authentication, and a sample 201 Created response.
  • API Documentation Updated: Documentation for the PATCH /api/v2.5/admin/courses/:id/update/ endpoint has been added, including query path parameters, authentication, body parameters (all optional), and a sample 200 OK response.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • docs/server-api/admin-apis/courses.md
    • Added documentation for the 'Create a New Course' API endpoint.
    • Added documentation for the 'Update an Existing Course' API endpoint.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds API documentation for creating and updating courses. The documentation is generally clear and well-structured. I've identified a couple of minor issues related to markdown syntax and consistency that could impact rendering and clarity. My review comments include suggestions to address these points.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant