Skip to content

docs(api): align /calls with OpenAPI - #63

Merged
YadingFang merged 1 commit into
mainfrom
docs/add-422-errors-and-cloudevents-example
Dec 19, 2025
Merged

YadingFang merged 1 commit into
mainfrom
docs/add-422-errors-and-cloudevents-example

Conversation

@YadingFang

Copy link
Copy Markdown
Contributor

What type of PR is this?

Add one of the following kinds:

  • documentation

What this PR does / why we need it:

This PR improves and aligns the /calls documentation with the current ClickToDial API behavior and CAMARA expectations by:

Adding a CloudEvents payload example to illustrate call status change notifications.

Documenting 422 business error responses and their codes for common validation/eligibility cases.

Adding a call-flow diagram to clarify the expected call session lifecycle and notification flow.

These updates make the specification easier to understand and validate, and provide clearer guidance for implementers and testers.

@github-actions

Copy link
Copy Markdown

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.01s
✅ API spectral 1 0 1.9s
✅ GHERKIN gherkin-lint 3 0 1.24s
✅ REPOSITORY git_diff yes no 0.02s
✅ REPOSITORY secretlint yes no 0.75s
✅ YAML yamllint 1 0 0.6s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

@XunliYang XunliYang left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM

@YadingFang
YadingFang merged commit 21bf2c6 into main Dec 19, 2025
2 checks passed

@Wojiaozhenghao Wojiaozhenghao left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

approve

@hdamker
hdamker deleted the docs/add-422-errors-and-cloudevents-example branch March 9, 2026 11:26
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.

3 participants