You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "erickguan (via GitHub)" <gi...@apache.org> on 2025/05/11 19:14:56 UTC
[PR] dev: extract service config structs' identifier [opendal]
erickguan opened a new pull request, #6170:
URL: https://github.com/apache/opendal/pull/6170
# Which issue does this PR close?
Originated from https://github.com/apache/opendal/pull/5457#discussion_r1897695599.
Also for generating service pages in bindings. e.g., Python. Something like this:
# Rationale for this change
This enables code generation to generate config class type hints. This will enable getting symbols such as `S3Config`:
```python
class S3Config(TypedDict):
bucket: str
...
```
# Core services documentation organization
I noticed services have duplicated documentation, for example:
- S3: https://docs.rs/opendal/latest/opendal/services/struct.S3.html
- S3Config: https://docs.rs/opendal/latest/opendal/services/struct.S3Config.html
Is there a general direction where OpenDAL maintains configuration documentation? I could see a binding is interested in:
1. Service introduction, e.g., "Aws S3 and compatible services (including minio, digitalocean ..."
3. Service configuration fields, e.g., S3Config's fields
3. Service configuration documentation, e.g. "Temporary security credentials" in S3
A Rust service documentation will include:
1. Service introduction
2. Service capabilities
3. Service configuration fields, e.g., S3Config's fields
5. Service configuration documentation, e.g. "Temporary security credentials" in S3
6. Examples, e.g. examples with builders
Happy to put this in another discussion.
# Are there any user-facing changes?
No
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] dev: extract service config structs' identifier [opendal]
Posted by "erickguan (via GitHub)" <gi...@apache.org>.
erickguan commented on PR #6170:
URL: https://github.com/apache/opendal/pull/6170#issuecomment-2872284027
@Xuanwo Hi! Is this the direction for core's service documentation? If so, I will continue with this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] dev: extract service config structs' identifier [opendal]
Posted by "erickguan (via GitHub)" <gi...@apache.org>.
erickguan closed pull request #6170: dev: extract service config structs' identifier
URL: https://github.com/apache/opendal/pull/6170
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] dev: extract service config structs' identifier [opendal]
Posted by "erickguan (via GitHub)" <gi...@apache.org>.
erickguan commented on PR #6170:
URL: https://github.com/apache/opendal/pull/6170#issuecomment-2872663102
Sure!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] dev: extract service config structs' identifier [opendal]
Posted by "Xuanwo (via GitHub)" <gi...@apache.org>.
Xuanwo commented on PR #6170:
URL: https://github.com/apache/opendal/pull/6170#issuecomment-2872295205
I feel that we don't need to parse ident of `S3Config` since all opendal's serivces name follow the same pattern:
- abc_def
- AbdDef
So we can safely use `{scheme.to_pascal_case()}Config` if we want `S3Config`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org