Skip to content

Commit

Permalink
Automated build 'Automated commit 'Merge pull request #1787 from sail…
Browse files Browse the repository at this point in the history
…point/kd/PLTCONN-5712--update-developer-document-to-correctly-reflect-how-to-use-v3/sources/{sourceId}/schemas

kd/PLTCONN-5712--update-developer-document-to-correctly-reflect-how-to-use-v3/sources/{sourceId}/schemas' by github action: 10638271091' go sdk: 10638275447
  • Loading branch information
developer-relations-sp committed Aug 30, 2024
1 parent 5c427da commit 7960108
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 6 deletions.
18 changes: 17 additions & 1 deletion api_beta/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41299,7 +41299,10 @@ paths:
schema:
type: string
- description: "If set to 'group', then the account schema is filtered and only\
\ group schemas are returned. Only a value of 'group' is recognized."
\ group schemas are returned. Only a value of 'group' is recognized presently.\
\ \nNote: The API will check whether include-types is group or not, if not,\
\ it will list schemas based on include-names, if include-names is not provided,\
\ it will list all schemas."
example: group
in: query
name: include-types
Expand All @@ -41309,6 +41312,13 @@ paths:
- group
- user
type: string
- description: A comma-separated list of schema names to filter result.
example: account
in: query
name: include-names
required: false
schema:
type: string
responses:
"200":
content:
Expand Down Expand Up @@ -41392,6 +41402,9 @@ paths:
$ref: '#/components/schemas/ErrorResponseDto'
description: Internal Server Error - Returned if there is an unexpected
error.
security:
- UserContextAuth:
- idn:source-schema:read
summary: List Schemas on Source
tags:
- Sources
Expand Down Expand Up @@ -41476,6 +41489,9 @@ paths:
$ref: '#/components/schemas/ErrorResponseDto'
description: Internal Server Error - Returned if there is an unexpected
error.
security:
- UserContextAuth:
- idn:source-schema:create
summary: Create Schema on Source
tags:
- Sources
Expand Down
12 changes: 11 additions & 1 deletion api_beta/api_sources.go

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

10 changes: 6 additions & 4 deletions api_beta/docs/SourcesAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -1305,7 +1305,7 @@ Name | Type | Description | Notes

## GetSourceSchemas

> []Schema GetSourceSchemas(ctx, sourceId).IncludeTypes(includeTypes).Execute()
> []Schema GetSourceSchemas(ctx, sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute()
List Schemas on Source

Expand All @@ -1325,11 +1325,12 @@ import (

func main() {
sourceId := "2c9180835d191a86015d28455b4a2329" // string | Source ID.
includeTypes := "group" // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized. (optional)
includeTypes := "group" // string | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional)
includeNames := "account" // string | A comma-separated list of schema names to filter result. (optional)

configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).Execute()
resp, r, err := apiClient.SourcesAPI.GetSourceSchemas(context.Background(), sourceId).IncludeTypes(includeTypes).IncludeNames(includeNames).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SourcesAPI.GetSourceSchemas``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
Expand All @@ -1355,7 +1356,8 @@ Other parameters are passed through a pointer to a apiGetSourceSchemasRequest st
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------

**includeTypes** | **string** | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized. |
**includeTypes** | **string** | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. |
**includeNames** | **string** | A comma-separated list of schema names to filter result. |

### Return type

Expand Down

0 comments on commit 7960108

Please sign in to comment.