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.

Sign up for GitHub

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

Jump to bottom

Pi-hole v6.0 documentation #338

Draft
wants to merge 221 commits into
base: master
Choose a base branch
from
Draft

Pi-hole v6.0 documentation #338

wants to merge 221 commits into from

Conversation

DL6ER
Copy link
Member

@DL6ER DL6ER commented Jun 16, 2020

It will be simpler to maintain the API documentation while the API is developed instead of doing this in one big batch at the end.

@DL6ER DL6ER added this to the v6.0 milestone Jun 16, 2020
@netlify
Copy link

netlify bot commented Jun 16, 2020 •
edited
Loading

✅ Deploy Preview for pihole-docs ready!

Name Link
🔨 Latest commit 1de2217
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/66e5e6781091520008d4971d
😎 Deploy Preview https://deploy-preview-338--pihole-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@dschaper dschaper mentioned this pull request Mar 6, 2021
Merged
@snyk-bot snyk-bot mentioned this pull request Oct 27, 2021
Open
This was referenced Dec 2, 2021
Open
Open
Open
@github-actions
Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

DL6ER added 17 commits July 8, 2023 13:40
@DL6ER
Pi-hole v6.0 API description for /api/dns
6446bcb 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Move white- and blacklist endpoints one level up
e601281 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Rename /api/dns/status -> /api/dns/blocking and move black- and white…
81cc07c 
…list endpoints one level up

Signed-off-by: DL6ER <[email protected]>
@DL6ER
Directly add JSON payload instead of sourceing from file
6cc622f 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Add documentation for single GET requests
febfd6a 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
The domainlist endpoints now return the same data that would be retur…
efa4564 
…ned via GET on success. This brings a more uniform experience.

Signed-off-by: DL6ER <[email protected]>
@DL6ER
Rename /api/dns/cacheinfo to /api/dns/cache
1a5de9b 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Add details for fields in API responses.
df4d3e2 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Use inline highlighting
1471058 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Add API->authentication documentation
6420a58 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Use pymdownx.highlight instead of the deprecated codehilite
3b36434 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Update documentation
bba1235 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Update DNS cache page
d058074 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
POST should not include the target to get pushed
64bbfe7 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Remove obsolete API documentation. This is to be replaced by the Open…
a7a5cb1 
…API documentation that ships with FTL

Signed-off-by: DL6ER <[email protected]>
@DL6ER
Remove obsolete domain_audit table documentation
260e322 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Add domain priorities concerning what is to be blocked and allowed
3e3d72c 
Signed-off-by: DL6ER <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 3, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@yubiuser
Merge pull request #1079 from pi-hole/dependabot/pip/release/v6.0/pip…
871742e 
…-dependencies-fecff3054d

Bump mkdocs-material from 9.5.30 to 9.5.31 in the pip-dependencies group
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 3, 2024

Conflicts have been resolved.

DL6ER and others added 13 commits August 18, 2024 09:23
@DL6ER
Merge branch 'master' into release/v6.0
c7e150f
@DL6ER
Add docker instructions to FTL gdb debugging page
00cd44f 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Add hint that users may need to use something else than apt if they a…
5a0c05f 
…re on some other distribution

Signed-off-by: DL6ER <[email protected]>
@dependabot
Bump the pip-dependencies group with 2 updates
4da307b 
Bumps the pip-dependencies group with 2 updates: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin) and [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.6 to 1.2.7
- [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases)
- [Commits](timvink/mkdocs-git-revision-date-localized-plugin@v1.2.6...v1.2.7)

Updates `mkdocs-material` from 9.5.31 to 9.5.33
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.31...9.5.33)

---
updated-dependencies:
- dependency-name: mkdocs-git-revision-date-localized-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1081 from pi-hole/dependabot/pip/release/v6.0/pip…
d3c2bac 
…-dependencies-4c038cb97e

Bump the pip-dependencies group with 2 updates
@dependabot
Bump actions/setup-python in the github_action-dependencies group
7e51b91 
Bumps the github_action-dependencies group with 1 update: [actions/setup-python](https://github.com/actions/setup-python).


Updates `actions/setup-python` from 5.1.1 to 5.2.0
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5.1.1...v5.2.0)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot
Bump mkdocs from 1.6.0 to 1.6.1 in the pip-dependencies group
993cba7 
Bumps the pip-dependencies group with 1 update: [mkdocs](https://github.com/mkdocs/mkdocs).


Updates `mkdocs` from 1.6.0 to 1.6.1
- [Release notes](https://github.com/mkdocs/mkdocs/releases)
- [Commits](mkdocs/mkdocs@1.6.0...1.6.1)

---
updated-dependencies:
- dependency-name: mkdocs
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1086 from pi-hole/dependabot/pip/release/v6.0/pip…
c54b77c 
…-dependencies-22a6d2147e

Bump mkdocs from 1.6.0 to 1.6.1 in the pip-dependencies group
@yubiuser
Merge pull request #1085 from pi-hole/dependabot/github_actions/relea…
c3c805c 
…se/v6.0/github_action-dependencies-dfe2ea1b26

Bump actions/setup-python from 5.1.1 to 5.2.0 in the github_action-dependencies group
@yubiuser
Merge pull request #842 from pi-hole/drop_static
a996eeb 
We don't offer setting a static IP anymore
@dependabot
Bump mkdocs-material from 9.5.33 to 9.5.34 in the pip-dependencies group
f498871 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.33 to 9.5.34
- [Release notes](https://github.com/squidfunk/mkdocs-material/releases)
- [Changelog](https://github.com/squidfunk/mkdocs-material/blob/master/CHANGELOG)
- [Commits](squidfunk/mkdocs-material@9.5.33...9.5.34)

---
updated-dependencies:
- dependency-name: mkdocs-material
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot
Bump markdownlint-cli2 in the npm-dependencies group
b1418f2 
Bumps the npm-dependencies group with 1 update: [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2).


Updates `markdownlint-cli2` from 0.13.0 to 0.14.0
- [Changelog](https://github.com/DavidAnson/markdownlint-cli2/blob/main/CHANGELOG.md)
- [Commits](DavidAnson/markdownlint-cli2@v0.13.0...v0.14.0)

---
updated-dependencies:
- dependency-name: markdownlint-cli2
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: npm-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1088 from pi-hole/dependabot/pip/release/v6.0/pip…
b90c93d 
…-dependencies-3b6e7c9c7d

Bump mkdocs-material from 9.5.33 to 9.5.34 in the pip-dependencies group
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 7, 2024

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 7, 2024

Conflicts have been resolved.

@yubiuser
Merge pull request #1089 from pi-hole/dependabot/npm_and_yarn/release…
c84ca00 
…/v6.0/npm-dependencies-e223067793

Bump markdownlint-cli2 from 0.13.0 to 0.14.0 in the npm-dependencies group
@github-actions GitHub Actions
Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

dependabot bot and others added 2 commits September 14, 2024 10:31
@dependabot
Bump mkdocs-git-revision-date-localized-plugin
8dac55f 
Bumps the pip-dependencies group with 1 update: [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin).


Updates `mkdocs-git-revision-date-localized-plugin` from 1.2.7 to 1.2.9
- [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases)
- [Commits](timvink/mkdocs-git-revision-date-localized-plugin@v1.2.7...v1.2.9)

---
updated-dependencies:
- dependency-name: mkdocs-git-revision-date-localized-plugin
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: pip-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1093 from pi-hole/dependabot/pip/release/v6.0/pip…
8f01b4f 
…-dependencies-24d2283009

Bump mkdocs-git-revision-date-localized-plugin from 1.2.7 to 1.2.9 in the pip-dependencies group
@github-actions GitHub Actions
Copy link
Contributor

Conflicts have been resolved.

DL6ER and others added 2 commits September 14, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yubiuser yubiuser yubiuser left review comments

@NittanySeaLion NittanySeaLion NittanySeaLion requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Never Stale
Projects
None yet
Milestone
v6.0
Development

Successfully merging this pull request may close these issues.
6 participants
@DL6ER @yubiuser @pralor-bot @NittanySeaLion @PromoFaux @dschaper