You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/projects/badges.md
+2-17Lines changed: 2 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ GET /api/{spaceId}/projects/{projectSlug}/badge/{environmentSlug}/latest_release
65
65
66
66
### JSON endpoint
67
67
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.
69
69
70
70
```
71
71
GET /api/{spaceId}/projects/{projectSlug}/badge/{environmentSlug}/latest_release.json
@@ -80,21 +80,6 @@ GET /api/{spaceId}/projects/{projectSlug}/badge/{environmentSlug}/latest_release
80
80
|`includeFailed`|`false`| Include failed, canceled, or timed-out releases |
81
81
|`tenantId`|| Filter by a specific tenant for multi-tenant deployments |
82
82
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.
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