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

Tracking issue for the next N APIs #888

Closed
70 tasks done
coryan opened this issue Jan 29, 2025 · 1 comment
Closed
70 tasks done

Tracking issue for the next N APIs #888

coryan opened this issue Jan 29, 2025 · 1 comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@coryan
Copy link
Contributor

coryan commented Jan 29, 2025

I produced this list using:

cd $HOME/googleapis # my clone of https://github.com/googleapis/googleapis
jq '.apis | map(.directory + "/" + .configFile)' < ../googleapis/api-index-v1.json  | grep -Ev '"google/(shopping|maps|home|apps|ads|analytics|chromeos)/' | grep -v beta | grep -v alpha >foo.txt

And then edited the list to make it work nicely as a GitHub list. This is an imperfect list, but we can improve it as we go along.

For any one of these files the procedure to generate the library is something like:

config=<THE TARGET CONFIG FILE>  # e.g. google/cloud/accessapproval/v1/accessapproval_v1.yaml

and then

source=$(dirname ${config})
local=${source#google/}

cargo new --lib --vcs none  src/generated/${local}
taplo fmt Cargo.tml
go -C generator/ run ./cmd/sidekick generate     -project-root ..     -specification-source ${source}  -service-config ${config}  -output src/generated/${local}
cargo fmt
git add .

Then run some local tests:

typos
cargo build
cargo doc

Adjust .typos.toml if needed, consider sending an upstream CL to fix any real typos.

If the tests pass, commit the changes, and send a PR. If the tests do not pass, document the blockers in a sub-issue.


This list only includes endpoints where we have SDKs in C++, C#, Go, Java, NodeJS, PHP, Python, and Ruby. We can worry about the rest of the APIs after these are done.

@coryan coryan added priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Jan 29, 2025
codyoss added a commit that referenced this issue Jan 30, 2025
@coryan coryan changed the title Tracking issue for most APIs Tracking issue for the next N APIs Jan 31, 2025
@coryan
Copy link
Contributor Author

coryan commented Feb 14, 2025

Closing, the last remaining task will merge in a few minutes.

@coryan coryan closed this as completed Feb 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

1 participant