Initial v2 Types for Objects and API responses #34
Conversation
Minder Vulnerability Report ✅Minder analyzed this PR and found it does not add any new vulnerable dependencies.
|
![stacklok-cloud-staging[bot]](https://avatars.githubusercontent.com/u/110237746?s=60&v=4){kind=small}
There was a problem hiding this comment.
Dependency Information
Minder analyzed the dependencies introduced in this pull request and detected that some dependencies do not meet your security profile.
📦 Dependency: github.com/google/uuid
Trusty Score: 0
Scoring details
| Component | Score |
|---|---|
| Package activity | 0 |
| Provenance | 0 |
| Malicious | false |
Signed-off-by: Adolfo García Veytia (puerco) <[email protected]>
This commit adds the first batch of objects to start parsing the v2 trusty APIs. Signed-off-by: Adolfo García Veytia (puerco) <[email protected]>
This commit adds the initial data structures to capture the following v2/apis: - v2/alternative - v2/license - v2/pkg - v2/similar These rely on the objects defined in the previous commits. Signed-off-by: Adolfo García Veytia (puerco) <[email protected]>
puerco
force-pushed
the
initial-v2-types
branch
from
42a3934
to
bcc68f0
Compare
There was a problem hiding this comment.
Dependency Information
Minder analyzed the dependencies introduced in this pull request and detected that some dependencies do not meet your security profile.
📦 Dependency: github.com/google/uuid
Trusty Score: 0
Scoring details
| Component | Score |
|---|---|
| Malicious | false |
| Package activity | 0 |
| Provenance | 0 |
| Company *string | ||
| Blog *string | ||
| Location *string | ||
| // Email *string // email |
There was a problem hiding this comment.
seems like this needs a TODO, so it can be figured out which is the field to use.
| Licenses []*LicenseIdentifier `json:"licenses"` | ||
| Claim *LicenseClaim | ||
| Content *string // ? | ||
| URL *string // ? |
There was a problem hiding this comment.
the ? is confusing. What's the question? If there is uncertainty it's fine to document, but let's actually portray the question. Alternatively, you can post it as a GH comment in this PR.
| PublicRepos *int | ||
| PublicGists *int | ||
| Followers *int | ||
| Following *int |
There was a problem hiding this comment.
nit: Let's be consistent with struct tags and add them everywhere.
| Contributors []*Contributor | ||
| LastUpdate *time.Time `json:"last_update"` | ||
| // Scores | ||
| // "scores": {}, |
There was a problem hiding this comment.
Is there no OpenAPI schema for scores?
This PR adds two packages with the initial data structures to capture the following v2/apis:
The response types build on the types defined on the objects package.
Note that this initial push of data types is subject to change along with the v2 API design, the main goal is to start structuring the packages and their files to quickly follow the API improvements.