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

[tcgc] continuation token feature #2206

Merged
merged 15 commits into from
Feb 18, 2025
Merged

Conversation

tadelesh
Copy link
Member

@tadelesh tadelesh commented Feb 12, 2025

  1. Add pagingMetadata.continuationTokenParameterSegments and pagingMetadata.continuationTokenResponseSegments to SdkPagingServiceMetadata to indicate the mapping of continuation token parameter and response.
  2. Deprecate __raw_paged_metadata, nextLinkPath and nextLinkOperation in SdkPagingServiceMethodOptions. Use pagingMetadata.__raw, pagingMetadata.nextLinkSegments and pagingMetadata.nextLinkOperation instead.
  3. Make SdkServiceResponseHeader to be part of SdkModelPropertyType. Then it could contain the client related info.
  4. Deprecate resultPath in SdkMethodResponse. Use resultSegments instead.
  5. Add SdkPagingServiceMetadata type to store all paging related info.

resolve: #2168
resolve: #2139
resolve: #1920
resolve: #2199

design is here

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 12, 2025

All changed packages have been documented.

  • @azure-tools/typespec-client-generator-core
Show changes

@azure-tools/typespec-client-generator-core - feature ✏️

Add pagingMetadata.continuationTokenParameterSegments and pagingMetadata.continuationTokenResponseSegments to SdkPagingServiceMetadata to indicate the mapping of continuation token parameter and response.

@azure-tools/typespec-client-generator-core - deprecation ✏️

Deprecate __raw_paged_metadata, nextLinkPath and nextLinkOperation in SdkPagingServiceMethodOptions. Use pagingMetadata.__raw, pagingMetadata.nextLinkSegments and pagingMetadata.nextLinkOperation instead.

@azure-tools/typespec-client-generator-core - feature ✏️

Make SdkServiceResponseHeader to be part of SdkModelPropertyType. Then it could contain the client related info.

@azure-tools/typespec-client-generator-core - deprecation ✏️

Deprecate resultPath in SdkMethodResponse. Use resultSegments instead.

@azure-tools/typespec-client-generator-core - feature ✏️

Add SdkPagingServiceMetadata type to store all paging related info.

@azure-tools/typespec-client-generator-core - fix ✏️

Do not allow union with circular ref, change union name inside nullable type and do not take nullable type as non-body response

@azure-tools/typespec-client-generator-core - feature ✏️

Add crossLanguageDefinitionId property for SdkNullableType.

@azure-tools/typespec-client-generator-core - deprecation ✏️

Deprecate clientNamespace property in SdkClientType, SdkNullableType, SdkEnumType, SdkUnionType and SdkModelType. Use namespace instead.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 12, 2025

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@tadelesh tadelesh changed the base branch from main to release/february-2025 February 13, 2025 08:18
Copy link
Member

@msyyc msyyc left a comment

Choose a reason for hiding this comment

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

I don't look into the implementation details but the interface changes look good to python.

@tadelesh tadelesh merged commit 88d0646 into release/february-2025 Feb 18, 2025
22 of 23 checks passed
@tadelesh tadelesh deleted the continuation_token branch February 18, 2025 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
6 participants