Skip to content

Commit

Permalink
update readme with latest swagger
Browse files Browse the repository at this point in the history
  • Loading branch information
sbtaylor15 committed Aug 21, 2024
1 parent 0afb986 commit 0f89690
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 87 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ RestAPI for the package Object

## Path Table

| Method | Path | Description |
|--------|--------------------------------------------|--------------------------------------------------------------------------|
| GET | [/msapi/package](#getmsapipackage) | Get a List of Packages that are like the passed package name and version |
| GET | [/msapi/package/:key](#getmsapipackagekey) | Get a Package |
| POST | [/msapi/provenance](#postmsapiprovenance) | Upload Provenance JSON |
| POST | [/msapi/sbom](#postmsapisbom) | Upload an SBOM |
| Method | Path | Description |
| --- | --- | --- |
| GET | [/msapi/package](#getmsapipackage) | Get a List of Packages that are like the passed package name and version |
| GET | [/msapi/package/:key](#getmsapipackagekey) | Get a Package |
| POST | [/msapi/provenance](#postmsapiprovenance) | Upload Provenance JSON |
| POST | [/msapi/sbom](#postmsapisbom) | Upload an SBOM |

## Reference Table

Expand All @@ -33,10 +33,10 @@ RestAPI for the package Object

### [GET]/msapi/package

- Summary
- Summary
Get a List of Packages that are like the passed package name and version

- Description
- Description
Get a list of Packages.

#### Responses
Expand All @@ -47,10 +47,10 @@ Get a list of Packages.

### [GET]/msapi/package/:key

- Summary
- Summary
Get a Package

- Description
- Description
Get a package based on the _key or name.

#### Responses
Expand All @@ -61,10 +61,10 @@ Get a package based on the _key or name.

### [POST]/msapi/provenance

- Summary
- Summary
Upload Provenance JSON

- Description
- Description
Create a new Provenance and persist it

#### Responses
Expand All @@ -75,10 +75,10 @@ Create a new Provenance and persist it

### [POST]/msapi/sbom

- Summary
- Summary
Upload an SBOM

- Description
- Description
Create a new SBOM and persist it

#### Responses
Expand Down
170 changes: 97 additions & 73 deletions swagger.json
Original file line number Diff line number Diff line change
@@ -1,77 +1,101 @@
{
"swagger": "2.0",
"info": {
"description": "RestAPI for the package Object\n![Release](https://img.shields.io/github/v/release/ortelius/scec-deppkg?sort=semver)\n![license](https://img.shields.io/github/license/ortelius/.github)\n\n![Build](https://img.shields.io/github/actions/workflow/status/ortelius/scec-deppkg/build-push-chart.yml)\n[![MegaLinter](https://github.com/ortelius/scec-deppkg/workflows/MegaLinter/badge.svg?branch=main)](https://github.com/ortelius/scec-deppkg/actions?query=workflow%3AMegaLinter+branch%3Amain)\n![CodeQL](https://github.com/ortelius/scec-deppkg/workflows/CodeQL/badge.svg)\n[![OpenSSF-Scorecard](https://api.securityscorecards.dev/projects/github.com/ortelius/scec-deppkg/badge)](https://api.securityscorecards.dev/projects/github.com/ortelius/scec-deppkg)\n\n![Discord](https://img.shields.io/discord/722468819091849316)",
"title": "Ortelius v11 Package Microservice",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "Ortelius Google Group",
"email": "[email protected]"
"swagger": "2.0",
"info": {
"description": "RestAPI for the package Object\n![Release](https://img.shields.io/github/v/release/ortelius/scec-deppkg?sort=semver)\n![license](https://img.shields.io/github/license/ortelius/.github)\n\n![Build](https://img.shields.io/github/actions/workflow/status/ortelius/scec-deppkg/build-push-chart.yml)\n[![MegaLinter](https://github.com/ortelius/scec-deppkg/workflows/MegaLinter/badge.svg?branch=main)](https://github.com/ortelius/scec-deppkg/actions?query=workflow%3AMegaLinter+branch%3Amain)\n![CodeQL](https://github.com/ortelius/scec-deppkg/workflows/CodeQL/badge.svg)\n[![OpenSSF-Scorecard](https://api.securityscorecards.dev/projects/github.com/ortelius/scec-deppkg/badge)](https://api.securityscorecards.dev/projects/github.com/ortelius/scec-deppkg)\n\n![Discord](https://img.shields.io/discord/722468819091849316)",
"title": "Ortelius v11 Package Microservice",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "Ortelius Google Group",
"email": "[email protected]"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "11.0.0"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "11.0.0"
},
"host": "localhost:3000",
"basePath": "/msapi/package",
"paths": {
"/msapi/package": {
"get": {
"description": "Get a list of Packages.",
"consumes": ["*/*"],
"produces": ["application/json"],
"tags": ["Packages"],
"summary": "Get a List of Packages that are like the passed package name and version",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/msapi/package/:key": {
"get": {
"description": "Get a package based on the _key or name.",
"consumes": ["*/*"],
"produces": ["application/json"],
"tags": ["package"],
"summary": "Get a Package",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/msapi/provenance": {
"post": {
"description": "Create a new Provenance and persist it",
"consumes": ["application/json"],
"produces": ["application/json"],
"tags": ["provenance"],
"summary": "Upload Provenance JSON",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/msapi/sbom": {
"post": {
"description": "Create a new SBOM and persist it",
"consumes": ["application/json"],
"produces": ["application/json"],
"tags": ["sbom"],
"summary": "Upload an SBOM",
"responses": {
"200": {
"description": "OK"
}
"host": "localhost:3000",
"basePath": "/msapi/package",
"paths": {
"/msapi/package": {
"get": {
"description": "Get a list of Packages.",
"consumes": [
"*/*"
],
"produces": [
"application/json"
],
"tags": [
"Packages"
],
"summary": "Get a List of Packages that are like the passed package name and version",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/msapi/package/:key": {
"get": {
"description": "Get a package based on the _key or name.",
"consumes": [
"*/*"
],
"produces": [
"application/json"
],
"tags": [
"package"
],
"summary": "Get a Package",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/msapi/provenance": {
"post": {
"description": "Create a new Provenance and persist it",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"provenance"
],
"summary": "Upload Provenance JSON",
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/msapi/sbom": {
"post": {
"description": "Create a new SBOM and persist it",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"sbom"
],
"summary": "Upload an SBOM",
"responses": {
"200": {
"description": "OK"
}
}
}
}
}
}
}
}
}

0 comments on commit 0f89690

Please sign in to comment.