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.

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

docs: api spec documentation #1493

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Conversation

mineme0110
Copy link
Contributor

@mineme0110 mineme0110 commented Jan 10, 2025

Description:

Update documentation for the credential offer and present proof endpoint to make it more clear when the goal and goal code applicable
#1486

Alternatives Considered (optional):

Link to existing ADR (Architecture Decision Record), if any. If relevant, describe other approaches explored and the selected approach. Documenting why the methods were not selected will create a knowledge base for future reference, helping prevent others from revisiting less optimal ideas.

Checklist:

  • My PR follows the contribution guidelines of this project
  • My PR is free of third-party dependencies that don't comply with the Allowlist
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked the PR title to follow the conventional commit specification

Signed-off-by: mineme0110 <[email protected]>
@mineme0110 mineme0110 requested a review from a team as a code owner January 10, 2025 11:28
@mineme0110 mineme0110 changed the title fix: api spec documentation docs: api spec documentation Jan 10, 2025
Copy link
Contributor

Integration Test Results

20 files  ±0  20 suites  ±0   2s ⏱️ -1s
55 tests ±0  55 ✅ ±0  0 💤 ±0  0 ❌ ±0 
97 runs  ±0  97 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 7c9c6ad. ± Comparison against base commit 38b251b.

Copy link
Contributor

Unit Test Results

104 files  ±0  104 suites  ±0   20m 48s ⏱️ + 1m 7s
882 tests ±0  874 ✅ ±0  8 💤 ±0  0 ❌ ±0 
889 runs  ±0  881 ✅ ±0  8 💤 ±0  0 ❌ ±0 

Results for commit 7c9c6ad. ± Comparison against base commit 38b251b.

@yshyn-iohk yshyn-iohk enabled auto-merge (squash) January 10, 2025 12:03
@yshyn-iohk yshyn-iohk merged commit 37a8f41 into main Jan 10, 2025
17 of 20 checks passed
@yshyn-iohk yshyn-iohk deleted the fix-open-api-spec-documentation branch January 10, 2025 12:04
@coveralls
Copy link

Coverage Status

coverage: 48.642% (-0.1%) from 48.763%
when pulling 7c9c6ad on fix-open-api-spec-documentation
into 38b251b on main.

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

Successfully merging this pull request may close these issues.

3 participants