Skip to content

Commit 34acb99

Browse files
Copilotswathipil
andcommitted
Update CLIENT_DEVELOPER.md: simplify code structure section and remove REST API link
Co-authored-by: swathipil <[email protected]>
1 parent 8dca936 commit 34acb99

File tree

1 file changed

+4
-23
lines changed

1 file changed

+4
-23
lines changed

sdk/schemaregistry/azure-schemaregistry/CLIENT_DEVELOPER.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -62,39 +62,21 @@ The Azure Schema Registry client library follows a hybrid approach with both gen
6262

6363
### Generated Code
6464

65-
The following files are automatically generated from TypeSpec and should **not** be manually edited:
66-
- `_client.py` - Main client implementation
67-
- `_configuration.py` - Client configuration
68-
- `_model_base.py` - Base classes for models
69-
- `_operations/` - Generated operation classes
70-
- `_serialization.py` - Serialization utilities
71-
- `_vendor.py` - Vendored dependencies
72-
- `models/*.py` (except `_patch.py`) - Data models
73-
- `aio/_client.py` - Async client implementation
74-
- `aio/_configuration.py` - Async client configuration
65+
All files under `azure/` are automatically generated from TypeSpec and should **not** be manually edited, except for the handwritten code described below.
7566

7667
### Handwritten Code
7768

78-
The following files contain handwritten customizations and extensions:
69+
The following contain handwritten customizations and extensions:
7970

8071
#### `_patch.py` Files
81-
- `azure/schemaregistry/_patch.py` - Sync client customizations
82-
- `azure/schemaregistry/aio/_patch.py` - Async client customizations
83-
- `azure/schemaregistry/models/_patch.py` - Model customizations
84-
85-
These files allow you to:
72+
Any files with the name `_patch.py` contain handwritten code that allows you to:
8673
- Add custom methods to generated classes
8774
- Override generated method implementations
8875
- Add custom models and enums
8976
- Extend functionality while preserving generated code
9077

9178
#### Encoder Implementation
92-
- `azure/schemaregistry/encoder/jsonencoder/` - Complete handwritten JSON Schema encoder implementation
93-
- `_json_encoder.py` - Main encoder/decoder logic
94-
- `_exceptions.py` - Custom exceptions
95-
- `__init__.py` - Public API
96-
97-
The encoder directory contains entirely handwritten code that provides schema-based encoding and decoding capabilities using the Schema Registry client.
79+
All files under `encoder/jsonencoder/` contain handwritten code that provides schema-based encoding and decoding capabilities using the Schema Registry client.
9880

9981
### Code Customization Guidelines
10082

@@ -254,5 +236,4 @@ For detailed performance testing setup and resource requirements, see the [Perfo
254236
- [Azure SDK Design Guidelines](https://azure.github.io/azure-sdk/python_design.html)
255237
- [TypeSpec Documentation](https://typespec.io/)
256238
- [Schema Registry Samples](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/schemaregistry/azure-schemaregistry/samples)
257-
- [Azure Schema Registry REST API Reference](https://docs.microsoft.com/rest/api/schemaregistry/)
258239
- [Event Hubs and Schema Registry Quickstart](https://learn.microsoft.com/azure/event-hubs/create-schema-registry)

0 commit comments

Comments
 (0)