Skip to content

Commit bd991f1

Browse files
hanspagelhanspagel
committed
chore: use “current” not “latest” registry url
1 parent a821986 commit bd991f1

File tree

61 files changed

+146
-129
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+146
-129
lines changed

‎.changeset/tasty-olives-worry.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
'@scalar/api-reference-react': patch
3+
'@scalar/api-client-react': patch
4+
'@scalar/webjar': patch
5+
'@scalar/openapi-parser': patch
6+
'@scalar/api-reference': patch
7+
'@scalar/express-api-reference': patch
8+
'@scalar/nestjs-api-reference': patch
9+
'@scalar/api-client': patch
10+
'@scalar/oas-utils': patch
11+
'@scalar/hono-api-reference': patch
12+
'scalar_api_reference': patch
13+
'@scalar/galaxy': patch
14+
'@scalar/core': patch
15+
---
16+
17+
chore: use "current" not "latest" scalar registry url

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ You're just one HTML file away from having an awesome API reference:
110110
<script>
111111
Scalar.createApiReference('#app', {
112112
// The URL of the OpenAPI/Swagger document
113-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
113+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
114114
// Avoid CORS issues
115115
proxyUrl: 'https://proxy.scalar.com',
116116
})

‎documentation/configuration.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Scalar.createApiReference('#app', {
8181
{
8282
title: 'Scalar Galaxy', // optional, would fallback to 'API #1'
8383
slug: 'scalar-galaxy', // optional, would be auto-generated from the title or the index
84-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
84+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
8585
},
8686
// API #2
8787
{
@@ -102,7 +102,7 @@ Scalar.createApiReference('#app', {
102102
sources: [
103103
// API #1
104104
{
105-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
105+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
106106
},
107107
// API #2
108108
{
@@ -126,7 +126,7 @@ Scalar.createApiReference('#app', [
126126
{
127127
title: 'Scalar Galaxy', // optional, would fallback to 'API #1'
128128
slug: 'scalar-galaxy', // optional, would be auto-generated from the title or the index
129-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
129+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
130130
customCss: `body { background-color: #BADA55}`
131131
},
132132
// Configuration #2
@@ -147,7 +147,7 @@ By default, the first one in the list will be the default configuration. You can
147147
```js
148148
Scalar.createApiReference('#app', [
149149
{
150-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
150+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
151151
},
152152
{
153153
url: 'https://example.com/openapi.json',
@@ -172,7 +172,7 @@ Scalar.createApiReference('#app', [
172172
sources: [
173173
// API #1
174174
{
175-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
175+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
176176
},
177177
// API #2
178178
{

‎documentation/guides/api-references/getting-started.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The quickest way to start is a HTML page, that loads our JavaScript:
2525
<script>
2626
Scalar.createApiReference('#app', {
2727
// The URL of the OpenAPI/Swagger document
28-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
28+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
2929
// Avoid CORS issues
3030
proxyUrl: 'https://proxy.scalar.com',
3131
})

‎documentation/integrations/actix-web.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ async fn main() -> std::io::Result<()> {
2626
let configuration = json!({
2727
// URL to your OpenAPI document
2828
// Learn more about the configuration: https://guides.scalar.com/scalar/scalar-api-references/configuration
29-
"url": "https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json",
29+
"url": "https://registry.scalar.com/@scalar/apis/galaxy?format=json",
3030
});
3131

3232
println!("Server running on http://localhost:8080/scalar");

‎documentation/integrations/aspnetcore/integration.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ app.MapScalarApiReference(options =>
176176
options.WithOpenApiRoutePattern("https://api.example.com/openapi/{documentName}.json");
177177

178178
// Static external URL (no placeholder)
179-
options.WithOpenApiRoutePattern("https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json");
179+
options.WithOpenApiRoutePattern("https://registry.scalar.com/@scalar/apis/galaxy?format=json");
180180
});
181181
```
182182

@@ -203,7 +203,7 @@ app.MapScalarApiReference(options => options.AddDocument("v1",
203203

204204
// External OpenAPI document
205205
app.MapScalarApiReference(options => options.AddDocument("galaxy",
206-
"Galaxy API", "https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json"));
206+
"Galaxy API", "https://registry.scalar.com/@scalar/apis/galaxy?format=json"));
207207
```
208208

209209
#### Add Multiple Documents
@@ -226,7 +226,7 @@ var documents = new[]
226226
{
227227
new ScalarDocument("v1", "Production API", "api/v1/openapi.json"),
228228
new ScalarDocument("v2-beta", "Beta API", "api/v2-beta/openapi.json", true),
229-
new ScalarDocument("galaxy", "Galaxy API", "https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json")
229+
new ScalarDocument("galaxy", "Galaxy API", "https://registry.scalar.com/@scalar/apis/galaxy?format=json")
230230
};
231231
app.MapScalarApiReference(options => options.AddDocuments(documents));
232232
```

‎documentation/integrations/axum.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ async fn main() {
2727
let configuration = json!({
2828
// URL to your OpenAPI document
2929
// Learn more about the configuration: https://guides.scalar.com/scalar/scalar-api-references/configuration
30-
"url": "https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json",
30+
"url": "https://registry.scalar.com/@scalar/apis/galaxy?format=json",
3131
});
3232

3333
let app = Router::new()

‎documentation/integrations/docker.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Run the Docker container with your OpenAPI configuration:
66

77
```bash
8-
docker run -p 8080:8080 -e API_REFERENCE_CONFIG='{"sources":[{"url": "https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json"}],"theme": "purple"}' scalarapi/api-reference:latest
8+
docker run -p 8080:8080 -e API_REFERENCE_CONFIG='{"sources":[{"url": "https://registry.scalar.com/@scalar/apis/galaxy?format=json"}],"theme": "purple"}' scalarapi/api-reference:latest
99
```
1010

1111
Visit `http://localhost:8080` to see your API reference.

‎documentation/integrations/docusaurus.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ plugins: [
2525
route: '/scalar',
2626
showNavLink: true, // optional, default is true
2727
configuration: {
28-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=yaml',
28+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=yaml',
2929
},
3030
} as ScalarOptions,
3131
],
@@ -50,7 +50,7 @@ plugins: [
5050
route: '/scalar',
5151
showNavLink: true, // optional, default is true
5252
configuration: {
53-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
53+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
5454
},
5555
} as ScalarOptions,
5656
],
@@ -161,7 +161,7 @@ const config = {
161161
route: '/scalar',
162162
configuration: {
163163
// Put the URL to your OpenAPI document here:
164-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
164+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
165165
},
166166
},
167167
],
@@ -192,7 +192,7 @@ const config: Config = {
192192
route: '/scalar',
193193
configuration: {
194194
// Put the URL to your OpenAPI document here:
195-
url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
195+
url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
196196
},
197197
} as ScalarOptions,
198198
],

‎documentation/integrations/fastify.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ await fastify.register(ScalarApiReference, {
343343
// On your domain:
344344
url: '/openapi.json',
345345
// Or somewhere else:
346-
// url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=yaml',
346+
// url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=yaml',
347347
},
348348
})
349349
```

0 commit comments

Comments
 (0)