Skip to content
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.

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

chore: update openAPI spec to remove SourcePackage #2175

Merged
merged 1 commit into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 1 addition & 46 deletions Documentation/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1693,51 +1693,6 @@ Distribution
|cpe|string|true|none|none|
|pretty_name|string|true|none|none|

<h2 id="tocS_SourcePackage">SourcePackage</h2>
<!-- backwards compatibility -->
<a id="schemasourcepackage"></a>
<a id="schema_SourcePackage"></a>
<a id="tocSsourcepackage"></a>
<a id="tocssourcepackage"></a>

```json
{
"id": "10",
"name": "libapt-pkg5.0",
"version": "1.6.11",
"kind": "binary",
"normalized_version": "",
"arch": "x86",
"module": "",
"cpe": "",
"source": {
"id": "9",
"name": "apt",
"version": "1.6.11",
"kind": "source",
"source": null
},
"x-widdershins-oldRef": "#/components/examples/Package/value"
}

```

SourcePackage

### Properties

|Name|Type|Required|Restrictions|Description|
|---|---|---|---|---|
|id|string|true|none|A unique ID representing this package|
|name|string|true|none|Name of the Package|
|version|string|true|none|Version of the Package|
|kind|string|false|none|Kind of package. Source | Binary|
|source|string|false|none|none|
|normalized_version|[Version](#schemaversion)|false|none|Version is a normalized claircore version, composed of a "kind" and an array of integers such that two versions of the same kind have the correct ordering when the integers are compared pair-wise.|
|arch|string|false|none|none|
|module|string|false|none|none|
|cpe|string|false|none|A CPE identifying the package|

<h2 id="tocS_Package">Package</h2>
<!-- backwards compatibility -->
<a id="schemapackage"></a>
Expand Down Expand Up @@ -1777,7 +1732,7 @@ Package
|name|string|true|none|Name of the Package|
|version|string|true|none|Version of the Package|
|kind|string|false|none|Kind of package. Source | Binary|
|source|[SourcePackage](#schemasourcepackage)|false|none|A source package affiliated with a Package|
|source|[Package](#schemapackage)|false|none|A package discovered by indexing a Manifest|
|normalized_version|[Version](#schemaversion)|false|none|Version is a normalized claircore version, composed of a "kind" and an array of integers such that two versions of the same kind have the correct ordering when the integers are compared pair-wise.|
|arch|string|false|none|The package's target system architecture|
|module|string|false|none|A module further defining a namespace for a package|
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ all:
# Use https://github.com/Mermade/widdershins to convert openapi.yaml to
# markdown. You'll need to have npx to run this.
Documentation/reference/api.md: openapi.yaml
npx --yes widdershins\
npx widdershins\
--search false \
--language_tabs 'python:Python' 'go:Golang' 'javascript:Javascript' \
--summary $< \
Expand Down
2 changes: 1 addition & 1 deletion httptransport/openapi.etag
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"acbb3fe61fedf4781e276a401f5a87b505e23a2bebdb878fc61f045cfe2d9817"
"a16d4a25e54a4cfe7fbf4e234af1c7585e840fef19c4f84aba1e814233c3b281"
Loading
Loading