Skip to content

Commit 571e014

Browse files
zentronclaude
andcommitted
Simplify shields.io content into a note on the JSON endpoint
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 2bfd07c commit 571e014

1 file changed

Lines changed: 2 additions & 17 deletions

File tree

src/pages/docs/projects/badges.md

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ GET /api/{spaceId}/projects/{projectSlug}/badge/{environmentSlug}/latest_release
6565

6666
### JSON endpoint
6767

68-
Returns badge data as JSON, useful for integrations with third-party badge services:
68+
Returns badge data as JSON. You can use this endpoint to externalize badge rendering through third-party services like [shields.io](https://shields.io), which offloads requests from your Octopus Server.
6969

7070
```
7171
GET /api/{spaceId}/projects/{projectSlug}/badge/{environmentSlug}/latest_release.json
@@ -80,21 +80,6 @@ GET /api/{spaceId}/projects/{projectSlug}/badge/{environmentSlug}/latest_release
8080
| `includeFailed` | `false` | Include failed, canceled, or timed-out releases |
8181
| `tenantId` | | Filter by a specific tenant for multi-tenant deployments |
8282

83-
## Use badges with shields.io
84-
85-
You can use the JSON endpoint with [shields.io Dynamic JSON Badge](https://shields.io/badges/dynamic-json-badge) to serve badges through shields.io's infrastructure. This offloads requests from your Octopus Server, as shields.io has its own caching layer.
86-
87-
To create a shields.io badge:
88-
89-
1. Open the badge builder and copy the **URL** for the JSON endpoint (ending in `.json`).
90-
2. URL-encode the endpoint and use it as the `url` parameter for a shields.io dynamic badge.
91-
92-
For example:
93-
94-
```
95-
https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fyour-octopus.example.com%2Fapi%2FSpaces-1%2Fprojects%2Fmy-project%2Fbadge%2Fproduction%2Flatest_release.json&query=%24.Message&label=Production
96-
```
97-
9883
## Caching
9984

100-
Badge responses include HTTP caching headers to reduce load on your Octopus Server. External consumers like shields.io also maintain their own caches. This means badge updates may not appear instantly after a deployment completes.
85+
Badge responses include HTTP caching headers to reduce load on your Octopus Server. This means badge updates may not appear instantly after a deployment completes.

0 commit comments

Comments
 (0)