Skip to content

Commit

Permalink
move api definitions into private submodule
Browse files Browse the repository at this point in the history
  • Loading branch information
haruska committed Mar 14, 2024
1 parent ef9b079 commit dabeba4
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 2,534 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,4 @@ modules.xml

go.work*
.env

9 changes: 3 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
[submodule "thirdparty/api-common-protos"]
path = thirdparty/api-common-protos
url = [email protected]:googleapis/api-common-protos.git
[submodule "thirdparty/grpc-gateway"]
path = thirdparty/grpc-gateway
url = [email protected]:grpc-ecosystem/grpc-gateway.git
[submodule "apis"]
path = apis
url = [email protected]:pinecone-io/go-apis.git
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,15 @@ Then, execute `just bootstrap` to install the necessary Go packages
To avoid race conditions or having to wait for index creation, the tests require a project with at least one pod index
and one serverless index. Copy the api key and index names to a `.env` file. See `.env.example` for a template.

### API Definitions submodule

The API Definitions are in a private submodule. To checkout or update the submodules execute in the root of the project:
```shell
git submodule update --init --recursive
```

For working with submodules, see the [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) documentation.

### Just commands

`just test` : Executes all tests for the pinecone package
Expand Down
1 change: 1 addition & 0 deletions apis
Submodule apis added at 3a31d3
Loading

0 comments on commit dabeba4

Please sign in to comment.