Skip to content

Update documentation #34

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.

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update documentation #34

wants to merge 4 commits into from

Conversation

KCeh
Copy link
Collaborator

@KCeh KCeh commented Jun 24, 2025

Summary

I update documenation

Changes

  • Changelog updated
  • Dynamic responses mentioned in readme
  • More examples (including Koltin ones - I got comment from someone) in Specification, note that I used AI to generate them so we should double check them

Type

  • Feature: This pull request introduces a new feature.
  • Bug fix: This pull request fixes a bug.
  • Refactor: This pull request refactors existing code.
  • Documentation: This pull request updates documentation.
  • Other: This pull request makes other changes.

Additional information

  • This pull request introduces a breaking change.

Description

Checklist

  • I have performed a self-review of my own code.
  • I have tested my changes, including edge cases.
  • I have added necessary tests for the changes introduced (if applicable).
  • I have updated the documentation to reflect my changes (if applicable).

Additional notes

@KCeh KCeh requested review from antunflas, thisAAY and Copilot June 24, 2025 12:41
@KCeh KCeh added the enhancement New feature or request label Jun 24, 2025
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances project documentation by updating the changelog, adding mentions of dynamic responses in the README, and expanding the SPECIFICATION with more Java and Kotlin examples (including a new MockResponseProvider section).

  • Updated CHANGELOG.md to Version 1.2.1
  • Added a note about dynamic responses in README.md
  • Expanded SPECIFICATION.md with Java/Kotlin examples and a new @MockResponseProvider section

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
SPECIFICATION.md Added Kotlin examples across annotations and new provider section; expanded body-factory usage docs
README.md Noted Kotlin examples in the full specification and introduced dynamic responses snippet
CHANGELOG.md Bumped version to 1.2.1 and added a dependency conflict fix entry
Comments suppressed due to low confidence (1)

SPECIFICATION.md:140

  • This snippet is under the Java example block but shows Kotlin syntax (suspend fun). Either change the fence language to kotlin and add a Kotlin heading, or restore the Java signature here.
  suspend fun getResponseBody(): ResponseBody?

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant