Skip to content

Update database prefix documentation to be more detailed - #143

Merged
oliverchang merged 4 commits into
ossf:mainfrom
joshbuker:update/prefix-documentation
Apr 18, 2023
Merged

Update database prefix documentation to be more detailed#143
oliverchang merged 4 commits into
ossf:mainfrom
joshbuker:update/prefix-documentation

Conversation

@joshbuker

@joshbuker joshbuker commented Apr 3, 2023

Copy link
Copy Markdown
Contributor

Rather than a generic description, updated the table to provide more specific (and actionable) information:

  • Prefix
  • Database Name / Source URL
  • Canonical URL for a given <ID>
  • API Endpoint for a given <ID>
  • Regex for the ID

May not be fully complete or accurate, but should provide more actionable guidance for OSV consumers and producers.

@joshbuker
joshbuker force-pushed the update/prefix-documentation branch from 7731026 to 03a25b3 Compare April 3, 2023 22:41
@joshbuker

Copy link
Copy Markdown
Contributor Author

Alternatively, we can embed the same information in the description field using <ul> or similar.

@oliverchang oliverchang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for starting this! some comments/questions here.

Comment thread docs/schema.md Outdated
Comment thread docs/schema.md
@joshbuker
joshbuker force-pushed the update/prefix-documentation branch from 6a41d11 to ef406d4 Compare April 4, 2023 07:44
@joshbuker

joshbuker commented Apr 4, 2023

Copy link
Copy Markdown
Contributor Author

That's odd...I amended my commit with the sign-off, and the build is still failing...?

Edit: I missed a commit before my merge commit. It was easiest to just redo my history with a soft reset and sign off on that.

Rather than a generic description, updated the table to provide more specific
(and actionable) information:

- Prefix
- Database Name / Source URL
- Canonical URL for a given <ID>
- API Endpoint for a given <ID>
- Regex for the ID

May not be fully complete or accurate, but should provide more actionable
guidance for OSV consumers and producers.

Signed-off-by: Josh Buker <crypto@joshbuker.com>
@joshbuker
joshbuker force-pushed the update/prefix-documentation branch from ef406d4 to 82c67c5 Compare April 4, 2023 07:55
@joshbuker
joshbuker requested a review from oliverchang April 4, 2023 08:05
joshbuker added a commit to joshbuker/osv-schema that referenced this pull request Apr 12, 2023
Signed-off-by: Josh Buker <crypto@joshbuker.com>
@joshbuker
joshbuker force-pushed the update/prefix-documentation branch from c569cba to e398682 Compare April 12, 2023 03:16

@oliverchang oliverchang left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This LGTM. I added two commits filling in some contribution links and OSV URLs though. Let me know if you agree.

@joshbuker

joshbuker commented Apr 13, 2023

Copy link
Copy Markdown
Contributor Author

@oliverchang Heads up that you missed the sign-off on your commits.

LGTM, I'll add https://gsd.id/getting-started for how to contribute to GSD (docs are WIP) after your commits are fixed, but otherwise don't see any issues.

@oliverchang

Copy link
Copy Markdown
Collaborator

@oliverchang Heads up that you missed the sign-off on your commits.

Yep I messed up there :) Merging !

@oliverchang
oliverchang merged commit 1550bfa into ossf:main Apr 18, 2023
@joshbuker
joshbuker deleted the update/prefix-documentation branch April 18, 2023 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants