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 189 commits into
base: master
Choose a base branch
from
Draft

Pi-hole v6.0 documentation #338

wants to merge 189 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 7c655ce
🔍 Latest deploy log https://app.netlify.com/sites/pihole-docs/deploys/6682f836b66a81000866843d
😎 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
Copy link
Contributor

github-actions bot commented Jul 8, 2023

Conflicts have been resolved.

DL6ER and others added 28 commits April 28, 2024 15:39
@DL6ER @yubiuser
Add deprecation notice to OpenVPN pages
ff9b7dd 
Signed-off-by: DL6ER <[email protected]>
@yubiuser
Merge pull request #1028 from pi-hole/dependabot/pip/release/v6.0/pip…
86f040d 
…-dependencies-641c6ff211

Bump the pip-dependencies group with 2 updates
@yubiuser
Merge pull request #1029 from pi-hole/open_vpn
1a15581 
Add deprecation notice to OpenVPN pages [v6]
@dependabot
Bump the pip-dependencies group with 2 updates
7199d84 
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.4 to 1.2.5
- [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases)
- [Commits](timvink/mkdocs-git-revision-date-localized-plugin@v1.2.4...v1.2.5)

Updates `mkdocs-material` from 9.5.19 to 9.5.21
- [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.19...9.5.21)

---
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 #1030 from pi-hole/dependabot/pip/release/v6.0/pip…
beea839 
…-dependencies-2e6defbb50

Bump the pip-dependencies group with 2 updates
@dependabot
Bump the github_action-dependencies group with 2 updates
3cb9965 
Bumps the github_action-dependencies group with 2 updates: [actions/checkout](https://github.com/actions/checkout) and [eps1lon/actions-label-merge-conflict](https://github.com/eps1lon/actions-label-merge-conflict).


Updates `actions/checkout` from 4.1.4 to 4.1.5
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.1.4...v4.1.5)

Updates `eps1lon/actions-label-merge-conflict` from 3.0.0 to 3.0.1
- [Release notes](https://github.com/eps1lon/actions-label-merge-conflict/releases)
- [Changelog](https://github.com/eps1lon/actions-label-merge-conflict/blob/main/CHANGELOG.md)
- [Commits](eps1lon/actions-label-merge-conflict@v3.0.0...v3.0.1)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
- dependency-name: eps1lon/actions-label-merge-conflict
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1033 from pi-hole/dependabot/github_actions/relea…
48ed2e8 
…se/v6.0/github_action-dependencies-220eae05df

Bump the github_action-dependencies group with 2 updates
@dependabot
Bump mkdocs-material from 9.5.21 to 9.5.23 in the pip-dependencies group
3fb549a 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.21 to 9.5.23
- [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.21...9.5.23)

---
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 actions/checkout in the github_action-dependencies group
3a5a9e8 
Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout).


Updates `actions/checkout` from 4.1.5 to 4.1.6
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.1.5...v4.1.6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1035 from pi-hole/dependabot/pip/release/v6.0/pip…
6622bc3 
…-dependencies-157145164a

Bump mkdocs-material from 9.5.21 to 9.5.23 in the pip-dependencies group
@yubiuser
Merge pull request #1037 from pi-hole/dependabot/github_actions/relea…
29bd90e 
…se/v6.0/github_action-dependencies-edf2abb101

Bump actions/checkout from 4.1.5 to 4.1.6 in the github_action-dependencies group
@dependabot
Bump mkdocs-material from 9.5.23 to 9.5.24 in the pip-dependencies group
69c47ac 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.23 to 9.5.24
- [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.23...9.5.24)

---
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]>
@yubiuser
Merge pull request #1043 from pi-hole/dependabot/pip/release/v6.0/pip…
9c039ab 
…-dependencies-eef9345e43

Bump mkdocs-material from 9.5.23 to 9.5.24 in the pip-dependencies group
@dependabot
Bump the pip-dependencies group with 2 updates
9c3a761 
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.5 to 1.2.6
- [Release notes](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/releases)
- [Commits](timvink/mkdocs-git-revision-date-localized-plugin@v1.2.5...v1.2.6)

Updates `mkdocs-material` from 9.5.24 to 9.5.25
- [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.24...9.5.25)

---
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]>
@dependabot
Bump eps1lon/actions-label-merge-conflict
77be12c 
Bumps the github_action-dependencies group with 1 update: [eps1lon/actions-label-merge-conflict](https://github.com/eps1lon/actions-label-merge-conflict).


Updates `eps1lon/actions-label-merge-conflict` from 3.0.1 to 3.0.2
- [Release notes](https://github.com/eps1lon/actions-label-merge-conflict/releases)
- [Changelog](https://github.com/eps1lon/actions-label-merge-conflict/blob/main/CHANGELOG.md)
- [Commits](eps1lon/actions-label-merge-conflict@v3.0.1...v3.0.2)

---
updated-dependencies:
- dependency-name: eps1lon/actions-label-merge-conflict
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1045 from pi-hole/dependabot/pip/release/v6.0/pip…
a9c0d92 
…-dependencies-2f8fd08ba3

Bump the pip-dependencies group with 2 updates
@yubiuser
Merge pull request #1046 from pi-hole/dependabot/github_actions/relea…
58e6be4 
…se/v6.0/github_action-dependencies-da46cecb9c

Bump eps1lon/actions-label-merge-conflict from 3.0.1 to 3.0.2 in the github_action-dependencies group
@dependabot
Bump mkdocs-material from 9.5.25 to 9.5.26 in the pip-dependencies group
fa332f6 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.25 to 9.5.26
- [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.25...9.5.26)

---
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 linkinator from 6.0.4 to 6.0.5 in the npm-dependencies group
5d40110 
Bumps the npm-dependencies group with 1 update: [linkinator](https://github.com/JustinBeckwith/linkinator).


Updates `linkinator` from 6.0.4 to 6.0.5
- [Release notes](https://github.com/JustinBeckwith/linkinator/releases)
- [Commits](JustinBeckwith/linkinator@v6.0.4...v6.0.5)

---
updated-dependencies:
- dependency-name: linkinator
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1050 from pi-hole/dependabot/pip/release/v6.0/pip…
eaf8835 
…-dependencies-454b70509d

Bump mkdocs-material from 9.5.25 to 9.5.26 in the pip-dependencies group
@yubiuser
Merge pull request #1052 from pi-hole/dependabot/npm_and_yarn/release…
40034a8 
…/v6.0/npm-dependencies-8327e346d0

Bump linkinator from 6.0.4 to 6.0.5 in the npm-dependencies group
@dependabot
Bump actions/checkout in the github_action-dependencies group
4fc221c 
Bumps the github_action-dependencies group with 1 update: [actions/checkout](https://github.com/actions/checkout).


Updates `actions/checkout` from 4.1.6 to 4.1.7
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4.1.6...v4.1.7)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: github_action-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1060 from pi-hole/dependabot/github_actions/relea…
2403883 
…se/v6.0/github_action-dependencies-0bd1363a87

Bump actions/checkout from 4.1.6 to 4.1.7 in the github_action-dependencies group
@dependabot @PromoFaux
Bump mkdocs-material from 9.5.26 to 9.5.27 in the pip-dependencies group
fe608ec 
Bumps the pip-dependencies group with 1 update: [mkdocs-material](https://github.com/squidfunk/mkdocs-material).


Updates `mkdocs-material` from 9.5.26 to 9.5.27
- [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.26...9.5.27)

---
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 linkinator from 6.0.5 to 6.0.6 in the npm-dependencies group
171e96f 
Bumps the npm-dependencies group with 1 update: [linkinator](https://github.com/JustinBeckwith/linkinator).


Updates `linkinator` from 6.0.5 to 6.0.6
- [Release notes](https://github.com/JustinBeckwith/linkinator/releases)
- [Commits](JustinBeckwith/linkinator@v6.0.5...v6.0.6)

---
updated-dependencies:
- dependency-name: linkinator
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: npm-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
@yubiuser
Merge pull request #1064 from pi-hole/dependabot/npm_and_yarn/release…
f78d2ee 
…/v6.0/npm-dependencies-f2e03948b1

Bump linkinator from 6.0.5 to 6.0.6 in the npm-dependencies group
@DL6ER
Merge branch 'master' into release/v6.0
06e30c2 
Signed-off-by: DL6ER <[email protected]>
@DL6ER
Ignore SIGUSR7 (used to signal time is now synchroized)
7c655ce 
Signed-off-by: DL6ER <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 1, 2024

Conflicts have been resolved.

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.

None yet
6 participants
@DL6ER @yubiuser @pralor-bot @NittanySeaLion @PromoFaux @dschaper