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

refactor: Schema list output to include schemaVersionID #1706

Merged
merged 2 commits into from
Jul 24, 2023

Conversation

jsimnz
Copy link
Member

@jsimnz jsimnz commented Jul 24, 2023

Relevant issue(s)

Resolves #1705

Description

Adds some additional schemaID and schemaVersionID fields to the schema list API, both HTTP and CLI

Tasks

  • I made sure the code is well commented, particularly hard-to-understand areas.
  • I made sure the repository-held documentation is changed accordingly.
  • I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).

How has this been tested?

  • Manually
  • Updated integration tests

Specify the platform(s) on which this was tested:

  • Ubuntu WSL

@jsimnz jsimnz added area/api Related to the external API component refactor This issue specific to or requires *notable* refactoring of existing codebases and components area/cli Related to the CLI binary labels Jul 24, 2023
@jsimnz jsimnz added this to the DefraDB v0.6 milestone Jul 24, 2023
@jsimnz jsimnz requested a review from nasdf July 24, 2023 20:34
@jsimnz jsimnz self-assigned this Jul 24, 2023
Copy link
Collaborator

@fredcarle fredcarle left a comment

Choose a reason for hiding this comment

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

LGTM!

@jsimnz jsimnz force-pushed the jsimnz/feat/schema-list-id-extension branch from 3e1dc28 to 994e657 Compare July 24, 2023 22:33
@jsimnz jsimnz changed the title refactor: schema list output to incluide schemaVersionID refactor: schema list output to include schemaVersionID Jul 24, 2023
Copy link
Member

@nasdf nasdf left a comment

Choose a reason for hiding this comment

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

Looks good! I think in the future we could return the full CollectionDescription from these APIs, but for now this works.

@jsimnz
Copy link
Member Author

jsimnz commented Jul 24, 2023

Looks good! I think in the future we could return the full CollectionDescription from these APIs, but for now this works.

@nasdf absolutely agree

@jsimnz jsimnz changed the title refactor: schema list output to include schemaVersionID refactor: Schema list output to include schemaVersionID Jul 24, 2023
@jsimnz jsimnz changed the title refactor: Schema list output to include schemaVersionID refactor: Schema list output to include schemaVersionID. Jul 24, 2023
@jsimnz jsimnz changed the title refactor: Schema list output to include schemaVersionID. refactor: Schema list output to include schemaVersionID Jul 24, 2023
@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

Patch coverage: 70.00% and project coverage change: +0.04% 🎉

Comparison is base (f4bc169) 75.38% compared to head (994e657) 75.42%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #1706      +/-   ##
===========================================
+ Coverage    75.38%   75.42%   +0.04%     
===========================================
  Files          208      208              
  Lines        21694    21698       +4     
===========================================
+ Hits         16352    16364      +12     
+ Misses        4203     4197       -6     
+ Partials      1139     1137       -2     
Flag Coverage Δ
all-tests 75.42% <70.00%> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed Coverage Δ
cli/schema_list.go 13.51% <0.00%> (-0.77%) ⬇️
api/http/handlerfuncs.go 78.63% <100.00%> (+0.12%) ⬆️

... and 6 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f4bc169...994e657. Read the comment docs.

@jsimnz jsimnz merged commit f4670dc into develop Jul 24, 2023
@jsimnz jsimnz deleted the jsimnz/feat/schema-list-id-extension branch July 24, 2023 22:46
Comment on lines +74 to +75
cmd.Printf("# Schema ID: %s\n", c.ID)
cmd.Printf("# Version ID: %s\n", c.VersionID)
Copy link
Member

Choose a reason for hiding this comment

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

thought: There is no test for these :,)

shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
…k#1706)

## Relevant issue(s)

Resolves sourcenetwork#1705 

## Description

Adds some additional `schemaID` and `schemaVersionID` fields to the
`schema list` API, both HTTP and CLI
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api Related to the external API component area/cli Related to the CLI binary refactor This issue specific to or requires *notable* refactoring of existing codebases and components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

schema list missing some schema version ID information
4 participants