Skip to content

website/docs: remove slash from API reference #16117

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

Merged
merged 1 commit into from
Aug 12, 2025
Merged

website/docs: remove slash from API reference #16117

merged 1 commit into from
Aug 12, 2025

Conversation

melizeche
Copy link
Member

@melizeche melizeche commented Aug 11, 2025


Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make docs)

@melizeche melizeche requested review from a team as code owners August 11, 2025 21:10
Copy link

netlify bot commented Aug 11, 2025

Deploy Preview for authentik-integrations canceled.

Name Link
🔨 Latest commit d33a5d4
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/689a5c5f0a85e10008f3b2d9

Copy link

netlify bot commented Aug 11, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit d33a5d4
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/689a5c5fe29ad000087d3cda

Copy link

netlify bot commented Aug 11, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit d33a5d4
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/689a5c5fe219de000864a40a
😎 Deploy Preview https://deploy-preview-16117--authentik-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 project configuration.

Copy link

codecov bot commented Aug 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.78%. Comparing base (cf72074) to head (d33a5d4).
⚠️ Report is 5 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16117      +/-   ##
==========================================
- Coverage   92.79%   92.78%   -0.01%     
==========================================
  Files         836      836              
  Lines       45160    45160              
==========================================
- Hits        41904    41901       -3     
- Misses       3256     3259       +3     
Flag Coverage Δ
e2e 46.61% <ø> (-0.04%) ⬇️
integration 23.58% <ø> (+<0.01%) ⬆️
unit 90.91% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-d33a5d4b9abb42e799f340cc916b2c1fc25a267b
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-d33a5d4b9abb42e799f340cc916b2c1fc25a267b

Afterwards, run the upgrade commands from the latest release notes.

@dominic-r
Copy link
Contributor

@dominic-r
Copy link
Contributor

ps, we don't have a preview for api docs?

@GirlBossRush
Copy link
Contributor

@melizeche @dominic-r API preview link

https://689b39dc0335ff7e7000197f--authentik-api-docs.netlify.app/reference/admin-settings-retrieve/

@GirlBossRush GirlBossRush self-requested a review August 12, 2025 13:01
@rissson rissson merged commit 34bab28 into main Aug 12, 2025
109 checks passed
@rissson rissson deleted the fix/api_ref branch August 12, 2025 13:02
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.

5 participants