Skip to content

Commit 3d2bc79

Browse files
committed
📝 docs(api): regenerate the committed OpenAPI document
The site serves a committed copy of the document since #2252, and `just docs` fails when it differs from what the binary produces. Renaming the trash record's `name` and `reference` to the `resource` and `artifact` the handler actually reads, and giving the schema endpoint the example the document-wide check requires, both changed the generated output. Rebuilt through `just openapi`. Those two edits are the whole diff.
1 parent 2935e9e commit 3d2bc79

1 file changed

Lines changed: 17 additions & 8 deletions

File tree

site/static/openapi.json

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4621,14 +4621,14 @@
46214621
"trash": [
46224622
{
46234623
"actor": "usr_550e8400e29b41d4a716446655440000",
4624+
"artifact": "example-1.0.bin",
46244625
"deadline_unix": 1802592000,
46254626
"deleted_at_unix": 1800000000,
46264627
"digest": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
46274628
"ecosystem": "example",
4628-
"name": "example",
46294629
"reason": "compromised build",
4630-
"reference": "example-1.0.bin",
46314630
"repository": "hosted",
4631+
"resource": "example",
46324632
"restorable": true,
46334633
"state": "restorable"
46344634
}
@@ -4717,10 +4717,10 @@
47174717
}
47184718
},
47194719
{
4720-
"description": "The ecosystem artifact name",
4720+
"description": "The ecosystem resource name",
47214721
"example": "example",
47224722
"in": "query",
4723-
"name": "name",
4723+
"name": "resource",
47244724
"required": true,
47254725
"schema": {
47264726
"type": "string"
@@ -4730,7 +4730,7 @@
47304730
"description": "The ecosystem artifact reference, if any",
47314731
"example": "example-1.0.bin",
47324732
"in": "query",
4733-
"name": "reference",
4733+
"name": "artifact",
47344734
"required": false,
47354735
"schema": {
47364736
"type": "string"
@@ -4754,14 +4754,14 @@
47544754
"example": {
47554755
"record": {
47564756
"actor": "usr_550e8400e29b41d4a716446655440000",
4757+
"artifact": "example-1.0.bin",
47574758
"deadline_unix": 1802592000,
47584759
"deleted_at_unix": 1800000000,
47594760
"digest": "sha256:0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
47604761
"ecosystem": "example",
4761-
"name": "example",
47624762
"reason": "compromised build",
4763-
"reference": "example-1.0.bin",
47644763
"repository": "hosted",
4764+
"resource": "example",
47654765
"restorable": true,
47664766
"state": "restorable"
47674767
}
@@ -4889,7 +4889,16 @@
48894889
"responses": {
48904890
"200": {
48914891
"content": {
4892-
"application/json": {}
4892+
"application/json": {
4893+
"example": {
4894+
"info": {
4895+
"title": "peryx",
4896+
"version": "0.0.1"
4897+
},
4898+
"openapi": "3.1.0",
4899+
"paths": {}
4900+
}
4901+
}
48934902
},
48944903
"description": "OpenAPI 3.1 schema"
48954904
}

0 commit comments

Comments
 (0)