Skip to content

Commit 26fd515

Browse files
committed
Removed examples
Removed examples using sub clients directly
1 parent dc51e9d commit 26fd515

File tree

3 files changed

+5
-90
lines changed

3 files changed

+5
-90
lines changed

README.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,6 @@ python examples/search_examples.py
8181
- **[Master Client Usage](examples/master_client_usage.py)** - Master client with all APIs examples
8282
- **[Individual API Examples](examples/)** - Authentication, Core, Discovery, Search, Workflow, Model, Search SQL examples
8383

84-
### ⚠️ **IMPORTANT: Generated Examples Warning**
85-
86-
**🚫 DO NOT USE** the individual client examples in `enhanced_generated/clients/*/examples/`:
87-
-`enhanced_generated/clients/alfresco-auth/examples/`
88-
-`enhanced_generated/clients/alfresco-core/examples/`
89-
-`enhanced_generated/clients/alfresco-discovery/examples/`
90-
-`enhanced_generated/clients/alfresco-search/examples/`
91-
-`enhanced_generated/clients/alfresco-workflow/examples/`
92-
-`enhanced_generated/clients/alfresco-model/examples/`
93-
-`enhanced_generated/clients/alfresco-search-sql/examples/`
94-
95-
**Why?** These are **auto-generated by openapi-generator-cli** for standalone clients, but this project uses the **master client architecture**. They will fail with import errors.
96-
97-
**✅ Use instead:** The curated examples in the main `examples/` directory, which are designed for the master client approach.
9884

9985
## 📄 OpenAPI Specifications Source
10086

@@ -128,8 +114,7 @@ python-alfresco-api/
128114
│ ├── alfresco-search/ # Search API
129115
│ ├── alfresco-workflow/ # Workflow API
130116
│ ├── alfresco-model/ # Model API
131-
│ ├── alfresco-search-sql/ # Search SQL API
132-
│ └── examples/ # Enhanced client examples
117+
│ └── alfresco-search-sql/ # Search SQL API
133118
├── examples/ # 📖 Working Examples
134119
│ ├── master_client_examples.py # Master client usage
135120
│ ├── master_client_usage.py # Master client examples
@@ -301,12 +286,12 @@ Located in `enhanced_generated/clients/` - these provide the best experience:
301286
|-----|-------------------------------|---------|---------|
302287
| **Master Client** | [AlfrescoClient](enhanced_generated/AlfrescoClient.py) | Unified access to all 7 APIs | ✅ Working |
303288
| **Authentication** | [Auth Client README](enhanced_generated/clients/alfresco-auth/README.md) | User authentication & tickets | ✅ Working |
304-
| **Core** | [Core Client README](enhanced_generated/clients/alfresco-core/README.md) | Nodes, sites, people, groups | 🚧 Actions API working |
289+
| **Core** | [Core Client README](enhanced_generated/clients/alfresco-core/README.md) | Nodes, sites, people, groups | ✅ Working |
305290
| **Discovery** | [Discovery Client README](enhanced_generated/clients/alfresco-discovery/README.md) | Repository information | ✅ Working |
306291
| **Search** | [Search Client README](enhanced_generated/clients/alfresco-search/README.md) | Content search (AFTS/CMIS) | ✅ Working |
307-
| **Workflow** | [Workflow Client README](enhanced_generated/clients/alfresco-workflow/README.md) | Process & task management |Generated |
308-
| **Model** | [Model Client README](enhanced_generated/clients/alfresco-model/README.md) | Content models & types |Generated |
309-
| **Search SQL** | [Search SQL Client README](enhanced_generated/clients/alfresco-search-sql/README.md) | SQL-based search |Generated |
292+
| **Workflow** | [Workflow Client README](enhanced_generated/clients/alfresco-workflow/README.md) | Process & task management |Working |
293+
| **Model** | [Model Client README](enhanced_generated/clients/alfresco-model/README.md) | Content models & types |Working |
294+
| **Search SQL** | [Search SQL Client README](enhanced_generated/clients/alfresco-search-sql/README.md) | SQL-based search |Working |
310295

311296
## 🌟 Key Features
312297

docs/DOCUMENTATION_SUMMARY.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,6 @@ Located in `enhanced_generated/clients/` - All have comprehensive documentation:
8989
| **alfresco-model** | ✅ Complete | ✅ Available | ✅ Full docs | Content models/types |
9090
| **alfresco-search-sql** | ✅ Complete | ✅ Available | ✅ Full docs | SQL-based search |
9191

92-
### Legacy Generated Clients
93-
**Note**: The legacy `alfresco_client/` directory has been removed from the project. All functionality is now provided through the enhanced generated clients in `enhanced_generated/clients/`.
94-
9592
## 🎯 Documentation Features
9693

9794
### Comprehensive Coverage

enhanced_generated/clients/examples/README.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)