Skip to content

Conversation

@rfk-nc
Copy link
Collaborator

@rfk-nc rfk-nc commented Nov 29, 2025

Description

Added auto generated markdown files to describe each API endpoint.

Context

Improves application documentation.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

@rfk-nc rfk-nc force-pushed the docs/add-api-document-markdown branch 2 times, most recently from 5d87c19 to 8ed63d3 Compare November 30, 2025 15:45
@rfk-nc rfk-nc force-pushed the docs/add-api-document-markdown branch from d245ec7 to 66fbd35 Compare November 30, 2025 20:35
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