docs: clarify different types of API access #535
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dwilding
changed the title
benhoyt
approved these changes
Dec 16, 2024
docs/explanation/api-and-clients.md
Outdated
| * `read`: these are allowed from any authenticated user, regardless of access level. They are usually read operations that use the HTTP `GET` method, such as listing services or viewing notices. | ||
| * `admin`: these are only allowed from admin users. They are usually write or modify operations that use the HTTP `POST` method, such as adding a layer or starting a service. | ||
| * **Open-access** - Allowed from any user, even unauthenticated users using the HTTP-over-TCP listener. | ||
| * `GET /v1/system-info`, which returns the Pebble version and an identifier for the daemon |
There was a problem hiding this comment.
It's actually an identifier for this specific boot. Could just say "Pebble version and other information", and leave details to Tiexin's API page.
docs/explanation/api-and-clients.md
Outdated
| * `admin`: these are only allowed from admin users. They are usually write or modify operations that use the HTTP `POST` method, such as adding a layer or starting a service. | ||
| * **Open-access** - Allowed from any user, even unauthenticated users using the HTTP-over-TCP listener. | ||
| * `GET /v1/system-info`, which returns the Pebble version and an identifier for the daemon | ||
| * `GET /v1/health`, which returns a boolean to indicate the state of Pebble's health checks |
There was a problem hiding this comment.
To make the meaning of true clearer:
Suggested change
| * `GET /v1/health`, which returns a boolean to indicate the state of Pebble's health checks | |
| * `GET /v1/health`, which returns a boolean to indicate whether Pebble's health checks are all healthy |
IronCore864
approved these changes
Dec 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The purpose of this PR is make it easier to understand details about API security. (I'll create a separate PR to add a general security overview doc)
Summary of changes:
readoradminaccess leveluntrustedaccess levelPreview build: https://canonical-pebble--535.com.readthedocs.build/en/535/