Enhance Object Storage API documentation with interactive exploration…#2267
Open
GabrielAzion wants to merge 1 commit into
Open
Enhance Object Storage API documentation with interactive exploration…#2267GabrielAzion wants to merge 1 commit into
GabrielAzion wants to merge 1 commit into
Conversation
… links and additional cURL examples
egermano
approved these changes
Jul 15, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
… links and additional cURL examples
Related issue: EDU-6820
docs: improve Object Storage reference with cURL examples (EN + PT-BR)
Problem
Users trying to use the Object Storage API — especially for operations like
PostObjectthat have no Console UI — had to leave the docs and navigate toapi.azion.comto figure out the actual request structure. The reference page described each operation in prose but provided no executable code, creating an unnecessary friction point.What changed
src/content/docs/en/pages/main-menu/reference/store/object-storage/index.mdxsrc/content/docs/pt-br/pages/menu-principal/referencia/store/edge-storage/index.mdx:::tipin the Azion API operations section to point to the correct API v4 reference URL (api.azion.com/v4#/operations/GetEdgeStorageBuckets)LinkButtonto the interactive API reference for quick accesscurlexamples to all 9 Azion API operations:ListObjects—GET /buckets/{bucket_name}/objectsCreateBucket—POST /bucketswithworkloads_accessfieldListBuckets—GET /bucketsUpdateBucket—PATCH /buckets/{bucket_name}withworkloads_accessGetObject—GETwithAccept: application/octet-streamPostObject—POSTwithStorage-Content-Typeheader + binary file examplePutObject—PUTwith--data-binaryDeleteObject—DELETE /objects/{object_key}DeleteBucket—DELETE /buckets/{bucket_name}Why
Object Storage has no Console UI for object-level operations.
curlexamples are the minimum viable path for developers to get unblocked without leaving the docs page. The S3 operations section already hads3cmdcommands — this change brings the same level of actionability to the Azion API section.