Skip to content

Commit 9b0621d

Browse files
SpelkingtonSpelkington
committed
docs: update built reference docs
1 parent 2b6fbd6 commit 9b0621d

130 files changed

Lines changed: 9147 additions & 331 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/reference/src/core/Flowthru.Core/Flowthru.Core.Data.ConfigSectionAttribute.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# <a id="Flowthru_Core_Data_ConfigSectionAttribute"></a> Class ConfigSectionAttribute
2+
3+
Namespace: [Flowthru.Core.Data](Flowthru.Core.Data.md)
4+
Assembly: Flowthru.Core.dll
5+
6+
Specifies the <xref href="Microsoft.Extensions.Configuration.IConfiguration" data-throw-if-not-resolved="false"></xref> section path
7+
that backs an <xref href="Flowthru.Core.Data.IItem%601" data-throw-if-not-resolved="false"></xref> property on a <xref href="Flowthru.Core.Data.FlowthruConfigAttribute" data-throw-if-not-resolved="false"></xref>-marked class.
8+
9+
```csharp
10+
[AttributeUsage(AttributeTargets.Property, Inherited = false, AllowMultiple = false)]
11+
public sealed class ConfigSectionAttribute : Attribute
12+
```
13+
14+
#### Inheritance
15+
16+
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
17+
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
18+
[ConfigSectionAttribute](Flowthru.Core.Data.ConfigSectionAttribute.md)
19+
20+
#### Inherited Members
21+
22+
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
23+
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
24+
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
25+
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
26+
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
27+
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
28+
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
29+
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
30+
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
31+
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
32+
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
33+
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
34+
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
35+
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
36+
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
37+
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
38+
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
39+
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
40+
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
41+
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
42+
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
43+
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
44+
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
45+
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
46+
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
47+
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
48+
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
49+
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
50+
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
51+
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
52+
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
53+
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
54+
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
55+
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
56+
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
57+
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
58+
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
59+
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
60+
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
61+
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
62+
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
63+
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
64+
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
65+
66+
## Remarks
67+
68+
The section path uses colon-separated segments following .NET configuration conventions
69+
(e.g. <code>Flowthru:Flows:DataScience:ModelOptions</code>).
70+
71+
## Constructors
72+
73+
### <a id="Flowthru_Core_Data_ConfigSectionAttribute__ctor_System_String_"></a> ConfigSectionAttribute\(string\)
74+
75+
```csharp
76+
public ConfigSectionAttribute(string sectionPath)
77+
```
78+
79+
#### Parameters
80+
81+
`sectionPath` [string](https://learn.microsoft.com/dotnet/api/system.string)
82+
83+
Colon-separated configuration section path.
84+
85+
## Properties
86+
87+
### <a id="Flowthru_Core_Data_ConfigSectionAttribute_SectionPath"></a> SectionPath
88+
89+
Gets the colon-separated configuration section path.
90+
91+
```csharp
92+
public string SectionPath { get; }
93+
```
94+
95+
#### Property Value
96+
97+
[string](https://learn.microsoft.com/dotnet/api/system.string)
98+

‎docs/reference/src/core/Flowthru.Core/Flowthru.Core.Data.EnumerableItemFactory.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ register new formats.
4444

4545
## Methods
4646

47-
### <a id="Flowthru_Core_Data_EnumerableItemFactory_Json__1_System_String_System_String_"></a> Json<TRow\>\(string, string\)
47+
### <a id="Flowthru_Core_Data_EnumerableItemFactory_Json__1_System_String_System_String_Flowthru_Core_Data_Storage_IStorageMediumResolver_Flowthru_Core_Data_Storage_IStorageMedium_"></a> Json<TRow\>\(string, string, IStorageMediumResolver?, IStorageMedium?\)
4848

4949
Creates a JSON file catalog item with IEnumerable container for collections.
5050

5151
```csharp
52-
public Item<IEnumerable<TRow>> Json<TRow>(string label, string filePath) where TRow : notnull, IStructuredSerializable
52+
public Item<IEnumerable<TRow>> Json<TRow>(string label, string filePath, IStorageMediumResolver? resolver = null, IStorageMedium? medium = null) where TRow : notnull, IStructuredSerializable
5353
```
5454

5555
#### Parameters
@@ -60,7 +60,17 @@ Unique catalog label for DAG resolution
6060

6161
`filePath` [string](https://learn.microsoft.com/dotnet/api/system.string)
6262

63-
Path to JSON file
63+
Path or URI to JSON file
64+
65+
`resolver` [IStorageMediumResolver](Flowthru.Core.Data.Storage.IStorageMediumResolver.md)?
66+
67+
Optional resolver for remote URIs (e.g., <code>https://</code>, <code>sftp://</code>).
68+
Falls back to <xref href="Flowthru.Core.Data.Storage.Medium.FileStorageMedium" data-throw-if-not-resolved="false"></xref> when <code>null</code>.
69+
70+
`medium` [IStorageMedium](Flowthru.Core.Data.Storage.IStorageMedium.md)?
71+
72+
Explicit medium override. Takes precedence over <code class="paramref">resolver</code> when both
73+
are supplied. Use for per-entry customisation or direct injection in tests.
6474

6575
#### Returns
6676

0 commit comments

Comments
 (0)