Skip to content

Comments

KEH-171 update api docs#1140

Open
pexxi wants to merge 2 commits intomainfrom
keh-171-update-api-docs
Open

KEH-171 update api docs#1140
pexxi wants to merge 2 commits intomainfrom
keh-171-update-api-docs

Conversation

@pexxi
Copy link

@pexxi pexxi commented Dec 30, 2025 •
edited
Loading

Improvements to the API documentation.

  • Updated API documentation endpoints (added redirects for old paths for backwards compatibility).
  • Added links to the browsable API HTML files pointing to the new Redoc and Swagger API documentations.
  • Updated the README.md for clearer language, improved formatting (e.g., code blocks, file references), and more accurate instructions for setting up and using the API and its documentation. The API documentation section now points to the correct endpoint and describes how the schema is generated.

@pexxi pexxi requested a review from a team as a code owner December 30, 2025 13:37
@pexxi pexxi force-pushed the keh-171-update-api-docs branch from 9cad461 to 0ab165c Compare December 30, 2025 13:43
@terovirtanen
Copy link
Contributor

terovirtanen commented Dec 30, 2025

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

1 similar comment
@terovirtanen
Copy link
Contributor

terovirtanen commented Dec 30, 2025

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

nicobav
nicobav requested changes Jan 9, 2026
View reviewed changes
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 20, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@pexxi pexxi force-pushed the keh-171-update-api-docs branch from 8260c02 to f395d13 Compare January 21, 2026 11:45
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 21, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@pexxi pexxi force-pushed the keh-171-update-api-docs branch 2 times, most recently from 15d5497 to 58f50bb Compare January 21, 2026 13:48
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 21, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@pexxi pexxi requested a review from nicobav January 22, 2026 06:17
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 22, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

1 similar comment
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 22, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@pexxi pexxi force-pushed the keh-171-update-api-docs branch from 07c6411 to b2ca81c Compare January 23, 2026 08:20
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 23, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

nicobav
nicobav requested changes Jan 27, 2026
View reviewed changes
Copy link
Contributor

@nicobav nicobav left a comment

Choose a reason for hiding this comment

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

Looks good, something minor stuff to polish/consider.

@nicobav
Copy link
Contributor

nicobav commented Jan 27, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@pexxi looks like statics does not work on the pr pod

@pexxi
Copy link
Author

pexxi commented Jan 28, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@pexxi looks like statics does not work on the pr pod

statics got broken due to the extra spaces in the html template. Should be fixed now.

@pexxi pexxi requested a review from nicobav January 28, 2026 08:10
@azure-pipelines
Copy link

azure-pipelines bot commented Jan 28, 2026

LINKEDEVENTS-API branch is deployed to platta: https://linkedevents-pr1140.api.dev.hel.ninja 🚀🚀🚀

@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 28, 2026

Quality Gate Passed Quality Gate passed

Issues
19 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

nicobav
nicobav approved these changes Feb 4, 2026
View reviewed changes
Copy link
Contributor

@nicobav nicobav left a comment

Choose a reason for hiding this comment

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

LGTM 👍

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

Reviewers

@nicobav nicobav nicobav approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pexxi @terovirtanen @nicobav