Skip to content

Commit 589e5aa

Browse files
sbtaylor15sbtaylor15
committed
docs: auto-update swagger documentation
1 parent 2e222e7 commit 589e5aa

File tree

2 files changed

+10
-145
lines changed

2 files changed

+10
-145
lines changed

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ RestAPI endpoint for retrieving SBOM data to a component
1919

2020
## Path Table
2121

22-
| Method | Path | Description |
23-
|--------|------------------------------|-------------|
24-
| GET | [/health](#gethealth) | Health |
25-
| GET | [/msapi/sbom](#getmsapisbom) | Export Sbom |
22+
| Method | Path | Description |
23+
| --- | --- | --- |
24+
| GET | [/health](#gethealth) | Health |
25+
| GET | [/msapi/sbom](#getmsapisbom) | Export Sbom |
2626

2727
## Reference Table
2828

29-
| Name | Path | Description |
30-
|---------------------|-----------------------------------------------------------------------------------|-------------|
31-
| HTTPValidationError | [#/components/schemas/HTTPValidationError](#componentsschemashttpvalidationerror) | |
32-
| StatusMsg | [#/components/schemas/StatusMsg](#componentsschemasstatusmsg) | |
33-
| ValidationError | [#/components/schemas/ValidationError](#componentsschemasvalidationerror) | |
29+
| Name | Path | Description |
30+
| --- | --- | --- |
31+
| HTTPValidationError | [#/components/schemas/HTTPValidationError](#componentsschemashttpvalidationerror) | |
32+
| StatusMsg | [#/components/schemas/StatusMsg](#componentsschemasstatusmsg) | |
33+
| ValidationError | [#/components/schemas/ValidationError](#componentsschemasvalidationerror) | |
3434

3535
## Path Details
3636

‎openapi.json‎

Lines changed: 1 addition & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1 @@
1-
{
2-
"openapi": "3.1.0",
3-
"info": {
4-
"title": "ms-sbom-export",
5-
"description": "RestAPI endpoint for retrieving SBOM data to a component",
6-
"contact": {
7-
"name": "DeployHub SBOM Export",
8-
"url": "https://github.com/DeployHubProject/DeployHub-Pro/issues",
9-
"email": "[email protected]"
10-
},
11-
"license": {
12-
"name": "Apache 2.0",
13-
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
14-
},
15-
"version": "10.0.0"
16-
},
17-
"servers": [
18-
{ "url": "http://localhost:5004", "description": "Local Server" }
19-
],
20-
"paths": {
21-
"/health": {
22-
"get": {
23-
"tags": ["health"],
24-
"summary": "Health",
25-
"description": "This health check end point used by Kubernetes",
26-
"operationId": "health_health_get",
27-
"responses": {
28-
"200": {
29-
"description": "Successful Response",
30-
"content": {
31-
"application/json": {
32-
"schema": { "$ref": "#/components/schemas/StatusMsg" }
33-
}
34-
}
35-
}
36-
}
37-
}
38-
},
39-
"/msapi/sbom": {
40-
"get": {
41-
"tags": ["sbom"],
42-
"summary": "Export Sbom",
43-
"description": "This is the end point used to create PDF of the Application/Component SBOM",
44-
"operationId": "export_sbom_msapi_sbom_get",
45-
"parameters": [
46-
{
47-
"name": "compid",
48-
"in": "query",
49-
"required": false,
50-
"schema": {
51-
"anyOf": [{ "type": "string" }, { "type": "null" }],
52-
"title": "Compid"
53-
}
54-
},
55-
{
56-
"name": "appid",
57-
"in": "query",
58-
"required": false,
59-
"schema": {
60-
"anyOf": [{ "type": "string" }, { "type": "null" }],
61-
"title": "Appid"
62-
}
63-
},
64-
{
65-
"name": "envid",
66-
"in": "query",
67-
"required": false,
68-
"schema": {
69-
"anyOf": [{ "type": "string" }, { "type": "null" }],
70-
"title": "Envid"
71-
}
72-
}
73-
],
74-
"responses": {
75-
"200": {
76-
"description": "Successful Response",
77-
"content": { "application/json": { "schema": {} } }
78-
},
79-
"422": {
80-
"description": "Validation Error",
81-
"content": {
82-
"application/json": {
83-
"schema": { "$ref": "#/components/schemas/HTTPValidationError" }
84-
}
85-
}
86-
}
87-
}
88-
}
89-
}
90-
},
91-
"components": {
92-
"schemas": {
93-
"HTTPValidationError": {
94-
"properties": {
95-
"detail": {
96-
"items": { "$ref": "#/components/schemas/ValidationError" },
97-
"type": "array",
98-
"title": "Detail"
99-
}
100-
},
101-
"type": "object",
102-
"title": "HTTPValidationError"
103-
},
104-
"StatusMsg": {
105-
"properties": {
106-
"status": { "type": "string", "title": "Status", "default": "" },
107-
"service_name": {
108-
"type": "string",
109-
"title": "Service Name",
110-
"default": ""
111-
}
112-
},
113-
"type": "object",
114-
"title": "StatusMsg"
115-
},
116-
"ValidationError": {
117-
"properties": {
118-
"loc": {
119-
"items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] },
120-
"type": "array",
121-
"title": "Location"
122-
},
123-
"msg": { "type": "string", "title": "Message" },
124-
"type": { "type": "string", "title": "Error Type" }
125-
},
126-
"type": "object",
127-
"required": ["loc", "msg", "type"],
128-
"title": "ValidationError"
129-
}
130-
}
131-
},
132-
"tags": [
133-
{ "name": "health", "description": "health check end point" },
134-
{ "name": "sbom", "description": "Retrieve Package Dependencies end point" }
135-
]
136-
}
1+
{"openapi":"3.1.0","info":{"title":"ms-sbom-export","description":"RestAPI endpoint for retrieving SBOM data to a component","contact":{"name":"DeployHub SBOM Export","url":"https://github.com/DeployHubProject/DeployHub-Pro/issues","email":"[email protected]"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"version":"10.0.0"},"servers":[{"url":"http://localhost:5004","description":"Local Server"}],"paths":{"/health":{"get":{"tags":["health"],"summary":"Health","description":"This health check end point used by Kubernetes","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMsg"}}}}}}},"/msapi/sbom":{"get":{"tags":["sbom"],"summary":"Export Sbom","description":"This is the end point used to create PDF of the Application/Component SBOM","operationId":"export_sbom_msapi_sbom_get","parameters":[{"name":"compid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Compid"}},{"name":"appid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Appid"}},{"name":"envid","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Envid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StatusMsg":{"properties":{"status":{"type":"string","title":"Status","default":""},"service_name":{"type":"string","title":"Service Name","default":""}},"type":"object","title":"StatusMsg"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"tags":[{"name":"health","description":"health check end point"},{"name":"sbom","description":"Retrieve Package Dependencies end point"}]}

0 commit comments

Comments
 (0)