Skip to content

HYPERFLEET-1167 - feat: update swagger-ui and add integrity attributes #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
openshift-merge-bot merged 1 commit into from
Jun 2, 2026
+27 −63
Merged

HYPERFLEET-1167 - feat: update swagger-ui and add integrity attributes #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,10 @@ This repository supports the development of the Hyperfleet OpenAPI contract, but

This project hosts the TypeSpec files to generate the HyperFleet core OpenAPI specification. TypeSpec is an implementation detail providing better ergonomics than writing contracts in plain YAML. The repository generates the core provider contract; the provider-specific contract lives in [hyperfleet-api-spec-template](https://github.com/openshift-hyperfleet/hyperfleet-api-spec-template).

Access to the OpenAPI contract source of truth in hyperfleet-api repository:
Browse the generated core contract in Swagger UI (GitHub Pages):

- <https://openshift-hyperfleet.github.io/hyperfleet-api-spec/index.html>

Access directly to the latest generated contract in this repository:

- core: <https://openshift-hyperfleet.github.io/hyperfleet-api-spec/core.html>

## Consuming the API Specifications

### Source of truth (Production contract)
Expand Down Expand Up @@ -63,6 +59,7 @@ The repository is organized with root-level configuration files and two main dir

### Root-Level Files

- **`index.html`** - Swagger UI for browsing the core contract on GitHub Pages (swagger-ui-dist 5.32.6)
- **`main.tsp`** - Main TypeSpec entry point that imports all service definitions
- **`tspconfig.yaml`** - TypeSpec compiler configuration

Expand Down
26 changes: 0 additions & 26 deletions core.html
View file
Open in desktop

This file was deleted.

26 changes: 0 additions & 26 deletions gcp.html
View file
Open in desktop

This file was deleted.

31 changes: 25 additions & 6 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,39 @@
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta
name="description"
content="SwaggerIU"
content="HyperFleet Core API — Swagger UI"
/>
<title>HyperFleet Core API — Swagger UI</title>
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.32.6/swagger-ui.css"
integrity="sha384-9Q2fpS+xeS4ffJy6CagnwoUl+4ldAYhOs9pgZuEKxypVModhmZFzeMlvVsAjf7uT"
crossorigin="anonymous"
/>
<title>SwaggerUI</title>
<link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.4.1/swagger-ui.css" />
</head>
<body>
<div id="swagger-ui"></div>
<script src="https://unpkg.com/swagger-ui-dist@4.4.1/swagger-ui-bundle.js" crossorigin></script>
<script src="https://unpkg.com/swagger-ui-dist@4.4.1/swagger-ui-standalone-preset.js" crossorigin></script>
<script
src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.32.6/swagger-ui-bundle.js"
integrity="sha384-EYdOaiRwn44zNjrw+Tfs06qYz9BGQVo2f4/pLY5i7VorbjnZNhdplAbTBk8FXHUJ"
crossorigin="anonymous"
></script>
<script
src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.32.6/swagger-ui-standalone-preset.js"
integrity="sha384-49fpFaVrAWI/qdgl9Vv5E/4NXxRUiJX5vGuLws1NUpTWGtEqzWEx8gHTw2UTehFK"
crossorigin="anonymous"
></script>
<script>
window.onload = () => {
window.ui = SwaggerUIBundle({
url: 'https://raw.githubusercontent.com/openshift-hyperfleet/hyperfleet-api/refs/heads/main/openapi/openapi.yaml',
url: 'https://raw.githubusercontent.com/openshift-hyperfleet/hyperfleet-api-spec/refs/heads/main/schemas/core/openapi.yaml',
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset,
],
layout: 'StandaloneLayout',
});
};
</script>
Expand Down