Skip to content

Commit

Permalink
fix: Data Connector build tag
Browse files Browse the repository at this point in the history
  • Loading branch information
johnjcsmith committed Dec 4, 2024
1 parent 5b50b3f commit 3210edd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ jobs:
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v2

- name: Build Control Plane Docker Image
- name: Build Data Connector Docker Image
env:
IMAGE_TAG: ${{ github.sha }}
DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
Expand All @@ -578,7 +578,7 @@ jobs:
--push \
--build-arg="VERSION=$VERSION" \
--build-arg="SHORT_VERSION=$SHORT_VERSION" \
-t $DOCKERHUB_USERNAME/data-connector:$IMAGE_TAG -t $DOCKERHUB_USERNAME/$data-connector:latest ./
-t $DOCKERHUB_USERNAME/data-connector:$IMAGE_TAG -t $DOCKERHUB_USERNAME/data-connector:latest ./
deploy-cloud:
runs-on: ubuntu-latest
Expand Down
1 change: 1 addition & 0 deletions data-connector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ Each connector is defined in the `config.connectors` array.
- `config.connectors[].specUrl`: The URL to your OpenAPI spec. Must be publicly accessible.
- `config.connectors[].endpoint`: The endpoint to use. (e.g. `https://api.inferable.ai`)
- `config.connectors[].defaultHeaders`: The default headers to use. (e.g. `{"Authorization": "Bearer <token>"}`)
- `config.connectors[].allowedOperations`: Explicit OpenAPI operationIDs to allow.

</details>

Expand Down
7 changes: 6 additions & 1 deletion data-connector/src/open-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Configure the connector in your `config.json`:
"endpoint": "process.env.SERVER_URL",
"defaultHeaders": {
"Authorization": "process.env.SERVER_AUTH_HEADER"
}
},
}
```

Expand Down Expand Up @@ -60,6 +60,7 @@ sequenceDiagram
- **Paranoid Mode**: Requires human approval for API requests
- **Parameter Validation**: Ensures requests match the OpenAPI specification
- **Default Headers**: Supports global headers for authentication
- **OperationId Filtering**: Explicitly allow certain OpenAPI operations

## Important Considerations

Expand All @@ -84,6 +85,10 @@ The connector automatically generates functions from OpenAPI operations:
}
```

### Large Schemas

By default, the connector will attach **all** operations in the OpenAPI spec to the model. If your schema is large, consider using `config.connectors[].allowedOperations` to explicitly allow only the operations you need.

### Security Considerations

- **Authentication**: Configure through defaultHeaders
Expand Down

0 comments on commit 3210edd

Please sign in to comment.