Skip to content

Adding new URL params to Connector API endpoints + new type to Connector types #3549

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Jan 22, 2025
Merged

Adding new URL params to Connector API endpoints + new type to Connector types #3549

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
06c6fc0
Adding new URL params to Connector API endpoints + new type to Connec…
mattnowzari Jan 17, 2025
e2959d8
Fixed formatting issue
mattnowzari Jan 17, 2025
90f9395
Merge branch 'main' into connectors-api-client-new-params
mattnowzari Jan 17, 2025
d429054
Merge branch 'main' into connectors-api-client-new-params
mattnowzari Jan 21, 2025
5ea17fb
Added @server_default flags, changed hard flag to required, and some …
mattnowzari Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 53 additions & 5 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions specification/_json_spec/connector.delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
"type": "boolean",
"default": false,
"description": "Determines whether associated sync jobs are also deleted."
},
"hard": {
"type": "boolean",
"default": false,
"description": "A flag indicating if this should be a hard delete. Defaults to false."
}
}
}
Expand Down
7 changes: 7 additions & 0 deletions specification/_json_spec/connector.get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@
}
}
]
},
"params": {
"include_deleted": {
"type": "boolean",
"default": false,
"description": "A flag to indicate if the desired connector should be fetched even if it was soft-deleted"
}
}
}
}
5 changes: 5 additions & 0 deletions specification/_json_spec/connector.list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@
"query": {
"type": "string",
"description": "A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names"
},
"include_deleted": {
"type": "boolean",
"default": false,
"description": "A flag that indicates whether a soft-deleted connectors will be fetched"
}
}
}
Expand Down
1 change: 1 addition & 0 deletions specification/connector/_types/Connector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ export interface Connector {
api_key_secret_id?: string
configuration: ConnectorConfiguration
custom_scheduling: ConnectorCustomScheduling
deleted?: boolean
Copy link
Member

Choose a reason for hiding this comment

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

Reading elastic/elasticsearch#118669 it looks like deleted is always set.

Suggested change
deleted?: boolean
deleted: boolean

description?: string
error?: string | null
features?: ConnectorFeatures
Expand Down
4 changes: 4 additions & 0 deletions specification/connector/delete/ConnectorDeleteRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,9 @@ export interface Request extends RequestBase {
* A flag indicating if associated sync jobs should be also removed. Defaults to false.
*/
delete_sync_jobs?: boolean
/**
* A flag indicating if the connector should be hard deleted. Defaults to false.
*/
hard?: boolean
Copy link
Member

Choose a reason for hiding this comment

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

We have specific syntax for default values:

Suggested change
/**
* A flag indicating if the connector should be hard deleted. Defaults to false.
*/
hard?: boolean
/**
* A flag indicating if the connector should be hard deleted.
* @server_default false
*/
hard?: boolean

}
}
6 changes: 6 additions & 0 deletions specification/connector/get/ConnectorGetRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,10 @@ export interface Request extends RequestBase {
*/
connector_id: Id
}
query_parameters: {
/**
* A flag to indicate if the desired connector should be fetched even if it was soft-deleted
*/
include_deleted?: boolean
}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
query_parameters: {
/**
* A flag to indicate if the desired connector should be fetched even if it was soft-deleted
*/
include_deleted?: boolean
}
query_parameters: {
/**
* A flag to indicate if the desired connector should be fetched even if it was soft-deleted
* @server_default false
*/
include_deleted?: boolean
}

}
4 changes: 4 additions & 0 deletions specification/connector/list/ConnectorListRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@ export interface Request extends RequestBase {
* A comma-separated list of connector service types to fetch connector documents for
*/
service_type?: Names
/**
* A flag to indicate if the desired connector should be fetched even if it was solf-deleted"
*/
include_deleted?: boolean
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/**
* A flag to indicate if the desired connector should be fetched even if it was solf-deleted"
*/
include_deleted?: boolean
/**
* A flag to indicate if the desired connector should be fetched even if it was solf-deleted"
* @server_default false
*/
include_deleted?: boolean

/**
* A wildcard query string that filters connectors with matching name, description or index name
*/
Expand Down
Loading