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

Documentation Export HTTP API boefje #4030

Merged
merged 15 commits into from
Jan 21, 2025
Merged

Conversation

stephanie0x00
Copy link
Contributor

@stephanie0x00 stephanie0x00 commented Jan 16, 2025

Changes

This PR adds documentation on how to configure and use the HTTP API boefje.

Issue link

Issue: #4019
Closes #4019

Demo

QA notes

Double check

  • the location of the file as this is a new file + location as to make the rest of the docs pages less big.
  • cross references, as I'm starting to hate RST cross references.

Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@stephanie0x00 stephanie0x00 requested a review from a team as a code owner January 16, 2025 15:00
Copy link
Contributor

@ammar92 ammar92 left a comment

Choose a reason for hiding this comment

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

Nice work, looks good to me 👍

Just one tiny suggestion to fix the link and build

docs/source/katalogus/boefjes.rst Outdated Show resolved Hide resolved
@underdarknl underdarknl merged commit c5c40fe into main Jan 21, 2025
18 checks passed
@underdarknl underdarknl deleted the docs/export-http-api-boefje branch January 21, 2025 11:52
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.

Documentation - Add description on Export HTTP API boefje
3 participants