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

Update github_license table to use GraphQL API #236

Closed
cbruno10 opened this issue May 1, 2023 · 0 comments · Fixed by #237
Closed

Update github_license table to use GraphQL API #236

cbruno10 opened this issue May 1, 2023 · 0 comments · Fixed by #237
Assignees
Labels
enhancement New feature or request

Comments

@cbruno10
Copy link
Contributor

cbruno10 commented May 1, 2023

Is your feature request related to a problem? Please describe.
I'd like to use the GraphQL API when querying the table

Describe the solution you'd like
Update the table to use the GraphQL API

Describe alternatives you've considered
N/A

Additional context

For any fields that have paging, consider implementing that field as another table to avoid excess API calls (as per https://steampipe.io/docs/develop/plugin-release-checklist#data-ingestion).

  • New columns
    • nickname - Customary short name for the license.
    • pseudo_license - Indicates if license is a placeholder (e.g. other, no-license).
  • Removed columns
    • url - The API url for rest api, not returned via GraphQL - not really required.
  • Columns with data changes (please include examples of old and new data for each entry)
    • conditions changed from array of string values to array of objects.
      • Old ["include-copyright”,"document-changes”,"disclose-source"]
      • New [{"Key": "include-copyright", "Label": "License and copyright notice", "Description": "A copy of the license and copyright notice must be included with the licensed material."}, {"Key": "document-changes", "Label": "State changes", "Description": "Changes made to the licensed material must be documented."}, {"Key": "disclose-source", "Label": "Disclose source", "Description": "Source code must be made available when the licensed material is distributed.”}]
    • limitations changed from array of string values to array of objects.
      • Old ["liability”,"warranty"]
      • New [{"Key": "liability", "Label": "Liability", "Description": "This license includes a limitation of liability."}, {"Key": "warranty", "Label": "Warranty", "Description": "This license explicitly states that it does NOT provide any warranty."}]
    • permissions changed from array of string values to array of objects.
      • Old ["commercial-use”,"modifications”,"distribution”,"patent-use”,"private-use"]
      • New [{"Key": "commercial-use", "Label": "Commercial use", "Description": "The licensed material and derivatives may be used for commercial purposes."}, {"Key": "modifications", "Label": "Modification", "Description": "The licensed material may be modified."}, {"Key": "distribution", "Label": "Distribution", "Description": "The licensed material may be distributed."}, {"Key": "patent-use", "Label": "Patent use", "Description": "This license provides an express grant of patent rights from contributors."}, {"Key": "private-use", "Label": "Private use", "Description": "The licensed material may be used and modified in private."}]
@cbruno10 cbruno10 added the enhancement New feature or request label May 1, 2023
@graza-io graza-io self-assigned this May 2, 2023
@graza-io graza-io linked a pull request May 2, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants