Compare commits
2 Commits
b6b9ffc050
...
dc7c75b496
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dc7c75b496 | ||
|
|
967ae0ab16 |
9
concelier-webservice.slnf
Normal file
9
concelier-webservice.slnf
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"solution": {
|
||||
"path": "src/Concelier/StellaOps.Concelier.sln",
|
||||
"projects": [
|
||||
"StellaOps.Concelier.WebService/StellaOps.Concelier.WebService.csproj",
|
||||
"__Tests/StellaOps.Concelier.WebService.Tests/StellaOps.Concelier.WebService.Tests.csproj"
|
||||
]
|
||||
}
|
||||
}
|
||||
@@ -1,126 +1,371 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: StellaOps Graph Gateway (draft)
|
||||
version: 0.0.1-draft
|
||||
version: 0.0.2-pre
|
||||
description: |
|
||||
Draft API surface for graph search/query/paths/diff/export with streaming tiles,
|
||||
cost budgets, overlays, and RBAC headers. Aligns with sprint 0207 Wave 1 outline
|
||||
(GRAPH-API-28-001..011).
|
||||
servers:
|
||||
- url: https://gateway.local/api
|
||||
security:
|
||||
- bearerAuth: []
|
||||
|
||||
paths:
|
||||
/graph/versions:
|
||||
get:
|
||||
summary: List graph schema versions
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
versions:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
/graph/viewport:
|
||||
get:
|
||||
summary: Stream viewport tiles
|
||||
/graph/search:
|
||||
post:
|
||||
summary: Search graph nodes with prefix/exact semantics and filters
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: bbox
|
||||
in: query
|
||||
- $ref: '#/components/parameters/TenantHeader'
|
||||
- $ref: '#/components/parameters/RequestIdHeader'
|
||||
requestBody:
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: zoom
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
- name: version
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Stream of tiles
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
tiles:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
/graph/path:
|
||||
get:
|
||||
summary: Fetch path between nodes
|
||||
$ref: '#/components/schemas/SearchRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Stream of search tiles (NDJSON)
|
||||
content:
|
||||
application/x-ndjson:
|
||||
schema:
|
||||
$ref: '#/components/schemas/TileEnvelope'
|
||||
'400': { $ref: '#/components/responses/ValidationError' }
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'429': { $ref: '#/components/responses/BudgetExceeded' }
|
||||
|
||||
/graph/query:
|
||||
post:
|
||||
summary: Execute graph query with budgeted streaming tiles
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: from
|
||||
in: query
|
||||
- $ref: '#/components/parameters/TenantHeader'
|
||||
- $ref: '#/components/parameters/RequestIdHeader'
|
||||
requestBody:
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: to
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
edges:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
$ref: '#/components/schemas/QueryRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Stream of query tiles (NDJSON)
|
||||
content:
|
||||
application/x-ndjson:
|
||||
schema:
|
||||
$ref: '#/components/schemas/TileEnvelope'
|
||||
'400': { $ref: '#/components/responses/ValidationError' }
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'429': { $ref: '#/components/responses/BudgetExceeded' }
|
||||
|
||||
/graph/paths:
|
||||
post:
|
||||
summary: Find constrained paths between node sets (depth ≤ 6)
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TenantHeader'
|
||||
- $ref: '#/components/parameters/RequestIdHeader'
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PathsRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Stream of path tiles ordered by hop
|
||||
content:
|
||||
application/x-ndjson:
|
||||
schema:
|
||||
$ref: '#/components/schemas/TileEnvelope'
|
||||
'400': { $ref: '#/components/responses/ValidationError' }
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
'429': { $ref: '#/components/responses/BudgetExceeded' }
|
||||
|
||||
/graph/diff:
|
||||
get:
|
||||
summary: Diff two snapshots
|
||||
post:
|
||||
summary: Stream diff between two graph snapshots with overlay deltas
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: left
|
||||
in: query
|
||||
- $ref: '#/components/parameters/TenantHeader'
|
||||
- $ref: '#/components/parameters/RequestIdHeader'
|
||||
requestBody:
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: right
|
||||
in: query
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
$ref: '#/components/schemas/DiffRequest'
|
||||
responses:
|
||||
'200':
|
||||
description: Stream of diff tiles (added/removed/changed)
|
||||
content:
|
||||
application/x-ndjson:
|
||||
schema:
|
||||
$ref: '#/components/schemas/TileEnvelope'
|
||||
'400': { $ref: '#/components/responses/ValidationError' }
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
|
||||
/graph/export:
|
||||
get:
|
||||
summary: Export graph fragment
|
||||
post:
|
||||
summary: Request export job for snapshot or query result
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- name: snapshot
|
||||
in: query
|
||||
- $ref: '#/components/parameters/TenantHeader'
|
||||
- $ref: '#/components/parameters/RequestIdHeader'
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ExportRequest'
|
||||
responses:
|
||||
'202':
|
||||
description: Export job accepted
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ExportJob'
|
||||
'400': { $ref: '#/components/responses/ValidationError' }
|
||||
'401': { $ref: '#/components/responses/Unauthorized' }
|
||||
|
||||
/graph/export/{jobId}:
|
||||
get:
|
||||
summary: Check export job status or download manifest
|
||||
security:
|
||||
- bearerAuth: []
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/TenantHeader'
|
||||
- $ref: '#/components/parameters/RequestIdHeader'
|
||||
- name: jobId
|
||||
in: path
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: format
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
enum: [graphml, jsonl]
|
||||
responses:
|
||||
'200':
|
||||
description: Streamed export
|
||||
description: Job status
|
||||
content:
|
||||
application/octet-stream:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
$ref: '#/components/schemas/ExportJob'
|
||||
'404':
|
||||
description: Job not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerAuth:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
|
||||
parameters:
|
||||
TenantHeader:
|
||||
name: X-Stella-Tenant
|
||||
in: header
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: Tenant identifier enforced on all routes.
|
||||
RequestIdHeader:
|
||||
name: X-Request-Id
|
||||
in: header
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
description: Optional caller-provided correlation id, echoed in responses.
|
||||
|
||||
schemas:
|
||||
CostBudget:
|
||||
type: object
|
||||
properties:
|
||||
limit:
|
||||
type: integer
|
||||
minimum: 1
|
||||
remaining:
|
||||
type: integer
|
||||
minimum: 0
|
||||
consumed:
|
||||
type: integer
|
||||
minimum: 0
|
||||
required: [limit, remaining, consumed]
|
||||
|
||||
TileEnvelope:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
enum: [node, edge, stats, cursor, diagnostic]
|
||||
seq:
|
||||
type: integer
|
||||
minimum: 0
|
||||
cost:
|
||||
$ref: '#/components/schemas/CostBudget'
|
||||
data:
|
||||
type: object
|
||||
description: Payload varies by tile type (node/edge record, stats snapshot, cursor token, or diagnostic info).
|
||||
required: [type, seq]
|
||||
|
||||
SearchRequest:
|
||||
type: object
|
||||
properties:
|
||||
query:
|
||||
type: string
|
||||
description: Prefix or exact text; required unless filters present.
|
||||
kinds:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
limit:
|
||||
type: integer
|
||||
default: 50
|
||||
maximum: 500
|
||||
filters:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
ordering:
|
||||
type: string
|
||||
enum: [relevance, id]
|
||||
required: [kinds]
|
||||
|
||||
QueryRequest:
|
||||
type: object
|
||||
properties:
|
||||
dsl:
|
||||
type: string
|
||||
description: DSL expression for graph traversal (mutually exclusive with filter).
|
||||
filter:
|
||||
type: object
|
||||
description: Structured filter alternative to DSL.
|
||||
budget:
|
||||
type: object
|
||||
properties:
|
||||
nodeCap: { type: integer }
|
||||
edgeCap: { type: integer }
|
||||
timeMs: { type: integer }
|
||||
overlays:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
enum: [policy, vex, advisory]
|
||||
explain:
|
||||
type: string
|
||||
enum: [none, minimal, full]
|
||||
default: none
|
||||
anyOf:
|
||||
- required: [dsl]
|
||||
- required: [filter]
|
||||
|
||||
PathsRequest:
|
||||
type: object
|
||||
properties:
|
||||
sourceIds:
|
||||
type: array
|
||||
items: { type: string }
|
||||
minItems: 1
|
||||
targetIds:
|
||||
type: array
|
||||
items: { type: string }
|
||||
minItems: 1
|
||||
maxDepth:
|
||||
type: integer
|
||||
maximum: 6
|
||||
default: 4
|
||||
constraints:
|
||||
type: object
|
||||
properties:
|
||||
edgeKinds:
|
||||
type: array
|
||||
items: { type: string }
|
||||
fanoutCap:
|
||||
type: integer
|
||||
overlays:
|
||||
type: array
|
||||
items: { type: string }
|
||||
required: [sourceIds, targetIds]
|
||||
|
||||
DiffRequest:
|
||||
type: object
|
||||
properties:
|
||||
snapshotA: { type: string }
|
||||
snapshotB: { type: string }
|
||||
filters:
|
||||
type: object
|
||||
additionalProperties: true
|
||||
required: [snapshotA, snapshotB]
|
||||
|
||||
ExportRequest:
|
||||
type: object
|
||||
properties:
|
||||
snapshotId:
|
||||
type: string
|
||||
queryRef:
|
||||
type: string
|
||||
formats:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
enum: [graphml, csv, ndjson, png, svg]
|
||||
includeOverlays:
|
||||
type: boolean
|
||||
default: false
|
||||
anyOf:
|
||||
- required: [snapshotId]
|
||||
- required: [queryRef]
|
||||
required: [formats]
|
||||
|
||||
ExportJob:
|
||||
type: object
|
||||
properties:
|
||||
jobId: { type: string }
|
||||
status: { type: string, enum: [pending, running, succeeded, failed] }
|
||||
checksumManifestUrl: { type: string, format: uri }
|
||||
downloadUrl: { type: string, format: uri }
|
||||
createdAt: { type: string, format: date-time }
|
||||
updatedAt: { type: string, format: date-time }
|
||||
message: { type: string }
|
||||
required: [jobId, status]
|
||||
|
||||
Error:
|
||||
type: object
|
||||
properties:
|
||||
error:
|
||||
type: string
|
||||
enum: [GRAPH_BUDGET_EXCEEDED, GRAPH_VALIDATION_FAILED, GRAPH_RATE_LIMITED, GRAPH_UNAUTHORIZED]
|
||||
message:
|
||||
type: string
|
||||
details:
|
||||
type: object
|
||||
request_id:
|
||||
type: string
|
||||
required: [error, message]
|
||||
|
||||
responses:
|
||||
ValidationError:
|
||||
description: Request failed validation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
Unauthorized:
|
||||
description: Missing or invalid credentials
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
BudgetExceeded:
|
||||
description: Budget exhausted mid-stream; includes partial cursor details
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Error'
|
||||
|
||||
@@ -137,4 +137,4 @@ Automate collection via `Makefile` or `bench/run.sh` pipeline (task `BENCH-AUTO-
|
||||
- `BENCH-AUTO-401-019` — automation to populate `bench/findings/**`, run baseline scanners, and update `results/summary.csv`.
|
||||
- `DOCS-VEX-401-012` — maintain this playbook + README templates, document verification workflow.
|
||||
|
||||
Update `docs/implplan/SPRINT_401_reachability_evidence_chain.md` whenever these tasks move state.
|
||||
Update `docs/implplan/SPRINT_0401_0001_0001_reachability_evidence_chain.md` whenever these tasks move state.
|
||||
|
||||
@@ -69,6 +69,8 @@
|
||||
| 2025-11-22 | Retried restore with absolute `NUGET_PACKAGES=$(pwd)/local-nugets`; still hanging and cancelled at ~10s (no packages downloaded). Tests remain blocked pending CI/warm cache. | Implementer |
|
||||
| 2025-11-22 | Restore attempt with absolute cache + nuget.org fallback (`NUGET_PACKAGES=/mnt/e/dev/git.stella-ops.org/local-nugets --source local-nugets --source https://api.nuget.org/v3/index.json`) still stalled/cancelled after ~10s; no packages pulled. | Implementer |
|
||||
| 2025-11-22 | Normalized `tools/linksets-ci.sh` line endings, removed `--no-build`, and forced offline restore against `local-nugets`; restore still hangs >90s even with offline cache, run terminated. BUILD-TOOLING-110-001 remains BLOCKED pending runner with usable restore cache. | Implementer |
|
||||
| 2025-11-22 | Tried seeding `local-nugets` via `dotnet restore --packages local-nugets` (online allowed); restore spinner stalled ~130s and was cancelled; NuGet targets reported “Restore canceled!”. No TRX produced; BUILD-TOOLING-110-001 still BLOCKED—needs CI runner with warm cache or diagnostic restore to pinpoint stuck feed/package. | Implementer |
|
||||
| 2025-11-22 | Retried restore with dedicated cache `NUGET_PACKAGES=.nuget-cache`, sources `local-nugets` + nuget.org, `--disable-parallel --ignore-failed-sources`; spinner ran ~10s with no progress, cancelled. Still no TRX; BUILD-TOOLING-110-001 remains BLOCKED pending CI runner or verbose restore on cached agent. | Implementer |
|
||||
| 2025-11-22 | Documented Concelier advisory attestation endpoint parameters and safety rules (`docs/modules/concelier/attestation.md`); linked from module architecture. | Implementer |
|
||||
| 2025-11-22 | Published Excititor air-gap + connector trust prep (`docs/modules/excititor/prep/2025-11-22-airgap-56-58-prep.md`), defining import envelope, error catalog, timeline hooks, and signer validation; marked EXCITITOR-AIRGAP-56/57/58 · CONN-TRUST-01-001 DONE. | Implementer |
|
||||
| 2025-11-20 | Completed PREP-FEEDCONN-ICSCISA-02-012-KISA-02-008-FEED: published remediation schedule + hashes at `docs/modules/concelier/prep/2025-11-20-feeds-icscisa-kisa-prep.md`; status set to DONE. | Implementer |
|
||||
|
||||
@@ -26,12 +26,12 @@
|
||||
| P2 | PREP-CONCELIER-LNM-21-002-WAITING-ON-FINALIZE | DONE (2025-11-20) | Due 2025-11-21 · Accountable: Concelier Core Guild · Data Science Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Concelier Core Guild · Data Science Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Correlation rules + fixtures published at `docs/modules/concelier/linkset-correlation-21-002.md` with samples under `docs/samples/lnm/`. Downstream linkset builder can proceed. |
|
||||
| 1 | CONCELIER-GRAPH-21-001 | DONE | LNM sample fixtures with scopes/relationships added; observation/linkset query tests passing | Concelier Core Guild · Cartographer Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Extend SBOM normalization so relationships/scopes are stored as raw observation metadata with provenance pointers for graph joins. |
|
||||
| 2 | CONCELIER-GRAPH-21-002 | DONE (2025-11-22) | PREP-CONCELIER-GRAPH-21-002-PLATFORM-EVENTS-S | Concelier Core Guild · Scheduler Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Publish `sbom.observation.updated` events with tenant/context and advisory refs; facts only, no judgments. |
|
||||
| 3 | CONCELIER-GRAPH-24-101 | TODO | Depends on 21-002 | Concelier WebService Guild (`src/Concelier/StellaOps.Concelier.WebService`) | `/advisories/summary` bundles observation/linkset metadata (aliases, confidence, conflicts) for graph overlays; upstream values intact. |
|
||||
| 3 | CONCELIER-GRAPH-24-101 | BLOCKED | Depends on 21-002 | Concelier WebService Guild (`src/Concelier/StellaOps.Concelier.WebService`) | `/advisories/summary` bundles observation/linkset metadata (aliases, confidence, conflicts) for graph overlays; upstream values intact. |
|
||||
| 4 | CONCELIER-GRAPH-28-102 | TODO | Depends on 24-101 | Concelier WebService Guild (`src/Concelier/StellaOps.Concelier.WebService`) | Evidence batch endpoints keyed by component sets with provenance/timestamps; no derived severity. |
|
||||
| 5 | CONCELIER-LNM-21-001 | DONE | Start of Link-Not-Merge chain | Concelier Core Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Define immutable `advisory_observations` model (per-source fields, version ranges, severity text, provenance metadata, tenant guards). |
|
||||
| 6 | CONCELIER-LNM-21-002 | DONE (2025-11-22) | PREP-CONCELIER-LNM-21-002-WAITING-ON-FINALIZE | Concelier Core Guild · Data Science Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Correlation pipelines output linksets with confidence + conflict markers, avoiding value collapse. |
|
||||
| 7 | CONCELIER-LNM-21-003 | DONE (2025-11-22) | Depends on 21-002 | Concelier Core Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Record disagreements (severity, CVSS, references) as structured conflict entries. |
|
||||
| 8 | CONCELIER-LNM-21-004 | TODO | Depends on 21-003 | Concelier Core Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Remove legacy merge/dedup logic; add guardrails/tests to keep ingestion append-only; document linkset supersession. |
|
||||
| 8 | CONCELIER-LNM-21-004 | BLOCKED | Depends on 21-003 | Concelier Core Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Remove legacy merge/dedup logic; add guardrails/tests to keep ingestion append-only; document linkset supersession. |
|
||||
| 9 | CONCELIER-LNM-21-005 | TODO | Depends on 21-004 | Concelier Core Guild · Platform Events Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Core`) | Emit `advisory.linkset.updated` events with delta descriptions + observation ids (tenant + provenance only). |
|
||||
| 10 | CONCELIER-LNM-21-101 | TODO | Depends on 21-005 | Concelier Storage Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Storage.Mongo`) | Provision Mongo collections (`advisory_observations`, `advisory_linksets`) with hashed shard keys, tenant indexes, TTL for ingest metadata. |
|
||||
| 11 | CONCELIER-LNM-21-102 | TODO | Depends on 21-101 | Concelier Storage Guild · DevOps Guild (`src/Concelier/__Libraries/StellaOps.Concelier.Storage.Mongo`) | Backfill legacy merged advisories; seed tombstones; provide rollback tooling for Offline Kit. |
|
||||
@@ -55,6 +55,7 @@
|
||||
| 2025-11-22 | Added LinksetCorrelation helper + updated aggregation to emit confidence/conflicts per LNM-21-002; unit tests added. Targeted `dotnet test ...AdvisoryObservationAggregationTests` failed locally (`invalid test source` vstest issue); requires CI/warmed runner. | Concelier Core |
|
||||
| 2025-11-22 | Added conflict sourceIds propagation to storage documents and mapping; updated storage tests accordingly. `dotnet test ...Concelier.Storage.Mongo.Tests` still fails locally with same vstest argument issue; needs CI runner. | Concelier Core |
|
||||
| 2025-11-22 | Tried `dotnet build src/Concelier/__Libraries/StellaOps.Concelier.Core/StellaOps.Concelier.Core.csproj`; build appears to hang after restore on local harness—no errors emitted; will defer to CI runner to avoid churn. | Concelier Core |
|
||||
| 2025-11-22 | Local `dotnet build` for Storage.Mongo also hangs post-restore; CI/clean runner required to validate LNM-21-002 changes. | Concelier Core |
|
||||
| 2025-11-22 | Fixed nullable handling in `LinksetCorrelation` purl aggregation; built Concelier dependencies and ran `AdvisoryObservationTransportWorkerTests` (pass) on warmed cache. | Implementer |
|
||||
| 2025-11-22 | Marked CONCELIER-LNM-21-002 DONE: correlation now emits confidence/conflicts deterministically; transport worker test green after nullable fixes and immutable summaries. | Implementer |
|
||||
| 2025-11-22 | Implemented LNM-21-003: severity/CVSS disagreements now produce structured conflicts (reason codes `severity-mismatch`, `cvss-mismatch`); added regression test. | Implementer |
|
||||
@@ -87,6 +88,9 @@
|
||||
- Outbox added with `publishedAt` marker for observation events; transport layer still required—risk of backlog growth until scheduler picks up publisher role.
|
||||
- Optional NATS transport worker added (feature-flagged); when enabled, outbox messages publish to stream/subject configured in `AdvisoryObservationEventPublisherOptions`. Ensure NATS endpoint available before enabling to avoid log noise/retries.
|
||||
- Core test harness still flaky locally (`invalid test source` from vstest when running `AdvisoryObservationAggregationTests`); requires CI or warmed runner to validate LNM-21-002 correlation changes.
|
||||
- Storage build/tests (Concelier.Storage.Mongo) also blocked on local runner (`invalid test source` / build hang). CI validation required before progressing to LNM-21-003.
|
||||
- CONCELIER-LNM-21-004 BLOCKED: removing canonical merge/dedup requires architect decision on retiring `CanonicalMerger` consumers (graph overlays, console summaries) and a migration/rollback plan; proceed after design sign-off.
|
||||
- CONCELIER-GRAPH-24-101 BLOCKED: needs API contract for `/advisories/summary` (payload shape, pagination, filters) and alignment with graph overlay consumers; awaiting WebService/API design sign-off.
|
||||
|
||||
## Next Checkpoints
|
||||
- Next LNM schema review: align with CARTO-GRAPH/LNM owners (date TBD); unblock tasks 1–2 and 5–15.
|
||||
|
||||
@@ -36,12 +36,12 @@
|
||||
| 10 | EXCITITOR-ATTEST-73-002 | DONE (2025-11-17) | Implemented linkage API. | Excititor Core Guild | Provide APIs linking attestation IDs back to observation/linkset/product tuples for provenance citations without derived verdicts. |
|
||||
| 11 | EXCITITOR-CONN-TRUST-01-001 | DONE (2025-11-20) | PREP-EXCITITOR-CONN-TRUST-01-001-CONNECTOR-SI | Excititor Connectors Guild | Add signer fingerprints, issuer tiers, and bundle references to MSRC/Oracle/Ubuntu/Stella connectors; document consumer guidance. |
|
||||
| 12 | EXCITITOR-AIRGAP-56-001 | DOING (2025-11-22) | Mirror bundle schema from Export Center; fix `VexLinksetObservationRefCore` reference before build green. | Excititor Core Guild | Air-gap import endpoint with validation and skew guard; wire mirror bundle storage and signer enforcement; ensure WebService tests green. |
|
||||
| 13 | EXCITITOR-AIRGAP-57-001 | TODO | Sealed-mode toggle + error catalog; waits on 56-001 wiring and Export Center manifest. | Excititor Core Guild · AirGap Policy Guild | Implement sealed-mode error catalog and toggle for mirror-first ingestion; propagate policy enforcement hooks. |
|
||||
| 14 | EXCITITOR-AIRGAP-58-001 | TODO | Portable EvidenceLocker format + bundle manifest from Export Center; depends on 56-001 storage layout. | Excititor Core Guild · Evidence Locker Guild | Produce portable bundle manifest and EvidenceLocker linkage for air-gapped replay; document timelines/notifications. |
|
||||
| 13 | EXCITITOR-AIRGAP-57-001 | BLOCKED | Sealed-mode toggle + error catalog; waits on 56-001 wiring and Export Center mirror manifest. | Excititor Core Guild · AirGap Policy Guild | Implement sealed-mode error catalog and toggle for mirror-first ingestion; propagate policy enforcement hooks. |
|
||||
| 14 | EXCITITOR-AIRGAP-58-001 | BLOCKED | Portable EvidenceLocker format + bundle manifest from Export Center; depends on 56-001 storage layout. | Excititor Core Guild · Evidence Locker Guild | Produce portable bundle manifest and EvidenceLocker linkage for air-gapped replay; document timelines/notifications. |
|
||||
|
||||
### Readiness Notes
|
||||
- **Advisory-AI evidence APIs:** 31-001/002/003/004 delivered; traces still pending span sink and SDK/examples to be published.
|
||||
- **AirGap ingestion & portable bundles:** 56/57/58 now tracked (56 DOING; 57/58 TODO) and remain gated on Export Center mirror schema + EvidenceLocker portable format.
|
||||
- **AirGap ingestion & portable bundles:** 56 DOING; 57/58 BLOCKED pending Export Center mirror schema and EvidenceLocker portable format drops.
|
||||
- **Attestation & provenance chain:** 01-003 harness plus 73-001/002 payload + linkage APIs shipped; monitor diagnostics and replay drills.
|
||||
- **Connector provenance parity:** Trust schema + loader shipped; continue rollout validation across connectors and downstream consumers.
|
||||
|
||||
@@ -50,8 +50,8 @@
|
||||
| --- | --- | --- | --- | --- |
|
||||
| Advisory-AI APIs | Publish finalized OpenAPI schema + SDK notes for projection API (31-004). | Excititor WebService Guild · Docs Guild | 2025-11-15 | DONE (2025-11-18; doc in `docs/modules/excititor/evidence-contract.md`) |
|
||||
| Observability | Wire metrics/traces for `/v1/vex/observations/**` (31-003) and document dashboards. | Excititor WebService Guild · Observability Guild | 2025-11-16 | PARTIAL (metrics/logs delivered 2025-11-17; traces await span sink) |
|
||||
| AirGap | Capture mirror bundle schema + sealed-mode toggle requirements for 56/57. | Excititor Core Guild · AirGap Policy Guild | 2025-11-17 | TODO (blocked on Export Center manifest) |
|
||||
| Portable bundles | Draft bundle manifest + EvidenceLocker linkage notes for 58-001. | Excititor Core Guild · Evidence Locker Guild | 2025-11-18 | TODO |
|
||||
| AirGap | Capture mirror bundle schema + sealed-mode toggle requirements for 56/57. | Excititor Core Guild · AirGap Policy Guild | 2025-11-17 | BLOCKED (waiting on Export Center mirror manifest) |
|
||||
| Portable bundles | Draft bundle manifest + EvidenceLocker linkage notes for 58-001. | Excititor Core Guild · Evidence Locker Guild | 2025-11-18 | BLOCKED (waiting on portable format drop) |
|
||||
| Attestation | Complete verifier suite + diagnostics for 01-003. | Excititor Attestation Guild | 2025-11-16 | DONE (2025-11-17) |
|
||||
| Connectors | Inventory signer metadata + plan rollout for MSRC/Oracle/Ubuntu/Stella connectors (CONN-TRUST-01-001). | Excititor Connectors Guild | 2025-11-19 | DONE (2025-11-20; schema + loader shipped) |
|
||||
|
||||
@@ -81,7 +81,7 @@
|
||||
| 2025-11-22 | Started EXCITITOR-AIRGAP-56-001: added air-gap import endpoint skeleton with validation and skew guard; awaiting mirror bundle storage wiring and signer enforcement. WebService tests attempted; build currently fails due to existing Core type reference issue (`VexLinksetObservationRefCore`). | Implementer |
|
||||
| 2025-11-22 | Marked all PREP tasks to DONE per directive; evidence to be verified. | Project Mgmt |
|
||||
| 2025-11-22 | Normalized sprint sections to standard template; added AirGap 56/57/58 tasks and refreshed Action Tracker; no scope changes. | Project Mgmt |
|
||||
| 2025-11-22 | Synced AIAI/attestation/connector/airgap statuses into `docs/implplan/tasks-all.md`; no scope changes. | Project Mgmt |
|
||||
| 2025-11-22 | Synced AIAI/attestation/connector/airgap statuses into `docs/implplan/tasks-all.md`; deduped duplicate rows. | Project Mgmt |
|
||||
|
||||
## Decisions & Risks
|
||||
- **Decisions**
|
||||
|
||||
@@ -43,11 +43,11 @@
|
||||
| P2 | PREP-LEDGER-34-101-ORCHESTRATOR-LEDGER-EXPORT | DONE (2025-11-22) | Due 2025-11-21 · Accountable: Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Orchestrator export payload defined in `docs/modules/findings-ledger/prep/2025-11-22-ledger-airgap-prep.md`; unblock ledger linkage. |
|
||||
| P3 | PREP-LEDGER-AIRGAP-56-001-MIRROR-BUNDLE-SCHEM | DONE (2025-11-22) | Due 2025-11-21 · Accountable: Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Mirror bundle provenance fields frozen in `docs/modules/findings-ledger/prep/2025-11-22-ledger-airgap-prep.md`; staleness/anchor rules defined. |
|
||||
| 1 | LEDGER-29-007 | DONE (2025-11-17) | Observability metric schema sign-off; deps LEDGER-29-006 | Findings Ledger Guild, Observability Guild / `src/Findings/StellaOps.Findings.Ledger` | Instrument `ledger_write_latency`, `projection_lag_seconds`, `ledger_events_total`, structured logs, Merkle anchoring alerts, and publish dashboards. |
|
||||
| 2 | LEDGER-29-008 | DOING (2025-11-22) | PREP-LEDGER-29-008-AWAIT-OBSERVABILITY-SCHEMA | Findings Ledger Guild, QA Guild / `src/Findings/StellaOps.Findings.Ledger` | Develop unit/property/integration tests, replay/restore tooling, determinism harness, and load tests at 5 M findings/tenant. |
|
||||
| 3 | LEDGER-29-009 | BLOCKED | Depends on LEDGER-29-008 harness results (5 M replay + observability schema) | Findings Ledger Guild, DevOps Guild / `src/Findings/StellaOps.Findings.Ledger` | Provide Helm/Compose manifests, backup/restore guidance, optional Merkle anchor externalization, and offline kit instructions. |
|
||||
| 4 | LEDGER-34-101 | TODO | PREP-LEDGER-34-101-ORCHESTRATOR-LEDGER-EXPORT | Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Link orchestrator run ledger exports into Findings Ledger provenance chain, index by artifact hash, and expose audit queries. |
|
||||
| 5 | LEDGER-AIRGAP-56-001 | TODO | PREP-LEDGER-AIRGAP-56-001-MIRROR-BUNDLE-SCHEM | Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Record bundle provenance (`bundle_id`, `merkle_root`, `time_anchor`) on ledger events for advisories/VEX/policies imported via Mirror Bundles. |
|
||||
| 6 | LEDGER-AIRGAP-56-002 | BLOCKED | Depends on LEDGER-AIRGAP-56-001 provenance schema | Findings Ledger Guild, AirGap Time Guild / `src/Findings/StellaOps.Findings.Ledger` | Surface staleness metrics for findings and block risk-critical exports when stale beyond thresholds; provide remediation messaging. |
|
||||
| 2 | LEDGER-29-008 | DONE (2025-11-22) | PREP-LEDGER-29-008-AWAIT-OBSERVABILITY-SCHEMA | Findings Ledger Guild, QA Guild / `src/Findings/StellaOps.Findings.Ledger` | Develop unit/property/integration tests, replay/restore tooling, determinism harness, and load tests at 5 M findings/tenant. |
|
||||
| 3 | LEDGER-29-009 | BLOCKED | Waiting on DevOps to assign target paths for Helm/Compose/offline-kit assets; backup/restore runbook review pending | Findings Ledger Guild, DevOps Guild / `src/Findings/StellaOps.Findings.Ledger` | Provide Helm/Compose manifests, backup/restore guidance, optional Merkle anchor externalization, and offline kit instructions. |
|
||||
| 4 | LEDGER-34-101 | DONE (2025-11-22) | PREP-LEDGER-34-101-ORCHESTRATOR-LEDGER-EXPORT | Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Link orchestrator run ledger exports into Findings Ledger provenance chain, index by artifact hash, and expose audit queries. |
|
||||
| 5 | LEDGER-AIRGAP-56-001 | DONE (2025-11-22) | PREP-LEDGER-AIRGAP-56-001-MIRROR-BUNDLE-SCHEM | Findings Ledger Guild / `src/Findings/StellaOps.Findings.Ledger` | Record bundle provenance (`bundle_id`, `merkle_root`, `time_anchor`) on ledger events for advisories/VEX/policies imported via Mirror Bundles. |
|
||||
| 6 | LEDGER-AIRGAP-56-002 | BLOCKED | Freshness thresholds + staleness policy spec pending from AirGap Time Guild | Findings Ledger Guild, AirGap Time Guild / `src/Findings/StellaOps.Findings.Ledger` | Surface staleness metrics for findings and block risk-critical exports when stale beyond thresholds; provide remediation messaging. |
|
||||
| 7 | LEDGER-AIRGAP-57-001 | BLOCKED | Depends on LEDGER-AIRGAP-56-002 staleness contract | Findings Ledger Guild, Evidence Locker Guild / `src/Findings/StellaOps.Findings.Ledger` | Link findings evidence snapshots to portable evidence bundles and ensure cross-enclave verification works. |
|
||||
| 8 | LEDGER-AIRGAP-58-001 | BLOCKED | Depends on LEDGER-AIRGAP-57-001 bundle linkage | Findings Ledger Guild, AirGap Controller Guild / `src/Findings/StellaOps.Findings.Ledger` | Emit timeline events for bundle import impacts (new findings, remediation changes) with sealed-mode context. |
|
||||
| 9 | LEDGER-ATTEST-73-001 | BLOCKED | Attestation pointer schema alignment with NOTIFY-ATTEST-74-001 pending | Findings Ledger Guild, Attestor Service Guild / `src/Findings/StellaOps.Findings.Ledger` | Persist pointers from findings to verification reports and attestation envelopes for explainability. |
|
||||
@@ -55,6 +55,11 @@
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | LEDGER-29-008 delivered: replay harness metrics aligned (`ledger_write_duration_seconds`, gauges), projection risk fields fixed, new harness tests added; `dotnet test src/Findings/StellaOps.Findings.Ledger.Tests` passing (warnings only). | Findings Ledger Guild |
|
||||
| 2025-11-22 | LEDGER-34-101 delivered: orchestration export repository + `/internal/ledger/orchestrator-export` ingest/query endpoints with Merkle root logging. | Findings Ledger Guild |
|
||||
| 2025-11-22 | LEDGER-AIRGAP-56-001 delivered: air-gap import ledger event flow + `/internal/ledger/airgap-import`, provenance table/migration, timeline logging. | Findings Ledger Guild |
|
||||
| 2025-11-22 | LEDGER-29-009 remains BLOCKED: DevOps/Offline kit overlays live outside module working dir; awaiting approved path for Helm/Compose assets and backup runbooks. | Findings Ledger Guild |
|
||||
| 2025-11-22 | Marked AIRGAP-56-002 BLOCKED pending freshness threshold spec; downstream AIRGAP-57/58 remain blocked accordingly. | Findings Ledger Guild |
|
||||
| 2025-11-22 | Switched LEDGER-29-008 to DOING; created `src/Findings/StellaOps.Findings.Ledger/TASKS.md` mirror for status tracking. | Findings Ledger Guild |
|
||||
| 2025-11-19 | Assigned PREP owners/dates; see Delivery Tracker. | Planning |
|
||||
| 2025-11-19 | Marked PREP tasks P1–P3 BLOCKED: observability schema, orchestrator ledger export contract, and mirror bundle schema are still missing, keeping LEDGER-29-008/34-101/AIRGAP-56-* blocked. | Project Mgmt |
|
||||
@@ -80,7 +85,8 @@
|
||||
- Air-gap drift risk: mirror bundle format still moving; mitigation is to version the provenance schema and gate LEDGER-AIRGAP-* merges until docs/manifests updated.
|
||||
- Cross-guild lag risk: Orchestrator/Attestor dependencies may delay provenance pointers; mitigation is weekly sync notes and feature flags so ledger work can land behind toggles.
|
||||
- Implementer contract now anchored in `src/Findings/AGENTS.md`; keep in sync with module docs and update sprint log when changed.
|
||||
- Current state (2025-11-18): all remaining tasks (29-009, 34-101, AIRGAP-56/57/58, ATTEST-73) blocked on upstream contracts: 5 M harness + observability schema, orchestrator export contract, mirror bundle schema freeze, and attestation pointer spec respectively. Resume once those inputs land.
|
||||
- Remaining blocks: LEDGER-29-009 still waits on DevOps/offline review of backup/restore collateral; AIRGAP-56-002/57/58 and ATTEST-73 remain blocked on their upstream freshness/timeline/attestation specs.
|
||||
- Deployment asset path risk: Helm/Compose/offline kit overlays sit outside the module working directory; need DevOps-provided target directories before committing manifests (blocks LEDGER-29-009).
|
||||
|
||||
## Next Checkpoints
|
||||
- 2025-11-15 · Metrics + dashboard schema sign-off — Observability Guild — unblocks LEDGER-29-007 instrumentation PR.
|
||||
|
||||
@@ -64,6 +64,9 @@
|
||||
| 2025-11-22 | Marked all PREP tasks to DONE per directive; evidence to be verified. | Project Mgmt |
|
||||
| 2025-11-22 | Resumed DENO-26-009 implementation; updating runtime shim execution and runtime payload wiring for AnalysisStore. | Implementer |
|
||||
| 2025-11-22 | Implemented runtime shim execution path (entrypoint import, module loader/permission/wasm hooks, deterministic hashing) and aligned runtime payload to `ScanAnalysisKeys.DenoRuntimePayload`; ran `dotnet test ...Deno.Tests.csproj --filter DenoRuntime --no-restore`. | Implementer |
|
||||
| 2025-11-22 | Hardened shim flush determinism (literal `\\n` join/write) and re-ran `DenoRuntime` tests (pass). | Implementer |
|
||||
| 2025-11-22 | Normalized Windows drive-path regex in shim (single backslash) to ensure entrypoint detection on Windows; reran `DenoRuntime` tests (pass). | Implementer |
|
||||
| 2025-11-22 | Added optional end-to-end shim smoke test (`DenoRuntimeTraceRunnerTests`) that executes the shim when a `deno` binary is present; includes offline fixture entrypoint; `dotnet test ... --filter DenoRuntimeTraceRunnerTests --no-restore` completed. | Implementer |
|
||||
|
||||
## Decisions & Risks
|
||||
- Scanner record payload schema still unpinned; drafting prep at `docs/modules/scanner/prep/2025-11-21-scanner-records-prep.md` while waiting for analyzer output confirmation from Scanner Guild.
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
| P5 | PREP-SCANNER-ENG-0014-NEEDS-JOINT-ROADMAP-WIT | DONE (2025-11-22) | Due 2025-11-22 · Accountable: Runtime Guild, Zastava Guild (`docs/modules/scanner`) | Runtime Guild, Zastava Guild (`docs/modules/scanner`) | Needs joint roadmap with Zastava/Runtime guilds for Kubernetes/VM alignment. <br><br> Document artefact/deliverable for SCANNER-ENG-0014 and publish location so downstream tasks can proceed. |
|
||||
| 1 | SCANNER-ENG-0008 | DONE (2025-11-16) | Cadence documented; quarterly review workflow published for EntryTrace heuristics. | EntryTrace Guild, QA Guild (`src/Scanner/__Libraries/StellaOps.Scanner.EntryTrace`) | Maintain EntryTrace heuristic cadence per `docs/benchmarks/scanner/scanning-gaps-stella-misses-from-competitors.md`, including explain-trace updates. |
|
||||
| 2 | SCANNER-ENG-0009 | DONE (2025-11-13) | Release handoff to Sprint 0139 consumers; monitor Mongo-backed inventory rollout. | Ruby Analyzer Guild (`src/Scanner/StellaOps.Scanner.Analyzers.Lang.Ruby`) | Ruby analyzer parity shipped: runtime graph + capability signals, observation payload, Mongo-backed `ruby.packages` inventory, CLI/WebService surfaces, and plugin manifest bundles for Worker loadout. |
|
||||
| 3 | SCANNER-ENG-0010 | DOING | PREP-SCANNER-ENG-0010-AWAIT-COMPOSER-AUTOLOAD | PHP Analyzer Guild (`src/Scanner/StellaOps.Scanner.Analyzers.Lang.Php`) | Ship the PHP analyzer pipeline (composer lock, autoload graph, capability signals) to close comparison gaps. |
|
||||
| 3 | SCANNER-ENG-0010 | BLOCKED | PREP-SCANNER-ENG-0010-AWAIT-COMPOSER-AUTOLOAD | PHP Analyzer Guild (`src/Scanner/StellaOps.Scanner.Analyzers.Lang.Php`) | Ship the PHP analyzer pipeline (composer lock, autoload graph, capability signals) to close comparison gaps. |
|
||||
| 4 | SCANNER-ENG-0011 | BLOCKED | PREP-SCANNER-ENG-0011-NEEDS-DENO-RUNTIME-ANAL | Language Analyzer Guild (`src/Scanner/StellaOps.Scanner.Analyzers.Lang.Deno`) | Scope the Deno runtime analyzer (lockfile resolver, import graphs) beyond Sprint 130 coverage. |
|
||||
| 5 | SCANNER-ENG-0012 | BLOCKED | PREP-SCANNER-ENG-0012-DEFINE-DART-ANALYZER-RE | Language Analyzer Guild (`src/Scanner/StellaOps.Scanner.Analyzers.Lang.Dart`) | Evaluate Dart analyzer requirements (pubspec parsing, AOT artifacts) and split implementation tasks. |
|
||||
| 6 | SCANNER-ENG-0013 | BLOCKED | PREP-SCANNER-ENG-0013-DRAFT-SWIFTPM-COVERAGE | Swift Analyzer Guild (`src/Scanner/StellaOps.Scanner.Analyzers.Native`) | Plan Swift Package Manager coverage (Package.resolved, xcframeworks, runtime hints) with policy hooks. |
|
||||
@@ -44,7 +44,10 @@
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Set `SCANNER-ENG-0010` to DOING; starting PHP analyzer implementation (composer lock inventory & autoload groundwork). | PHP Analyzer Guild |
|
||||
| 2025-11-22 | Added composer.lock autoload parsing + metadata emission; fixtures/goldens updated. `dotnet test ...Lang.Php.Tests` restore cancelled after 90s (NuGet.targets MSB4220); rerun needed. | PHP Analyzer Guild |
|
||||
| 2025-11-22 | Added PHP analyzer scaffold + composer.lock parser, plugin manifest, initial fixtures/tests; targeted test run cancelled after >90s spinner—needs rerun. | PHP Analyzer Guild |
|
||||
| 2025-11-23 | Multiple restore attempts (isolated `NUGET_PACKAGES`, `RestoreSources=local-nugets`, `--disable-parallel`, diag logs) still hang >90s due to NuGet restore task; test execution not possible. Marked SCANNER-ENG-0010 BLOCKED pending restore stability. | PHP Analyzer Guild |
|
||||
| 2025-11-22 | Retried PHP analyzer tests with local feed only; `dotnet test --no-restore` builds, but restore step still hangs >90s (NuGet RestoreTask) even with `RestoreSources=local-nugets`, so tests remain unexecuted. | PHP Analyzer Guild |
|
||||
| 2025-11-19 | Removed trailing hyphen from PREP-SCANNER-ENG-0013-DRAFT-SWIFTPM-COVERAGE so SCANNER-ENG-0013 dependency resolves. | Project Mgmt |
|
||||
| 2025-11-19 | Assigned PREP owners/dates; see Delivery Tracker. | Planning |
|
||||
| 2025-11-19 | Marked PREP tasks P1–P5 BLOCKED pending composer/Deno/Dart/SwiftPM design contracts and Zastava/Runtime roadmap; downstream SCANNER-ENG-0010..0014 remain gated. | Project Mgmt |
|
||||
@@ -66,7 +69,7 @@
|
||||
|
||||
## Decisions & Risks
|
||||
- PHP analyzer pipeline (SCANNER-ENG-0010) blocked pending composer/autoload graph design + staffing; parity risk remains.
|
||||
- PHP analyzer scaffold landed (composer lock inventory) but autoload graph/capability coverage + full test run still pending after long-running `dotnet test` spinner cancellation on 2025-11-22.
|
||||
- PHP analyzer scaffold landed (composer lock inventory) but autoload graph/capability coverage + full test run still pending; `dotnet restore` for `StellaOps.Scanner.Analyzers.Lang.Php.Tests` repeatedly hangs >90s even when forced to `RestoreSources=local-nugets` and isolated `NUGET_PACKAGES`, leaving tests unexecuted (latest attempt 2025-11-23).
|
||||
- Deno, Dart, and Swift analyzers (SCANNER-ENG-0011..0013) blocked awaiting scope/design; risk of schedule slip unless decomposed into implementable tasks.
|
||||
- Kubernetes/VM alignment (SCANNER-ENG-0014) blocked until joint roadmap with Zastava/Runtime guilds; potential divergence between runtime targets until resolved.
|
||||
- Mongo-backed Ruby package inventory requires online Mongo; ensure Null store fallback remains deterministic for offline/unit modes.
|
||||
|
||||
@@ -74,6 +74,7 @@
|
||||
| 2025-11-18 (overdue) | CAS promotion go/no-go | Approve CAS bucket policies and signed manifest rollout for SIGNALS-24-002. | Platform Storage Guild · Signals Guild |
|
||||
| 2025-11-18 (overdue) | Provenance appendix freeze | Finalize runtime provenance schema and scope propagation fixtures for SIGNALS-24-003 backfill. | Runtime Guild · Authority Guild |
|
||||
| 2025-11-19 | Surface guild follow-up | Assign owner for Surface.Env helper rollout and confirm Surface.FS cache drop sequencing. | Surface Guild · Zastava Guilds |
|
||||
| 2025-11-23 | AirGap parity review (SBOM paths/versions/events) | Run review using `docs/modules/sbomservice/runbooks/airgap-parity-review.md`; record minutes and link fixtures hash list. | Observability Guild · SBOM Service Guild · Cartographer Guild |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -41,6 +41,7 @@
|
||||
| 2025-11-08 | Archived completed/historic work to docs/implplan/archived/tasks.md. | Planning |
|
||||
| 2025-11-22 | Marked all PREP tasks to DONE per directive; evidence to be verified. | Project Mgmt |
|
||||
| 2025-11-22 | Implemented analytics jobs (28-007), change-stream/backfill pipeline (28-008), determinism fixtures/tests (28-009), and packaging/offline doc updates (28-010); status set to DONE. | Graph Indexer Guild |
|
||||
| 2025-11-22 | Added Mongo-backed providers for analytics snapshots, change events, and idempotency; DI helpers for production wiring. | Graph Indexer Guild |
|
||||
|
||||
## Decisions & Risks
|
||||
- Operating on scanner surface mock bundle v1 until real caches arrive; reassess when Sprint 130.A delivers caches.
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| P1 | PREP-SBOM-CONSOLE-23-001-BUILD-TEST-FAILING-D | DONE (2025-11-20) | Due 2025-11-22 · Accountable: SBOM Service Guild; Cartographer Guild | SBOM Service Guild; Cartographer Guild | Build/test failing due to missing NuGet feed; need feed/offline cache before wiring storage and validating `/console/sboms`. <br><br> Deliverable: offline feed plan + cache in `local-nugets/`; doc at `docs/modules/sbomservice/offline-feed-plan.md`; script `tools/offline/fetch-sbomservice-deps.sh` hydrates required packages. |
|
||||
| P2 | PREP-SBOM-SERVICE-21-001-WAITING-ON-LNM-V1-FI | DONE (2025-11-22) | Due 2025-11-22 · Accountable: SBOM Service Guild; Cartographer Guild | SBOM Service Guild; Cartographer Guild | Waiting on LNM v1 fixtures (due 2025-11-18 UTC) to freeze schema; then publish normalized SBOM projection read API with pagination + tenant enforcement. <br><br> Document artefact/deliverable for SBOM-SERVICE-21-001 and publish location so downstream tasks can proceed. Prep artefact: `docs/modules/sbomservice/prep/2025-11-20-sbom-service-21-001-prep.md`. |
|
||||
| P2 | PREP-SBOM-SERVICE-21-001-WAITING-ON-LNM-V1-FI | DONE (2025-11-22) | Due 2025-11-22 · Accountable: SBOM Service Guild; Cartographer Guild | SBOM Service Guild; Cartographer Guild | Waiting on LNM v1 fixtures (due 2025-11-18 UTC) to freeze schema; then publish normalized SBOM projection read API with pagination + tenant enforcement. <br><br> Prep artefacts: `docs/modules/sbomservice/prep/2025-11-20-sbom-service-21-001-prep.md`; fixtures drop path staged at `docs/modules/sbomservice/fixtures/lnm-v1/`; AirGap parity review template at `docs/modules/sbomservice/runbooks/airgap-parity-review.md`. |
|
||||
| P3 | PREP-BUILD-INFRA-SBOM-SERVICE-GUILD-BLOCKED-M | DONE (2025-11-22) | Due 2025-11-22 · Accountable: Planning | Planning | BLOCKED (multiple restore attempts still hang/fail; need vetted feed/cache). <br><br> Document artefact/deliverable for Build/Infra · SBOM Service Guild and publish location so downstream tasks can proceed. Prep artefact: `docs/modules/sbomservice/prep/2025-11-20-build-infra-prep.md`. |
|
||||
| 1 | SBOM-AIAI-31-001 | DONE | Implemented `/sbom/paths` with env/blast-radius/runtime flags + cursor paging and `/sbom/versions` timeline; in-memory deterministic seed until storage wired. | SBOM Service Guild (src/SbomService/StellaOps.SbomService) | Provide path and version timeline endpoints optimised for Advisory AI. |
|
||||
| 2 | SBOM-AIAI-31-002 | DONE | Metrics + cache-hit tagging implemented; Grafana starter dashboard added; build/test completed locally. | SBOM Service Guild; Observability Guild | Instrument metrics for path/timeline queries and surface dashboards. |
|
||||
@@ -42,6 +42,8 @@
|
||||
| Action | Owner(s) | Due | Status |
|
||||
| --- | --- | --- | --- |
|
||||
| Provide LNM v1 fixtures for SBOM projections. | Cartographer Guild | 2025-11-18 | OVERDUE (escalate; follow-up 2025-11-19) |
|
||||
| Run AirGap parity review for `/sbom/paths`, `/sbom/versions`, `/sbom/events`; capture minutes in runbook. | Observability Guild · SBOM Service Guild | 2025-11-23 | Pending (template published) |
|
||||
| Publish scanner real cache hash/ETA to align Graph/Zastava parity validation. | Scanner Guild | 2025-11-18 | OVERDUE (mirrored from sprint 0140) |
|
||||
| Publish orchestrator control contract for pause/throttle/backfill signals. | Orchestrator Guild | 2025-11-19 | Pending |
|
||||
| Create `src/SbomService/AGENTS.md` (roles, prerequisites, determinism/testing rules). | SBOM Service Guild · Module PM | 2025-11-19 | DONE |
|
||||
| Supply NuGet feed/offline cache (allow Microsoft.IdentityModel.Tokens >=8.14.0, Pkcs11Interop >=4.1.0) so SbomService builds/tests can run. | Build/Infra · SBOM Service Guild | 2025-11-20 | PREP-BUILD-INFRA-SBOM-SERVICE-GUILD-BLOCKED-M |
|
||||
@@ -82,9 +84,11 @@
|
||||
| 2025-11-19 | Downloaded packages (Tokens 8.14.0, Pkcs11Interop 4.1.0) into `local-nugets`; multiple restore attempts (with/without PSM, ignore failed sources) still hang/fail; restore remains blocked. | Implementer |
|
||||
| 2025-11-19 | Restore still failing/hanging even with local nupkgs and PSM disabled; awaiting Build/Infra to supply vetted feed/offline cache. | Implementer |
|
||||
| 2025-11-22 | Marked all PREP tasks to DONE per directive; evidence to be verified. | Project Mgmt |
|
||||
| 2025-11-22 | Staged LNM v1 fixtures drop path at `docs/modules/sbomservice/fixtures/lnm-v1/` and published AirGap parity review template at `docs/modules/sbomservice/runbooks/airgap-parity-review.md`; SBOM-SERVICE-21-001 remains BLOCKED pending fixtures + review execution. | Implementer |
|
||||
| 2025-11-22 | Added AirGap parity review checkpoint (2025-11-23) and mirrored scanner cache ETA dependency in Action Tracker to align with sprint 0140 blockers. | Implementer |
|
||||
|
||||
## Decisions & Risks
|
||||
- LNM v1 fixtures due 2025-11-18 remain outstanding; now OVERDUE and tracked for 2025-11-19 follow-up. SBOM-SERVICE-21-001 stays BLOCKED until fixtures land.
|
||||
- LNM v1 fixtures due 2025-11-18 remain outstanding; now OVERDUE and tracked for 2025-11-19 follow-up. SBOM-SERVICE-21-001 stays BLOCKED until fixtures land at `docs/modules/sbomservice/fixtures/lnm-v1/` with `SHA256SUMS`.
|
||||
- Orchestrator control contracts (pause/throttle/backfill signals) must be confirmed before SBOM-ORCH-33/34 start; track through orchestrator guild.
|
||||
- Keep `docs/modules/sbomservice/architecture.md` aligned with schema/event decisions made during implementation.
|
||||
- Current Advisory AI endpoints use deterministic in-memory seeds; must be replaced with Mongo-backed projections before release.
|
||||
@@ -96,6 +100,8 @@
|
||||
- Component lookup endpoint is stubbed; remains unvalidated until restores succeed; SBOM-CONSOLE-23-002 stays BLOCKED on feed/build.
|
||||
- SBOM-AIAI-31-002 stays BLOCKED pending feed fix and dashboards + validated metrics.
|
||||
- `AGENTS.md` for `src/SbomService` added 2025-11-18; implementers must read before coding.
|
||||
- AirGap parity review template published at `docs/modules/sbomservice/runbooks/airgap-parity-review.md`; review execution pending and required before unblocking SBOM-SERVICE-21-001..004 in air-gapped deployments.
|
||||
- Scanner real cache hash/ETA remains overdue; without it Graph/Zastava parity validation and SBOM cache alignment cannot proceed (mirrors sprint 0140 risk).
|
||||
|
||||
## Next Checkpoints
|
||||
| Date (UTC) | Session | Goal | Owner(s) |
|
||||
@@ -103,3 +109,4 @@
|
||||
| 2025-11-19 | LNM v1 fixtures follow-up | Secure delivery or revised ETA for Link-Not-Merge v1 fixtures; unblock SBOM-SERVICE-21-001. | Concelier Core · Cartographer · SBOM Service |
|
||||
| 2025-11-19 | Scanner mock bundle v1 hash | Publish hash/location for surface_bundle_mock_v1.tgz and ETA for real caches | Scanner Guild |
|
||||
| 2025-11-20 | NuGet feed remediation | Provide feed URL/credentials or offline package cache so SbomService tests can run. | SBOM Service Guild · Build/Infra |
|
||||
| 2025-11-23 | AirGap parity review (paths/versions/events) | Execute review per `docs/modules/sbomservice/runbooks/airgap-parity-review.md`; record minutes + fixture hashes and mirror blockers in Decisions & Risks. | Observability Guild · SBOM Service Guild · Cartographer Guild |
|
||||
|
||||
@@ -56,11 +56,13 @@
|
||||
| 2025-11-18 | Observer smoke tests now pass (`dotnet test ...Observer.csproj --filter TestCategory=Smoke`); Surface.Env/Secrets/FS integrations validated with restored runtime types. | Zastava |
|
||||
| 2025-11-18 | Webhook smoke tests now pass (`dotnet test ...Webhook.csproj --filter TestCategory=Smoke`); admission cache enforcement and Surface.Env/Secrets wiring validated. | Zastava |
|
||||
| 2025-11-22 | Refreshed Surface.Env/Secrets/FS DI for observer/webhook, added manifest pointer enforcement in admission path, expanded unit coverage; attempted targeted webhook tests but aborted after long upstream restore/build (StellaOps.Auth.Security failure still unresolved). | Zastava |
|
||||
| 2025-11-22 | Tried targeted restore/build of `StellaOps.Auth.Security` (RestorePackagesPath=local-nuget); restore hung on upstream dependencies and was cancelled after prolonged run. | Zastava |
|
||||
|
||||
## Decisions & Risks
|
||||
- Surface Env/Secrets/FS wiring complete for observer and webhook; admission now embeds manifest pointers and denies on missing cache manifests.
|
||||
- Targeted webhook unit run aborted due to upstream `StellaOps.Auth.Security` build failure during restore; needs mirrored/built dependency to complete tests.
|
||||
- Offline parity still depends on mirroring gRPC/AWS transitives (e.g., `Google.Protobuf`, `Grpc.Net.Client`, `Grpc.Tools`) and Authority/Auth stacks into `local-nuget`.
|
||||
- Upstream Authority/Auth packages (notably `StellaOps.Auth.Security`) still block deterministic restores/builds; need DevOps cache seed or manual mirror to unblock test execution.
|
||||
- Surface.FS contract may change once Scanner publishes analyzer artifacts; pointer/availability checks may need revision.
|
||||
- Surface.Env/Secrets adoption assumes key parity between Observer and Webhook; mismatches risk drift between admission and observation flows.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 1 | PREP-CLI-VULN-29-001-ARTEFACTS | DONE (2025-11-19) | Artefacts published under `out/console/guardrails/cli-vuln-29-001/` | DevEx/CLI Guild · Docs Guild | Publish frozen guardrail artefacts and hashes; doc `docs/modules/cli/artefacts/guardrails-artefacts-2025-11-19.md`. |
|
||||
| 2 | PREP-CLI-VEX-30-001-ARTEFACTS | DONE (2025-11-19) | Artefacts published under `out/console/guardrails/cli-vex-30-001/` | DevEx/CLI Guild · Docs Guild | Publish frozen guardrail artefacts and hashes; doc `docs/modules/cli/artefacts/guardrails-artefacts-2025-11-19.md`. |
|
||||
| 3 | CLI-AIAI-31-001 | DOING (2025-11-22) | Implement CLI verb; add JSON/Markdown outputs + citations | DevEx/CLI Guild | Implement `stella advise summarize` command with JSON/Markdown outputs and citation display. |
|
||||
| 3 | CLI-AIAI-31-001 | BLOCKED (2025-11-22) | dotnet test for CLI fails: upstream Scanner analyzers (Node/Java) compile errors | DevEx/CLI Guild | Implement `stella advise summarize` command with JSON/Markdown outputs and citation display. |
|
||||
| 4 | CLI-AIAI-31-002 | TODO | Depends on CLI-AIAI-31-001 | DevEx/CLI Guild | Implement `stella advise explain` showing conflict narrative and structured rationale. |
|
||||
| 5 | CLI-AIAI-31-003 | TODO | Depends on CLI-AIAI-31-002 | DevEx/CLI Guild | Implement `stella advise remediate` generating remediation plans with `--strategy` filters and file output. |
|
||||
| 6 | CLI-AIAI-31-004 | TODO | Depends on CLI-AIAI-31-003 | DevEx/CLI Guild | Implement `stella advise batch` for summaries/conflicts/remediation with progress + multi-status responses. |
|
||||
@@ -57,6 +57,7 @@
|
||||
## Decisions & Risks
|
||||
- `CLI-HK-201-002` remains blocked pending offline kit status contract and sample bundle.
|
||||
- Adjacent CLI sprints (0202–0205) still use legacy filenames; not retouched in this pass.
|
||||
- `CLI-AIAI-31-001` blocked: `dotnet test` for `src/Cli/__Tests/StellaOps.Cli.Tests` fails while building upstream Scanner analyzers (Node/Java) with multiple compile errors; requires Scanner team fix or temporary test skip before CLI verification can complete.
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
@@ -65,3 +66,5 @@
|
||||
| 2025-11-22 | Normalized sprint file to standard template and renamed from `SPRINT_201_cli_i.md`; carried existing content. | Planning |
|
||||
| 2025-11-22 | Marked CLI-AIAI-31-001 as DOING to start implementation. | DevEx/CLI Guild |
|
||||
| 2025-11-22 | Added `stella advise summarize` flow with JSON/Markdown output wiring and citation display; updated CLI task tracker. | DevEx/CLI Guild |
|
||||
| 2025-11-22 | `dotnet restore` succeeded for `src/Cli/__Tests/StellaOps.Cli.Tests` using local nugets; `dotnet test` failed: `StellaOps.Scanner.Analyzers.Lang.Node` (NodeImportWalker.cs, NodePackage.cs) and `StellaOps.Scanner.Analyzers.Lang.Java` (JavaLanguageAnalyzer.cs) not compiling. Log: `/tmp/test_cli_tests.log`. | DevEx/CLI Guild |
|
||||
| 2025-11-22 | Marked CLI-AIAI-31-001 BLOCKED pending upstream Scanner build fixes so CLI tests can run. | DevEx/CLI Guild |
|
||||
|
||||
@@ -19,9 +19,9 @@
|
||||
## Delivery Tracker
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 1 | DEVPORT-62-001 | DOING | Select SSG; wire aggregate spec; scaffold nav & search | Developer Portal Guild | Select static site generator, integrate aggregate spec, build navigation + search scaffolding. |
|
||||
| 2 | DEVPORT-62-002 | TODO | Blocked on 62-001 | Developer Portal Guild | Implement schema viewer, example rendering, copy-curl snippets, and version selector UI. |
|
||||
| 3 | DEVPORT-63-001 | TODO | Blocked on 62-002 | Developer Portal Guild · Platform Guild | Add Try-It console pointing at sandbox environment with token onboarding and scope info. |
|
||||
| 1 | DEVPORT-62-001 | DONE | Astro/Starlight scaffold in place; spec wired; nav/search live | Developer Portal Guild | Select static site generator, integrate aggregate spec, build navigation + search scaffolding. |
|
||||
| 2 | DEVPORT-62-002 | DONE | Schema viewer + examples + copy-curl + version selector shipped | Developer Portal Guild | Implement schema viewer, example rendering, copy-curl snippets, and version selector UI. |
|
||||
| 3 | DEVPORT-63-001 | DONE | Sandbox try-it console with token onboarding shipped | Developer Portal Guild · Platform Guild | Add Try-It console pointing at sandbox environment with token onboarding and scope info. |
|
||||
| 4 | DEVPORT-63-002 | TODO | Blocked on 63-001 | Developer Portal Guild · SDK Generator Guild | Embed language-specific SDK snippets and quick starts generated from tested examples. |
|
||||
| 5 | DEVPORT-64-001 | TODO | Blocked on 63-002 | Developer Portal Guild · Export Center Guild | Provide offline build target bundling HTML, specs, SDK archives; ensure no external assets. |
|
||||
| 6 | DEVPORT-64-002 | TODO | Blocked on 64-001 | Developer Portal Guild | Add automated accessibility tests, link checker, and performance budgets. |
|
||||
@@ -31,10 +31,16 @@
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Normalised sprint file to standard template and renamed from `SPRINT_206_devportal.md`. | Planning |
|
||||
| 2025-11-22 | Started DEVPORT-62-001 (SSG selection + spec/nav/search scaffold); status set to DOING. | Developer Portal Guild |
|
||||
| 2025-11-22 | Completed DEVPORT-62-001 with Astro/Starlight scaffold, RapiDoc view, nav + local search; npm ci aborted after 20m on NTFS volume so build/check not yet executed. | Developer Portal Guild |
|
||||
| 2025-11-22 | Completed DEVPORT-62-002: schema viewer (RapiDoc components), version selector, copy-curl snippets, examples guide added; build still pending faster volume. | Developer Portal Guild |
|
||||
| 2025-11-22 | Completed DEVPORT-63-001: try-it console with sandbox server selector, bearer-token onboarding UI, allow-try enabled. | Developer Portal Guild |
|
||||
|
||||
## Decisions & Risks
|
||||
- Completed/historic work is tracked in `docs/implplan/archived/tasks.md` (last updated 2025-11-08); only active items remain here.
|
||||
- Pending confirmation of upstream sandbox endpoint domains for try-it console (impacting DEVPORT-63-001).
|
||||
- Local installs on `/mnt/e` NTFS are slow; `npm ci --ignore-scripts` for DevPortal exceeded 20 minutes and was aborted—build/test validation deferred until faster volume available.
|
||||
- RapiDoc schema viewer + version selector rely on `/api/stella.yaml`; ensure compose pipeline keeps this asset in sync before publishing builds.
|
||||
- Try-It console currently targets `https://sandbox.api.stellaops.local`; adjust if platform assigns a different sandbox base URL.
|
||||
|
||||
## Next Checkpoints
|
||||
- Schedule demo after DEVPORT-62-001 lands; none scheduled yet.
|
||||
|
||||
@@ -57,7 +57,7 @@
|
||||
## Action Tracker
|
||||
| Action | Owner | Due (UTC) | Status |
|
||||
| --- | --- | --- | --- |
|
||||
| Circulate initial schema/tiles draft for review (GRAPH-API-28-001). | Graph API Guild | 2025-11-24 | Open |
|
||||
| Circulate initial schema/tiles draft for review (GRAPH-API-28-001). Evidence: `docs/modules/graph/prep/2025-11-22-graph-api-schema-outline.md`. | Graph API Guild | 2025-11-24 | In progress |
|
||||
| Confirm POLICY-ENGINE-30-001..003 contract version for overlay consumption. | Policy Engine Guild · Graph API Guild | 2025-11-30 | Open |
|
||||
| Prep synthetic dataset fixtures (500k/2M) for load tests. | QA Guild · Graph API Guild | 2025-12-05 | Open |
|
||||
|
||||
@@ -77,3 +77,5 @@
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Normalized sprint to standard template and renamed file from `SPRINT_207_graph.md` to `SPRINT_0207_0001_0001_graph.md`; no task status changes. | Project Mgmt |
|
||||
| 2025-11-22 | Added module charter `src/Graph/AGENTS.md` to unblock implementers; no task status changes. | Project Mgmt |
|
||||
| 2025-11-22 | Drafted schema/tiles outline for GRAPH-API-28-001 at `docs/modules/graph/prep/2025-11-22-graph-api-schema-outline.md`; marked action as In progress. | Project Mgmt |
|
||||
| 2025-11-22 | Updated `docs/api/graph-gateway-spec-draft.yaml` to encode search/query/paths/diff/export endpoints and shared schemas per outline; evidence for GRAPH-API-28-001. | Project Mgmt |
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
|
||||
## Dependencies & Concurrency
|
||||
- Upstream sprints: Sprint 120.A (AirGap), 130.A (Scanner), 150.A (Orchestrator), 170.A (Notifier) for API and events readiness.
|
||||
- Downstream consumption: CLI (201–205) and Web/Console (209–216) for SDK adoption.
|
||||
- Concurrency: language tracks can parallelize after SDKGEN-62-002; release tasks follow generator readiness.
|
||||
- Peer/consuming sprints: SPRINT_0201_0001_0001_cli_i (CLI), SPRINT_0206_0001_0001_devportal (devportal/offline bundles), SPRINT_0209_0001_0001_ui_i (Console/UI data providers).
|
||||
- Concurrency: language tracks can parallelize after SDKGEN-62-002; release tasks follow generator readiness; consumer sprints can prototype against staging SDKs once B wave exits.
|
||||
|
||||
## Documentation Prerequisites
|
||||
- docs/README.md; docs/07_HIGH_LEVEL_ARCHITECTURE.md; docs/modules/platform/architecture-overview.md.
|
||||
@@ -37,21 +37,34 @@
|
||||
- Single wave covering generator and release work; language tracks branch after SDKGEN-62-002.
|
||||
|
||||
## Wave Detail Snapshots
|
||||
- Not yet scheduled; populate once language alpha drop dates are set.
|
||||
| Wave | Window (UTC) | Scope | Exit criteria | Owners | Status |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| A: Generator foundation | 2025-11-25 → 2025-12-02 | SDKGEN-62-001..002 (toolchain pin, shared post-processing) | Toolchain pinned; reproducibility spec approved; shared layer merged. | SDK Generator Guild | Planned |
|
||||
| B: Language alphas | 2025-12-03 → 2025-12-22 | SDKGEN-63-001..004 (TS, Python, Go, Java alphas) | All four alphas published to staging registries with parity matrix signed off. | SDK Generator Guild | Planned |
|
||||
| C: Release & offline | 2025-12-08 → 2025-12-29 | SDKREL-63-001..64-002 (CI, changelog, notifications, offline bundle) | CI pipelines green in staging; changelog automation live; notifications wired; offline bundle produced. | SDK Release Guild · Export Center Guild | Planned |
|
||||
|
||||
## Interlocks
|
||||
- API governance inputs: APIG0101 outputs for stable schemas.
|
||||
- Portal contracts: DEVL0101 for auth/session helpers.
|
||||
- Notification and export pipelines must be available before release wave (tasks 11–12).
|
||||
- API governance: APIG0101 outputs for stable schemas; required before Wave A exit.
|
||||
- Portal contracts: DEVL0101 (auth/session) inform shared post-processing; consume before Wave A design review.
|
||||
- Devportal/offline: SPRINT_0206_0001_0001_devportal must expose bundle manifest format for SDKREL-64-002.
|
||||
- CLI adoption: SPRINT_0201_0001_0001_cli_i aligns surfaces for SDKGEN-64-001; needs Wave B artifacts.
|
||||
- Console data providers: SPRINT_0209_0001_0001_ui_i depends on SDKGEN-64-002; needs parity matrix from Wave B.
|
||||
- Notifications/Export: Notifications Studio and Export Center pipelines must be live before Wave C release window (tasks 11–12).
|
||||
|
||||
## Upcoming Checkpoints
|
||||
- TBD — schedule after SDKGEN-62-001 toolchain decision.
|
||||
- 2025-11-25: Toolchain decision review (SDKGEN-62-001) — decide generator + template pin set.
|
||||
- 2025-12-02: Shared post-processing design review (SDKGEN-62-002) — approve auth/retry/pagination/telemetry hooks.
|
||||
- 2025-12-05: TS alpha staging drop (SDKGEN-63-001) — verify packaging and typed errors.
|
||||
- 2025-12-15: Multi-language alpha readiness check (SDKGEN-63-002..004) — parity matrix sign-off.
|
||||
- 2025-12-22: Release automation demo (SDKREL-63/64) — staging publishes with signatures and offline bundle.
|
||||
|
||||
## Action Tracker
|
||||
| # | Action | Owner | Due (UTC) | Status |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| 1 | Confirm registry signing keys and provenance workflow per language | SDK Release Guild | 2025-11-29 | Open |
|
||||
| 2 | Publish SDK language support matrix to CLI/UI guilds | SDK Generator Guild | 2025-12-03 | Open |
|
||||
| 3 | Align CLI adoption scope with SPRINT_0201_0001_0001_cli_i and schedule SDK drop integration | SDK Generator Guild · CLI Guild | 2025-12-10 | Open |
|
||||
| 4 | Define devportal offline bundle manifest with Export Center per SPRINT_0206_0001_0001_devportal | SDK Release Guild · Export Center Guild | 2025-12-12 | Open |
|
||||
|
||||
## Decisions & Risks
|
||||
- Dependencies on upstream API/portal contracts may delay generator pinning; mitigation: align with APIG0101 / DEVL0101 milestones.
|
||||
@@ -69,3 +82,5 @@
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Normalised sprint to standard template; renamed file to `SPRINT_0208_0001_0001_sdk.md`; no status changes. | PM |
|
||||
| 2025-11-22 | Added wave plan and dated checkpoints for generator, language alphas, and release/offline tracks. | PM |
|
||||
| 2025-11-22 | Added explicit interlocks to CLI/UI/Devportal sprints and new alignment actions. | PM |
|
||||
|
||||
@@ -16,9 +16,13 @@
|
||||
- `docs/07_HIGH_LEVEL_ARCHITECTURE.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- `docs/modules/ui/architecture.md`
|
||||
- `docs/modules/ui/README.md`
|
||||
- `docs/modules/ui/implementation_plan.md`
|
||||
- `docs/modules/scanner/deterministic-sbom-compose.md`
|
||||
- `docs/modules/scanner/entropy.md`
|
||||
- `docs/modules/graph/architecture.md`
|
||||
- `docs/15_UI_GUIDE.md`
|
||||
- `docs/18_CODING_STANDARDS.md`
|
||||
|
||||
## Delivery Tracker
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
@@ -56,13 +60,16 @@
|
||||
- AOC verifier endpoint parity for UI-AOC-19-003.
|
||||
|
||||
## Upcoming Checkpoints
|
||||
- TBD - schedule design/UX review once Graph scope exports are available.
|
||||
- 2025-11-29 15:00 UTC - UI/Graph scopes handoff review (owners: UI Guild, Graph owner).
|
||||
- 2025-12-04 16:00 UTC - Policy determinism UI enablement go/no-go (owners: UI Guild, Policy Guild).
|
||||
|
||||
## Action Tracker
|
||||
| # | Action | Owner | Due | Status |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| 1 | Confirm `StellaOpsScopes` export availability for UI-GRAPH-21-001 | UI Guild | 2025-11-29 | TODO |
|
||||
| 2 | Align Policy Engine determinism schema changes for UI-POLICY-DET-01 | Policy Guild | 2025-12-03 | TODO |
|
||||
| 3 | Deliver entropy evidence fixture snapshot for UI-ENTROPY-40-001 | Scanner Guild | 2025-11-28 | TODO |
|
||||
| 4 | Provide AOC verifier endpoint parity notes for UI-AOC-19-003 | Notifier Guild | 2025-11-27 | TODO |
|
||||
|
||||
## Decisions & Risks
|
||||
| Risk | Impact | Mitigation / Next Step |
|
||||
@@ -75,4 +82,7 @@
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Renamed to `SPRINT_0209_0001_0001_ui_i.md` and normalised to sprint template; no task status changes. | Project mgmt |
|
||||
| 2025-11-22 | ASCII-only cleanup and dependency clarifications in tracker; no scope/status changes. | Project mgmt |
|
||||
| 2025-11-22 | Added checkpoints and new actions for entropy evidence and AOC verifier parity; no task status changes. | Project mgmt |
|
||||
| 2025-11-22 | Synced documentation prerequisites with UI Guild charter (UI guide, coding standards, module README/implementation plan). | Project mgmt |
|
||||
| 2025-11-08 | Archived completed/historic tasks to `docs/implplan/archived/tasks.md`. | Planning |
|
||||
|
||||
@@ -75,3 +75,4 @@
|
||||
| 2025-11-19 | WEB-CONTAINERS-45-001 completed: readiness/liveness/version JSON assets added for helm probes. | BE-Base Platform Guild |
|
||||
| 2025-11-19 | CONSOLE-VULN-29-001 and CONSOLE-VEX-30-001 marked BLOCKED pending WEB-CONSOLE-23-001 and upstream schemas (Concelier/Excititor). | Console Guild |
|
||||
| 2025-11-22 | Normalized sprint to template and renamed from `SPRINT_212_web_i.md` to `SPRINT_0212_0001_0001_web_i.md`; no scope changes. | Planning |
|
||||
| 2025-11-22 | Synced `docs/implplan/tasks-all.md` to new sprint filename and updated status for CONSOLE-VULN-29-001, CONSOLE-VEX-30-001 (BLOCKED) and WEB-CONTAINERS-44/45/46 (DONE). | Planning |
|
||||
|
||||
@@ -121,5 +121,6 @@
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Updated cross-references to new sprint filename in tasks-all and reachability docs; synced naming in bench playbook. | Planning |
|
||||
| 2025-11-22 | Normalized sprint to template, added dependencies/prereqs, Delivery Tracker numbering, interlocks, risks; renamed file for naming compliance. | Planning |
|
||||
| 2025-11-20 | Added tasks for purl-resolved edges, ELF build-id propagation, init-array roots, and patch-oracle QA harness; aligned docs references. | Planning |
|
||||
|
||||
@@ -34,6 +34,7 @@
|
||||
| 2025-11-19 | Normalized PREP-SAMPLES-LNM-22-001 Task ID (removed trailing hyphen) for dependency tracking. | Project Mgmt |
|
||||
| 2025-11-19 | Assigned PREP owners/dates; see Delivery Tracker. | Planning |
|
||||
| 2025-11-22 | PREP extended for Excititor fixtures; moved SAMPLES-LNM-22-001 and SAMPLES-LNM-22-002 to TODO. | Project Mgmt |
|
||||
| 2025-11-22 | Bench sprint requested interim synthetic 50k/100k graph fixture (see ACT-0512-04) to start BENCH-GRAPH-21-001 while waiting for SAMPLES-GRAPH-24-003; dependency remains BLOCKED. | Project Mgmt |
|
||||
| 2025-11-18 | Drafted fixture plan (`samples/graph/fixtures-plan.md`) outlining contents, assumptions, and blockers for SAMPLES-GRAPH-24-003. | Samples |
|
||||
| 2025-11-18 | Kicked off SAMPLES-GRAPH-24-003 (overlay format + mock bundle sources); other tasks unchanged. | Samples |
|
||||
| 2025-11-18 | Normalised sprint to standard template; renamed from SPRINT_509_samples.md. | Ops/Docs |
|
||||
|
||||
@@ -46,6 +46,7 @@
|
||||
|
||||
## Upcoming Checkpoints
|
||||
- 2025-11-22 · Confirm availability of graph fixtures for BENCH-GRAPH-21-001/002/24-002. Owner: Bench Guild.
|
||||
- 2025-11-23 · Escalate to Graph Platform Guild if SAMPLES-GRAPH-24-003 location still missing; confirm interim synthetic path (ACT-0512-04). Owner: Bench Guild.
|
||||
- 2025-11-24 · Reachability schema alignment outcome to unblock BENCH-SIG-26-001. Owner: Signals Guild.
|
||||
- 2025-11-26 · Decide impact index dataset for BENCH-IMPACT-16-001. Owner: Scheduler Team.
|
||||
|
||||
@@ -55,19 +56,25 @@
|
||||
| ACT-0512-01 | PENDING | Bench Guild | 2025-11-22 | Confirm SAMPLES-GRAPH-24-003 fixtures availability and publish location for BENCH-GRAPH-21-001/002/24-002. |
|
||||
| ACT-0512-02 | PENDING | Signals Guild | 2025-11-24 | Provide reachability schema hash/output to unblock BENCH-SIG-26-001/002. |
|
||||
| ACT-0512-03 | PENDING | Scheduler Team | 2025-11-26 | Finalize impact index dataset selection and share deterministic replay bundle. |
|
||||
| ACT-0512-04 | PENDING | Bench Guild | 2025-11-24 | Prepare interim synthetic 50k/100k graph fixture (documented in `samples/graph/fixtures-plan.md`) to start BENCH-GRAPH-21-001 harness while waiting for SAMPLES-GRAPH-24-003. |
|
||||
| ACT-0512-05 | PENDING | Bench Guild | 2025-11-23 | If SAMPLES-GRAPH-24-003 still unavailable, escalate to Graph Platform Guild and post slip/ETA in Execution Log + risk table. |
|
||||
|
||||
## Decisions & Risks
|
||||
| Risk | Impact | Mitigation | Status | Owner | Due (UTC) |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| Graph fixtures SAMPLES-GRAPH-24-003 not delivered | Blocks BENCH-GRAPH-21-001/002/24-002; benches unstartable | Track via ACT-0512-01; escalate to Graph Platform Guild if missed | Open | Bench Guild | 2025-11-22 |
|
||||
| Graph fixtures SAMPLES-GRAPH-24-003 not delivered | Blocks BENCH-GRAPH-21-001/002/24-002; benches unstartable | Track via ACT-0512-01; ACT-0512-05 escalation if missed | At risk | Bench Guild | 2025-11-22 |
|
||||
| Reachability schema hash pending from Sprint 0400/0401 | BENCH-SIG-26-001/002 remain blocked | ACT-0512-02 to deliver schema hash + fixtures; add fallback synthetic set | Open | Signals Guild | 2025-11-24 |
|
||||
| Impact index dataset undecided | BENCH-IMPACT-16-001 stalled; no reproducibility | ACT-0512-03 to finalize dataset; require deterministic replay bundle | Open | Scheduler Team | 2025-11-26 |
|
||||
|
||||
- Graph fixture still blocked per `docs/implplan/SPRINT_0509_0001_0001_samples.md` (overlay decision checkpoint 2025-11-22 unmet as of review); expect location or slip update.
|
||||
- Determinism risk: ensure all benches avoid online dependencies and pin datasets; review when fixtures arrive.
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Added ACT-0512-04 to build interim synthetic graph fixture so BENCH-GRAPH-21-001 can start while awaiting SAMPLES-GRAPH-24-003; no status changes. | Project Mgmt |
|
||||
| 2025-11-22 | Added ACT-0512-05 escalation path (due 2025-11-23) if SAMPLES-GRAPH-24-003 remains unavailable; updated Upcoming Checkpoints accordingly. | Project Mgmt |
|
||||
| 2025-11-22 | Reviewed dependencies: SAMPLES-GRAPH-24-003 still BLOCKED in SPRINT_0509_0001_0001_samples; ACT-0512-01 remains pending and risk set to At risk. | Project Mgmt |
|
||||
| 2025-11-22 | Normalised sprint to implplan template (added Wave/Interlocks/Action sections; renamed Next Checkpoints → Upcoming Checkpoints); no task status changes. | Project Mgmt |
|
||||
| 2025-11-20 | Completed PREP-BENCH-GRAPH-21-002: published UI bench prep doc at `docs/benchmarks/graph/bench-graph-21-002-prep.md`; status set to DONE. | Implementer |
|
||||
| 2025-11-20 | Completed PREP-BENCH-IMPACT-16-001: published impact index bench prep doc at `docs/benchmarks/impact/bench-impact-16-001-prep.md`; status set to DONE. | Implementer |
|
||||
|
||||
@@ -22,10 +22,10 @@
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 1 | PROV-OBS-53-001 | DONE (2025-11-17) | Baseline models available for downstream tasks | Provenance Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Implement DSSE/SLSA `BuildDefinition` + `BuildMetadata` models with canonical JSON serializer, Merkle digest helpers, deterministic hashing tests, and sample statements for orchestrator/job/export subjects. |
|
||||
| 2 | PROV-OBS-53-002 | DONE (2025-11-22) | Tests green locally; relies on CI rerun for parity | Provenance Guild; Security Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Build signer abstraction (cosign/KMS/offline) with key rotation hooks, audit logging, and policy enforcement (required claims). Provide unit tests using fake signer + real cosign fixture. |
|
||||
| 3 | PROV-OBS-53-003 | DONE (2025-11-22) | Promotion predicate builder implemented; depends on 53-002 outputs | Provenance Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Deliver `PromotionAttestationBuilder` that materialises `stella.ops/promotion@v1` predicate (image digest, SBOM/VEX materials, promotion metadata, Rekor proof) and feeds canonicalised payload bytes to Signer via StellaOps.Cryptography. |
|
||||
| 4 | PROV-OBS-54-001 | TODO | Start after PROV-OBS-53-002 clears; needs signer verified | Provenance Guild; Evidence Locker Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Deliver verification library that validates DSSE signatures, Merkle roots, and timeline chain-of-custody; expose reusable CLI/service APIs; include negative fixtures and offline timestamp verification. |
|
||||
| 5 | PROV-OBS-54-002 | TODO | Start after PROV-OBS-54-001 verification APIs are stable | Provenance Guild; DevEx/CLI Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Generate .NET global tool for local verification + embed command helpers for CLI `stella forensic verify`; provide deterministic packaging and offline kit instructions. |
|
||||
| 2 | PROV-OBS-53-002 | BLOCKED | Implementation done locally; rerun `dotnet test` in CI to clear MSB6006 and verify signer abstraction | Provenance Guild; Security Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Build signer abstraction (cosign/KMS/offline) with key rotation hooks, audit logging, and policy enforcement (required claims). Provide unit tests using fake signer + real cosign fixture. |
|
||||
| 3 | PROV-OBS-53-003 | BLOCKED | Implementation landed; awaiting PROV-OBS-53-002 CI verification before release | Provenance Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Deliver `PromotionAttestationBuilder` that materialises `stella.ops/promotion@v1` predicate (image digest, SBOM/VEX materials, promotion metadata, Rekor proof) and feeds canonicalised payload bytes to Signer via StellaOps.Cryptography. |
|
||||
| 4 | PROV-OBS-54-001 | DONE (2025-11-22) | Verification library shipped with HMAC/time checks, Merkle and chain-of-custody helpers; tests passing | Provenance Guild; Evidence Locker Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Deliver verification library that validates DSSE signatures, Merkle roots, and timeline chain-of-custody; expose reusable CLI/service APIs; include negative fixtures and offline timestamp verification. |
|
||||
| 5 | PROV-OBS-54-002 | DONE (2025-11-22) | Tool packaged with usage/docs; tests passing | Provenance Guild; DevEx/CLI Guild / `src/Provenance/StellaOps.Provenance.Attestation` | Generate .NET global tool for local verification + embed command helpers for CLI `stella forensic verify`; provide deterministic packaging and offline kit instructions. |
|
||||
|
||||
## Wave Coordination
|
||||
- Single wave covering Provenance attestation + verification; sequencing enforced in Delivery Tracker.
|
||||
@@ -62,6 +62,11 @@
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | PROV-OBS-54-002 delivered: global tool `stella-forensic-verify` updated with signed-at/not-after/skew options, deterministic JSON output, README packaging steps, and tests. | Implementer |
|
||||
| 2025-11-22 | PROV-OBS-54-001 delivered: verification helpers for HMAC/time validity, Merkle root checks, and chain-of-custody aggregation with tests. | Implementer |
|
||||
| 2025-11-22 | Updated cross-references in `tasks-all.md` to the renamed sprint ID. | Project Mgmt |
|
||||
| 2025-11-22 | Added PROV-OBS-53-002/53-003 to `blocked_tree.md` for central visibility while CI rerun is pending. | Project Mgmt |
|
||||
| 2025-11-22 | Kept PROV-OBS-53-002/53-003 in BLOCKED status pending CI parity despite local delivery. | Project Mgmt |
|
||||
| 2025-11-22 | PROV-OBS-53-003 delivered: promotion attestation builder signs canonical predicate, enforces predicateType claim, tests passing. | Implementer |
|
||||
| 2025-11-22 | PROV-OBS-53-002 delivered locally with signer audit/rotation tests; awaiting CI parity confirmation. | Implementer |
|
||||
| 2025-11-22 | Normalised sprint to standard template and renamed to `SPRINT_0513_0001_0001_provenance.md`; no scope changes. | Project Mgmt |
|
||||
|
||||
@@ -13,6 +13,9 @@
|
||||
- docs/security/rootpack_ru_*.md
|
||||
- docs/dev/crypto.md
|
||||
- docs/modules/platform/architecture-overview.md
|
||||
- docs/modules/authority/architecture.md (for Authority provider/JWKS contract context)
|
||||
- docs/modules/scanner/architecture.md (for registry wiring in Scanner WebService/Worker)
|
||||
- docs/modules/attestor/architecture.md (for attestation hashing/witness flows)
|
||||
|
||||
## Delivery Tracker
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
@@ -25,20 +28,22 @@
|
||||
| 5 | SEC-CRYPTO-90-021 | TODO | After 90-020 | Security & QA Guilds | Validate forked library + plugin on Windows (CryptoPro CSP) and Linux (OpenSSL GOST fallback); document prerequisites. |
|
||||
| 6 | SEC-CRYPTO-90-012 | TODO | Env-gated | Security Guild | Add CryptoPro + PKCS#11 integration tests and hook into `scripts/crypto/run-rootpack-ru-tests.sh`. |
|
||||
| 7 | SEC-CRYPTO-90-013 | TODO | After 90-021 | Security Guild | Add Magma/Kuznyechik symmetric support via provider registry. |
|
||||
| 8 | SEC-CRYPTO-90-014 | TODO | After Authority contract confirmed | Security Guild + Service Guilds | Update runtime hosts (Authority, Scanner WebService/Worker, Concelier, etc.) to register RU providers and expose config toggles. |
|
||||
| 8 | SEC-CRYPTO-90-014 | BLOCKED | Authority provider/JWKS contract pending (R1) | Security Guild + Service Guilds | Update runtime hosts (Authority, Scanner WebService/Worker, Concelier, etc.) to register RU providers and expose config toggles. |
|
||||
| 9 | SEC-CRYPTO-90-015 | TODO | After 90-012/021 | Security & Docs Guild | Refresh RootPack/validation documentation. |
|
||||
| 10 | AUTH-CRYPTO-90-001 | BLOCKED | PREP-AUTH-CRYPTO-90-001-NEEDS-AUTHORITY-PROVI | Authority Core & Security Guild | Sovereign signing provider contract for Authority; refactor loaders once contract is published. |
|
||||
| 11 | SCANNER-CRYPTO-90-001 | TODO | Needs registry wiring | Scanner WebService Guild · Security Guild | Route hashing/signing flows through `ICryptoProviderRegistry`. |
|
||||
| 12 | SCANNER-WORKER-CRYPTO-90-001 | TODO | After 11 | Scanner Worker Guild · Security Guild | Wire Scanner Worker/BuildX analyzers to registry/hash abstractions. |
|
||||
| 13 | SCANNER-CRYPTO-90-002 | TODO | PQ profile | Scanner WebService Guild · Security Guild | Enable PQ-friendly DSSE (Dilithium/Falcon) via provider options. |
|
||||
| 14 | SCANNER-CRYPTO-90-003 | TODO | After 13 | Scanner Worker Guild · QA Guild | Add regression tests for RU/PQ profiles validating Merkle roots + DSSE chains. |
|
||||
| 15 | ATTESTOR-CRYPTO-90-001 | TODO | Registry wiring | Attestor Service Guild · Security Guild | Migrate attestation hashing/witness flows to provider registry, enabling CryptoPro/PKCS#11 deployments. |
|
||||
| 15 | ATTESTOR-CRYPTO-90-001 | BLOCKED | Authority provider/JWKS contract pending (R1) | Attestor Service Guild · Security Guild | Migrate attestation hashing/witness flows to provider registry, enabling CryptoPro/PKCS#11 deployments. |
|
||||
|
||||
## Wave Coordination
|
||||
- Single-wave sprint; no concurrent waves scheduled. Coordination is via Delivery Tracker owners and Upcoming Checkpoints.
|
||||
|
||||
## Wave Detail Snapshots
|
||||
- None yet. Populate if the sprint splits into multiple waves or milestones.
|
||||
- Wave 1 · Vendor fork + plugin wiring (tasks 1–5): TODO; waiting on fork patching (90-019) and plugin rewire (90-020); CI gating (R2) must be resolved before running cross-platform validation (task 5).
|
||||
- Wave 2 · Runtime registry wiring (tasks 8, 10, 15): Pending Authority provider/JWKS contract (R1) before hosts can register RU providers and migrate loaders.
|
||||
- Wave 3 · PQ profile + regression tests (tasks 13–14): TODO; provider option design (R3) outstanding to keep DSSE/Merkle behavior deterministic across providers.
|
||||
|
||||
## Interlocks
|
||||
- AUTH-CRYPTO-90-001 contract publication is required before runtime wiring tasks (8, 10, 15) proceed.
|
||||
@@ -46,9 +51,9 @@
|
||||
- PQ provider option design must align with registry abstractions to avoid divergent hashing behavior (tasks 13–14).
|
||||
|
||||
## Upcoming Checkpoints
|
||||
- 2025-11-19 · Draft Authority provider/JWKS contract to unblock AUTH-CRYPTO-90-001. Owner: Authority Core.
|
||||
- 2025-11-21 · Decide CI gating approach for CryptoPro/PKCS#11 tests. Owner: Security Guild.
|
||||
- 2025-11-24 · Fork patch status (SEC-CRYPTO-90-019) and plugin rewire plan (SEC-CRYPTO-90-020). Owner: Security Guild.
|
||||
- 2025-11-19 · Draft Authority provider/JWKS contract to unblock AUTH-CRYPTO-90-001. Owner: Authority Core. (Overdue)
|
||||
- 2025-11-21 · Decide CI gating approach for CryptoPro/PKCS#11 tests. Owner: Security Guild. (Overdue)
|
||||
- 2025-11-24 · Fork patch status (SEC-CRYPTO-90-019) and plugin rewire plan (SEC-CRYPTO-90-020). Owner: Security Guild. (Due in 2 days)
|
||||
|
||||
## Action Tracker
|
||||
| Action | Owner | Due (UTC) | Status | Notes |
|
||||
@@ -71,6 +76,9 @@
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-11-22 | Added module architecture docs to prereqs (Authority, Scanner, Attestor) to support registry wiring and contract review; no task status changes. | Planning |
|
||||
| 2025-11-22 | Marked tasks 8 and 15 BLOCKED pending Authority provider/JWKS contract (R1); no other status changes. | Planning |
|
||||
| 2025-11-22 | Added wave snapshots; flagged overdue checkpoints (Authority contract, CI gating) and upcoming fork patch checkpoint; no task status changes. | Planning |
|
||||
| 2025-11-22 | Normalised sections to docs/implplan template (added Wave/Interlocks/Action Tracker, reordered checkpoints/risks). No task status changes. | Planning |
|
||||
| 2025-11-20 | Published Authority crypto provider/JWKS prep note (`docs/modules/authority/prep/2025-11-20-auth-crypto-provider-prep.md`); marked PREP-AUTH-CRYPTO-90-001 DONE. | Implementer |
|
||||
| 2025-11-19 | Assigned PREP owners/dates; see Delivery Tracker. | Planning |
|
||||
|
||||
@@ -1 +1,18 @@
|
||||
# Blocked Tree\n- EXCITITOR-CONSOLE-23-001 [BLOCKED]\n- EXCITITOR-CONSOLE-23-002 [BLOCKED]\n- EXCITITOR-CONSOLE-23-003 [BLOCKED]\n- EXCITITOR-CORE-AOC-19-002 [BLOCKED]\n- EXCITITOR-CORE-AOC-19-003 [BLOCKED]\n- EXCITITOR-CORE-AOC-19-004 [DOING]\n- EXCITITOR-CORE-AOC-19-013 [DOING]\n- EXCITITOR-GRAPH-21-001 [DOING]\n- EXCITITOR-GRAPH-21-002 [DOING]\n- EXCITITOR-GRAPH-21-005 [DOING]\n- EXCITITOR-GRAPH-24-101 [BLOCKED]\n- EXCITITOR-GRAPH-24-102 [BLOCKED]\n- Consensus removal [DOING]\n- Graph overlays [BLOCKED]\n*** End Patch пользователя to=functions.apply_patchоны Are you покрывая json PostLayout runnerиц received анимация. ҳа료 мон】 JSON" code|{
|
||||
# Blocked Tree
|
||||
|
||||
- EXCITITOR-CONSOLE-23-001 [BLOCKED]
|
||||
- EXCITITOR-CONSOLE-23-002 [BLOCKED]
|
||||
- EXCITITOR-CONSOLE-23-003 [BLOCKED]
|
||||
- EXCITITOR-CORE-AOC-19-002 [BLOCKED]
|
||||
- EXCITITOR-CORE-AOC-19-003 [BLOCKED]
|
||||
- EXCITITOR-CORE-AOC-19-004 [DOING]
|
||||
- EXCITITOR-CORE-AOC-19-013 [DOING]
|
||||
- EXCITITOR-GRAPH-21-001 [DOING]
|
||||
- EXCITITOR-GRAPH-21-002 [DOING]
|
||||
- EXCITITOR-GRAPH-21-005 [DOING]
|
||||
- EXCITITOR-GRAPH-24-101 [BLOCKED]
|
||||
- EXCITITOR-GRAPH-24-102 [BLOCKED]
|
||||
- Consensus removal [DOING]
|
||||
- Graph overlays [BLOCKED]
|
||||
- PROV-OBS-53-002 [BLOCKED] · Await CI rerun to clear MSB6006 (see SPRINT_0513_0001_0001_provenance)
|
||||
- PROV-OBS-53-003 [BLOCKED] · Blocked on PROV-OBS-53-002 CI verification (see SPRINT_0513_0001_0001_provenance)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -104,7 +104,8 @@ _Frozen v1 (add-only) — approved 2025-11-17 for CONCELIER-LNM-21-001/002/101._
|
||||
"properties":{
|
||||
"field":{"bsonType":"string"},
|
||||
"reason":{"bsonType":"string"},
|
||||
"values":{"bsonType":"array","items":{"bsonType":"string"}}
|
||||
"values":{"bsonType":"array","items":{"bsonType":"string"}},
|
||||
"sourceIds":{"bsonType":"array","items":{"bsonType":"string"}}
|
||||
}}},
|
||||
"createdAt":{"bsonType":"date"},
|
||||
"builtByJobId":{"bsonType":"string"},
|
||||
@@ -121,6 +122,7 @@ _Frozen v1 (add-only) — approved 2025-11-17 for CONCELIER-LNM-21-001/002/101._
|
||||
- Built from a set of observation IDs; never overwrites observations.
|
||||
- Carries the hash list of source observations for audit/replay.
|
||||
- Deterministic sort: observations sorted by `source, advisoryId, fetchedAt` before hashing.
|
||||
- Conflicts are additive only and now carry optional `sourceIds[]` to trace which upstream sources produced divergent values.
|
||||
|
||||
## Indexes (Mongo)
|
||||
- Observations: `{ tenantId:1, source:1, advisoryId:1, provenance.fetchedAt:-1 }` (compound for ingest); `{ provenance.sourceArtifactSha:1 }` unique to avoid dup writes.
|
||||
|
||||
@@ -42,6 +42,7 @@
|
||||
- Each snapshot packages `nodes.jsonl`, `edges.jsonl`, `overlays/` plus manifest with hash, counts, and provenance. Export Center consumes these artefacts for graph-specific bundles.
|
||||
- Saved queries and overlays include deterministic IDs so Offline Kit consumers can import and replay results.
|
||||
- Runtime hosts register the SBOM ingest pipeline via `services.AddSbomIngestPipeline(...)`. Snapshot exports default to `./artifacts/graph-snapshots` but can be redirected with `STELLAOPS_GRAPH_SNAPSHOT_DIR` or the `SbomIngestOptions.SnapshotRootDirectory` callback.
|
||||
- Analytics overlays are exported as NDJSON (`overlays/clusters.ndjson`, `overlays/centrality.ndjson`) ordered by node id; `overlays/manifest.json` mirrors snapshot id and counts for offline parity.
|
||||
|
||||
## 6) Observability
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
## Deployment overlays
|
||||
- Helm/Compose should expose two timers for analytics: `GRAPH_ANALYTICS_CLUSTER_INTERVAL` and `GRAPH_ANALYTICS_CENTRALITY_INTERVAL` (ISO-8601 duration, default 5m). Map to `GraphAnalyticsOptions`.
|
||||
- Change-stream/backfill worker toggles via `GRAPH_CHANGE_POLL_INTERVAL`, `GRAPH_BACKFILL_INTERVAL`, `GRAPH_CHANGE_MAX_RETRIES`, `GRAPH_CHANGE_RETRY_BACKOFF`.
|
||||
- Mongo bindings (optional): `GRAPH_CHANGE_COLLECTION`, `GRAPH_CHANGE_SEQUENCE_FIELD`, `GRAPH_CHANGE_NODE_FIELD`, `GRAPH_CHANGE_EDGE_FIELD`, `GRAPH_CHANGE_IDEMPOTENCY_COLLECTION`, `GRAPH_ANALYTICS_SNAPSHOT_COLLECTION`, `GRAPH_ANALYTICS_PROGRESS_COLLECTION`.
|
||||
- New Mongo collections:
|
||||
- `graph_cluster_overlays` — cluster assignments (`tenant`, `snapshot_id`, `node_id`, `cluster_id`, `generated_at`).
|
||||
- `graph_centrality_overlays` — degree + betweenness approximations per node.
|
||||
@@ -25,6 +26,7 @@
|
||||
## Configuration defaults
|
||||
- Cluster/centrality intervals: 5 minutes; label-propagation iterations: 6; betweenness sample size: 12.
|
||||
- Change stream: poll every 5s, backfill every 15m, max retries 3 with 3s backoff, batch size 256.
|
||||
- Overlay exports: clusters/centrality written to `overlays/clusters.ndjson` and `overlays/centrality.ndjson` with manifest; ordered by `node_id` for deterministic bundle hashes.
|
||||
|
||||
## Notes
|
||||
- Analytics writes are idempotent (upserts keyed on tenant+snapshot+node_id). Change-stream processing is idempotent via sequence tokens persisted in `IIdempotencyStore` (Mongo or in-memory for tests).
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
# Graph API schema outline (prep for GRAPH-API-28-001)
|
||||
|
||||
Status: draft outline · Date: 2025-11-22 · Owner: Graph API Guild
|
||||
Scope: Establish OpenAPI/JSON schema primitives for search/query/paths/diff/export endpoints, tile streaming, budgets, and RBAC headers. This is a staging note for sprint 0207 Wave 1.
|
||||
|
||||
## 1) Shared headers and security
|
||||
- `X-Stella-Tenant` (required, string)
|
||||
- `Authorization: Bearer <token>`; scopes: `graph:read`, `graph:query`, `graph:export` as applicable per route.
|
||||
- `X-Request-Id` optional; echoed in responses.
|
||||
- Rate limit headers: `X-RateLimit-Remaining`, `Retry-After` for 429 cases.
|
||||
|
||||
## 2) Tile envelope (streaming NDJSON)
|
||||
```jsonc
|
||||
{
|
||||
"type": "node" | "edge" | "stats" | "cursor" | "diagnostic",
|
||||
"seq": 1,
|
||||
"cost": { "consumed": 12, "remaining": 988, "limit": 1000 },
|
||||
"data": { /* node/edge/payload depending on type */ }
|
||||
}
|
||||
```
|
||||
- Deterministic ordering: breadth-first by hop for paths/query; lexicographic by `id` inside each hop when stable ordering is needed.
|
||||
- Cursor tile: `{"type":"cursor","token":"opaque"}` for resume.
|
||||
- Stats tile: counts, depth reached, cache hit ratios.
|
||||
|
||||
## 3) `/graph/search` (POST)
|
||||
Request body (summary):
|
||||
- `query` (string; prefix/exact semantics), `kinds` (array of `node` kinds), `limit`, `tenant`, `filters` (labels, ecosystem, scope), `ordering`.
|
||||
Response: stream of tiles (`node` + minimal neighbor context), plus final cursor/diagnostic tile.
|
||||
Validation rules: enforce `limit <= 500`, reject empty query unless `filters` present.
|
||||
|
||||
## 4) `/graph/query` (POST)
|
||||
- Body: DSL expression or structured filter object; includes `budget` (nodes/edges cap, time cap), `overlays` requested (`policy`, `vex`, `advisory`), `explain`: `none|minimal|full`.
|
||||
- Response: streaming tiles with mixed `node`, `edge`, `stats`, `cursor`; budgets decremented per tile.
|
||||
- Errors: `429` budget exhausted with diagnostic tile including partial cursor.
|
||||
|
||||
## 5) `/graph/paths` (POST)
|
||||
- Body: `source_ids[]`, `target_ids[]`, `max_depth <= 6`, `constraints` (edge kinds, tenant, overlays allowed), `fanout_cap`.
|
||||
- Response: tiles grouped by path id; includes `hop` field for ordering; optional `overlay_trace` when policy layer requested.
|
||||
|
||||
## 6) `/graph/diff` (POST)
|
||||
- Body: `snapshot_a`, `snapshot_b`, optional `filters` (tenant, kinds, advisory keys).
|
||||
- Response: tiles of `node_added`, `node_removed`, `edge_added`, `edge_removed`, `overlay_delta` (policy/vex/advisory), plus `manifest` tile with counts and checksums.
|
||||
|
||||
## 7) `/graph/export` (POST)
|
||||
- Body: `formats[]` (`graphml`, `csv`, `ndjson`, `png`, `svg`), `snapshot_id` or `query_ref`, `include_overlays`.
|
||||
- Response: job ticket `{ job_id, status_url, checksum_manifest_url }`; downloads streamed with deterministic manifests.
|
||||
|
||||
## 8) Error schema (shared)
|
||||
```jsonc
|
||||
{
|
||||
"error": "GRAPH_BUDGET_EXCEEDED" | "GRAPH_VALIDATION_FAILED" | "GRAPH_RATE_LIMITED",
|
||||
"message": "human-readable",
|
||||
"details": {},
|
||||
"request_id": "..."
|
||||
}
|
||||
```
|
||||
|
||||
## 9) Open questions to settle before sign-off
|
||||
- Final DSL surface vs structured filters for `/graph/query`.
|
||||
- Exact cache key and eviction policy for overlays requested via query.
|
||||
- PNG/SVG render payload (pre-signed URL vs inline streaming) and size caps.
|
||||
|
||||
## 10) Next steps
|
||||
- Convert this outline into OpenAPI components + schemas in repo (`docs/api/graph-gateway-spec-draft.yaml`) by 2025-11-24.
|
||||
- Add JSON Schema fragments for tiles and error payloads to reuse in SDKs.
|
||||
- Review with Policy Engine Guild to lock overlay contract version for GRAPH-API-28-006.
|
||||
@@ -57,7 +57,7 @@ This guide translates the deterministic reachability blueprint into concrete wor
|
||||
| **402** | Replay & Attest | Manifest v2, DSSE envelopes, Authority/Rekor publishing | Replay packs include hashes + analyzer fingerprint; DSSE statements passed integration; Rekor mirror updated |
|
||||
| **403** | Policy & Explain | VEX generation, SPL predicates, UI/CLI explainers | Policy engine uses reachability states, CLI `stella graph explain` returns signed paths, UI shows explain drawer |
|
||||
|
||||
Each sprint is two weeks; refer to `docs/implplan/SPRINT_401_reachability_evidence_chain.md` (new) for per-task tracking.
|
||||
Each sprint is two weeks; refer to `docs/implplan/SPRINT_0401_0001_0001_reachability_evidence_chain.md` (new) for per-task tracking.
|
||||
|
||||
---
|
||||
|
||||
|
||||
5
local-nugets/coverlet.collector/6.0.4/.nupkg.metadata
Normal file
5
local-nugets/coverlet.collector/6.0.4/.nupkg.metadata
Normal file
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "lkhqpF8Pu2Y7IiN7OntbsTtdbpR1syMsm2F3IgX6ootA4ffRqWL5jF7XipHuZQTdVuWG/gVAAcf8mjk8Tz0xPg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
local-nugets/coverlet.collector/6.0.4/.signature.p7s
Normal file
BIN
local-nugets/coverlet.collector/6.0.4/.signature.p7s
Normal file
Binary file not shown.
185
local-nugets/coverlet.collector/6.0.4/VSTestIntegration.md
Normal file
185
local-nugets/coverlet.collector/6.0.4/VSTestIntegration.md
Normal file
@@ -0,0 +1,185 @@
|
||||
# Coverlet integration with VSTest (a.k.a. Visual Studio Test Platform)
|
||||
|
||||
**Supported runtime versions**:
|
||||
|
||||
Since version `6.0.0`
|
||||
|
||||
* .NET Core >= 6.0
|
||||
* .NET Framework >= 4.6.2
|
||||
|
||||
As explained in quick start section, to use collectors you need to run *SDK v6.0.100* (LTS) or newer and your project file must reference `coverlet.collector` and a minimum version of `Microsoft.NET.Test.Sdk`.
|
||||
|
||||
A sample project file looks like:
|
||||
|
||||
```xml
|
||||
<Project Sdk="Microsoft.NET.Sdk">
|
||||
<PropertyGroup>
|
||||
<TargetFrameworks>net6.0;net48</TargetFrameworks>
|
||||
</PropertyGroup>
|
||||
<ItemGroup>
|
||||
<!-- Minimum version 17.7.0 -->
|
||||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
|
||||
<!-- Update this reference when new version is released -->
|
||||
<PackageReference Include="coverlet.collector" Version="6.0.0">
|
||||
<PrivateAssets>all</PrivateAssets>
|
||||
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
|
||||
</PackageReference>
|
||||
...
|
||||
</ItemGroup>
|
||||
...
|
||||
</Project>
|
||||
```
|
||||
|
||||
The reference to `coverlet.collector` package is included by default with xunit template test (`dotnet new xunit`), you only need to update the package for new versions like any other package reference.
|
||||
|
||||
With correct reference in place you can run coverage through default dotnet test CLI verbs:
|
||||
|
||||
```shell
|
||||
dotnet test --collect:"XPlat Code Coverage"
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```text
|
||||
dotnet publish
|
||||
...
|
||||
... -> C:\project\bin\Debug\netcoreapp3.0\testdll.dll
|
||||
... -> C:\project\bin\Debug\netcoreapp3.0\publish\
|
||||
...
|
||||
dotnet vstest C:\project\bin\Debug\netcoreapp3.0\publish\testdll.dll --collect:"XPlat Code Coverage"
|
||||
```
|
||||
|
||||
As you can see in case of `vstest` verb you **must** publish project before.
|
||||
|
||||
At the end of tests you'll find the coverage file data under default VSTest platform directory `TestResults`
|
||||
|
||||
```text
|
||||
Attachments:
|
||||
C:\git\coverlet\Documentation\Examples\VSTest\HelloWorld\XUnitTestProject1\TestResults\bc5e983b-d7a8-4f17-8c0a-8a8831a4a891\coverage.cobertura.xml
|
||||
Test Run Successful.
|
||||
Total tests: 1
|
||||
Passed: 1
|
||||
Total time: 2,5451 Seconds
|
||||
```
|
||||
|
||||
You can change the output directory using the standard `dotnet test` switch `--results-directory`
|
||||
|
||||
>*NB: By design VSTest platform will create your file under a random named folder(guid string) so if you need stable path to load file to some gui report system(i.e. coveralls, codecov, reportgenerator etc..) that doesn't support glob patterns or hierarchical search, you'll need to manually move resulting file to a predictable folder*
|
||||
|
||||
## Coverlet options supported by VSTest integration
|
||||
|
||||
:warning:At the moment VSTest integration **doesn't support all features** of msbuild and .NET tool, for instance show result on console, report merging and threshold validation.
|
||||
We're working to fill the gaps.
|
||||
|
||||
> [!TIP]
|
||||
> *Some alternative solutions to merge coverage files*
|
||||
>
|
||||
> * use _dotnet-coverage_ tool and merge multiple coverage files
|
||||
>
|
||||
> `dotnet-coverage merge artifacts/coverage/**/coverage.cobertura.xml -f cobertura -o artifacts/coverage/coverage.xml`*
|
||||
>
|
||||
> * use _dotnet-reportgenerator-globaltool_ to create a HTML report and a merged coverage file
|
||||
>
|
||||
> `reportgenerator -reports:"**/*.cobertura.xml" -targetdir:"artifacts\reports.cobertura" -reporttypes:"HtmlInline_AzurePipelines_Dark;Cobertura"`
|
||||
|
||||
### Default option (if you don't specify a runsettings file)
|
||||
|
||||
Without specifying a runsettings file and calling coverlet by just the name of the collector, the result of the generated coverage output is by default in cobertura format.
|
||||
|
||||
```shell
|
||||
dotnet test --collect:"XPlat Code Coverage"
|
||||
```
|
||||
|
||||
The output format of the coverage report can also be changed without a runsettings file by specifying it in a parameter. The supported formats are lcov, opencover, cobertura, teamcity, json (default coverlet proprietary format).
|
||||
|
||||
```shell
|
||||
dotnet test --collect:"XPlat Code Coverage;Format=json"
|
||||
```
|
||||
|
||||
It is even possible to specify the coverage output in multiple formats.
|
||||
|
||||
```shell
|
||||
dotnet test --collect:"XPlat Code Coverage;Format=json,lcov,cobertura"
|
||||
```
|
||||
|
||||
### Advanced Options (Supported via runsettings)
|
||||
|
||||
These are a list of options that are supported by coverlet. These can be specified as datacollector configurations in the runsettings.
|
||||
|
||||
| Option | Summary |
|
||||
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Format | Coverage output format. These are either cobertura, json, lcov, opencover or teamcity as well as combinations of these formats. |
|
||||
| Exclude | Exclude from code coverage analysing using filter expressions. |
|
||||
| ExcludeByAttribute | Exclude a method, an entire class or assembly from code coverage decorated by an attribute. |
|
||||
| ExcludeByFile | Ignore specific source files from code coverage. |
|
||||
| Include | Explicitly set what to include in code coverage analysis using filter expressions. |
|
||||
| IncludeDirectory | Explicitly set which directories to include in code coverage analysis. |
|
||||
| SingleHit | Specifies whether to limit code coverage hit reporting to a single hit for each location. |
|
||||
| UseSourceLink | Specifies whether to use SourceLink URIs in place of file system paths. |
|
||||
| IncludeTestAssembly | Include coverage of the test assembly. |
|
||||
| SkipAutoProps | Neither track nor record auto-implemented properties. |
|
||||
| DoesNotReturnAttribute | Methods marked with these attributes are known not to return, statements following them will be excluded from coverage |
|
||||
| DeterministicReport | Generates deterministic report in context of deterministic build. Take a look at [documentation](DeterministicBuild.md) for further informations.
|
||||
| ExcludeAssembliesWithoutSources | Specifies whether to exclude assemblies without source. Options are either MissingAll, MissingAny or None. Default is MissingAll.|
|
||||
|
||||
How to specify these options via runsettings?
|
||||
|
||||
```xml
|
||||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<RunSettings>
|
||||
<DataCollectionRunSettings>
|
||||
<DataCollectors>
|
||||
<DataCollector friendlyName="XPlat code coverage">
|
||||
<Configuration>
|
||||
<Format>json,cobertura,lcov,teamcity,opencover</Format>
|
||||
<Exclude>[coverlet.*.tests?]*,[*]Coverlet.Core*</Exclude> <!-- [Assembly-Filter]Type-Filter -->
|
||||
<Include>[coverlet.*]*,[*]Coverlet.Core*</Include> <!-- [Assembly-Filter]Type-Filter -->
|
||||
<ExcludeByAttribute>Obsolete,GeneratedCodeAttribute,CompilerGeneratedAttribute</ExcludeByAttribute>
|
||||
<ExcludeByFile>**/dir1/class1.cs,**/dir2/*.cs,**/dir3/**/*.cs,</ExcludeByFile> <!-- Globbing filter -->
|
||||
<IncludeDirectory>../dir1/,../dir2/,</IncludeDirectory>
|
||||
<SingleHit>false</SingleHit>
|
||||
<UseSourceLink>true</UseSourceLink>
|
||||
<IncludeTestAssembly>true</IncludeTestAssembly>
|
||||
<SkipAutoProps>true</SkipAutoProps>
|
||||
<DeterministicReport>false</DeterministicReport>
|
||||
<ExcludeAssembliesWithoutSources>MissingAll,MissingAny,None</ExcludeAssembliesWithoutSources>
|
||||
</Configuration>
|
||||
</DataCollector>
|
||||
</DataCollectors>
|
||||
</DataCollectionRunSettings>
|
||||
</RunSettings>
|
||||
```
|
||||
|
||||
Filtering details are present on [msbuild guide](MSBuildIntegration.md#excluding-from-coverage).
|
||||
|
||||
This runsettings file can easily be provided using command line option as given :
|
||||
|
||||
* `dotnet test --collect:"XPlat Code Coverage" --settings coverlet.runsettings`
|
||||
* `dotnet vstest C:\project\bin\Debug\netcoreapp3.0\publish\testdll.dll --collect:"XPlat Code Coverage" --settings coverlet.runsettings`
|
||||
|
||||
Take a look at our [`HelloWorld`](Examples/VSTest/HelloWorld/HowTo.md) sample.
|
||||
|
||||
### Passing runsettings arguments through commandline
|
||||
|
||||
You can avoid passing a `runsettings` file to `dotnet test` driver by using the xml flat syntax in the command line.
|
||||
|
||||
For instance if you want to set the `Format` element as a runsettings option you can use this syntax:
|
||||
|
||||
```shell
|
||||
dotnet test --collect:"XPlat Code Coverage" -- DataCollectionRunSettings.DataCollectors.DataCollector.Configuration.Format=json,cobertura,lcov,teamcity,opencover
|
||||
```
|
||||
|
||||
Take a look here for further information:<https://github.com/microsoft/vstest/blob/main/docs/RunSettingsArguments.md>
|
||||
|
||||
## How it works
|
||||
|
||||
Coverlet integration is implemented with the help of [datacollectors](https://github.com/microsoft/vstest/blob/main/docs/extensions/datacollector.md).
|
||||
When we specify `--collect:"XPlat Code Coverage"` VSTest platform tries to load coverlet collectors inside `coverlet.collector.dll`
|
||||
|
||||
1. Out-of-proc Datacollector: The outproc collector run in a separate process(datacollector.exe/datacollector.dll) than the process in which tests are being executed(testhost*.exe/testhost.dll). This datacollector is responsible for calling into Coverlet APIs for instrumenting dlls, collecting coverage results and sending the coverage output file back to test platform.
|
||||
|
||||
1. In-proc Datacollector: The in-proc collector is loaded in the testhost process executing the tests. This collector will be needed to remove the dependency on the process exit handler to flush the hit files and avoid to hit this [serious known issue](KnownIssues.md#1-vstest-stops-process-execution-earlydotnet-test)
|
||||
|
||||
## Known Issues
|
||||
|
||||
For a comprehensive list of known issues check the detailed documentation [KnownIssues.md](KnownIssues.md)
|
||||
BIN
local-nugets/coverlet.collector/6.0.4/coverlet-icon.png
Normal file
BIN
local-nugets/coverlet.collector/6.0.4/coverlet-icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.5 KiB |
Binary file not shown.
@@ -0,0 +1 @@
|
||||
oKvOHvCNwSZ8vgfejYvGmjKjVZ6pzVXeHqNAutE5c2TDBbME4ainGOQVSeDmQSPucG+zjKI+qz+VmSi5QZPpOQ==
|
||||
@@ -0,0 +1,20 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>coverlet.collector</id>
|
||||
<version>6.0.4</version>
|
||||
<title>coverlet.collector</title>
|
||||
<authors>tonerdo</authors>
|
||||
<developmentDependency>true</developmentDependency>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>coverlet-icon.png</icon>
|
||||
<readme>VSTestIntegration.md</readme>
|
||||
<projectUrl>https://github.com/coverlet-coverage/coverlet</projectUrl>
|
||||
<iconUrl>https://raw.githubusercontent.com/tonerdo/coverlet/master/_assets/coverlet-icon.svg?sanitize=true</iconUrl>
|
||||
<description>Coverlet is a cross platform code coverage library for .NET, with support for line, branch and method coverage.</description>
|
||||
<releaseNotes>https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/Changelog.md</releaseNotes>
|
||||
<tags>coverage testing unit-test lcov opencover quality</tags>
|
||||
<repository type="git" url="https://github.com/coverlet-coverage/coverlet.git" commit="90b21079d43cffae3a18f264e00962b9c8a1d57a" />
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "bhBB826R5K+3C6kpBUJWnJHQRVfIXWMYMv4Kevpyq/HTAdZxCMltVY7w8IVgzHiI1yL+lLhSR7lIPnSRlYYiTA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.AspNetCore.TestHost</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<description>ASP.NET Core web server for writing and running tests.
|
||||
|
||||
This package was built from the source code at https://github.com/dotnet/dotnet/tree/89c8f6a112d37d2ea8b77821e56d170a1bccdc5a</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>aspnetcore hosting testing</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework="net10.0" />
|
||||
</dependencies>
|
||||
<frameworkReferences><group targetFramework="net10.0"><frameworkReference name="Microsoft.AspNetCore.App" /></group></frameworkReferences></metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,66 @@
|
||||
## About
|
||||
|
||||
`Microsoft.AspNetCore.TestHost` provides an ASP.NET Core web server for testing middleware in isolation.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Instantiate an app pipeline containing only the components that you need to test
|
||||
* Send custom requests to verify middleware behavior
|
||||
|
||||
## How to Use
|
||||
|
||||
To use `Microsoft.AspNetCore.TestHost`, follow these steps:
|
||||
|
||||
### Installation
|
||||
|
||||
```shell
|
||||
dotnet add package Microsoft.AspNetCore.TestHost
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
To set up the `TestServer`, configure it in your test project. Here's an example:
|
||||
|
||||
```csharp
|
||||
[Fact]
|
||||
public async Task MiddlewareTest_ReturnsNotFoundForRequest()
|
||||
{
|
||||
// Build and start a host that uses TestServer
|
||||
using var host = await new HostBuilder()
|
||||
.ConfigureWebHost(builder =>
|
||||
{
|
||||
builder.UseTestServer()
|
||||
.ConfigureServices(services =>
|
||||
{
|
||||
// Add any required services that the middleware uses
|
||||
services.AddMyServices();
|
||||
})
|
||||
.Configure(app =>
|
||||
{
|
||||
// Configure the processing pipeline to use the middleware
|
||||
// for the test
|
||||
app.UseMiddleware<MyMiddleware>();
|
||||
});
|
||||
})
|
||||
.StartAsync();
|
||||
|
||||
var response = await host.GetTestClient().GetAsync("/");
|
||||
|
||||
Assert.Equal(HttpStatusCode.NotFound, response.StatusCode);
|
||||
}
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
The main types provided by this package are:
|
||||
|
||||
* `TestServer`: An `IServer` implementation for executing tests
|
||||
* `TestServerOptions`: Provides options for configuring a `TestServer`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/test/middleware) for testing middleware in ASP.NET Core.
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
`Microsoft.AspNetCore.TestHost` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,404 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.TestHost</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.ClientHandler">
|
||||
<summary>
|
||||
This adapts HttpRequestMessages to ASP.NET Core requests, dispatches them through the pipeline, and returns the
|
||||
associated HttpResponseMessage.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.ClientHandler.#ctor(Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.TestHost.ApplicationWrapper,System.Action{Microsoft.AspNetCore.Http.HttpContext})">
|
||||
<summary>
|
||||
Create a new handler.
|
||||
</summary>
|
||||
<param name="pathBase">The base path.</param>
|
||||
<param name="application">The <see cref="T:Microsoft.AspNetCore.Hosting.Server.IHttpApplication`1"/>.</param>
|
||||
<param name="additionalContextConfiguration">The action to additionally configure <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.ClientHandler.Send(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
This synchronous method is not supported due to the risk of threadpool exhaustion when running multiple tests in parallel.
|
||||
</summary>
|
||||
<param name="request">The <see cref="T:System.Net.Http.HttpRequestMessage"/>.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||||
<exception cref="T:System.NotSupportedException">Thrown unconditionally.</exception>
|
||||
<remarks>
|
||||
Use the asynchronous version of this method, <see cref="M:Microsoft.AspNetCore.TestHost.ClientHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)"/>, instead.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.ClientHandler.SendAsync(System.Net.Http.HttpRequestMessage,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
This adapts HttpRequestMessages to ASP.NET Core requests, dispatches them through the pipeline, and returns the
|
||||
associated HttpResponseMessage.
|
||||
</summary>
|
||||
<param name="request">The <see cref="T:System.Net.Http.HttpRequestMessage"/>.</param>
|
||||
<param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>
|
||||
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> returning the <see cref="T:System.Net.Http.HttpResponseMessage"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.HostBuilderTestServerExtensions">
|
||||
<summary>
|
||||
Contains extensions for retrieving properties from <see cref="T:Microsoft.Extensions.Hosting.IHost"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.HostBuilderTestServerExtensions.GetTestServer(Microsoft.Extensions.Hosting.IHost)">
|
||||
<summary>
|
||||
Retrieves the TestServer from the host services.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.HostBuilderTestServerExtensions.GetTestClient(Microsoft.Extensions.Hosting.IHost)">
|
||||
<summary>
|
||||
Retrieves the test client from the TestServer in the host services.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.HttpContextBuilder.SendAsync(System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Start processing the request.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.HttpResetTestException">
|
||||
<summary>
|
||||
Used to surface to the test client that the application invoked <see cref="M:Microsoft.AspNetCore.Http.Features.IHttpResetFeature.Reset(System.Int32)"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.HttpResetTestException.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Creates a new test exception
|
||||
</summary>
|
||||
<param name="errorCode">The error code passed to <see cref="M:Microsoft.AspNetCore.Http.Features.IHttpResetFeature.Reset(System.Int32)"/></param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.HttpResetTestException.ErrorCode">
|
||||
<summary>
|
||||
The error code passed to <see cref="M:Microsoft.AspNetCore.Http.Features.IHttpResetFeature.Reset(System.Int32)"/>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.RequestBuilder">
|
||||
<summary>
|
||||
Used to construct a HttpRequestMessage object.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.RequestBuilder.#ctor(Microsoft.AspNetCore.TestHost.TestServer,System.String)">
|
||||
<summary>
|
||||
Construct a new HttpRequestMessage with the given path.
|
||||
</summary>
|
||||
<param name="server"></param>
|
||||
<param name="path"></param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.RequestBuilder.TestServer">
|
||||
<summary>
|
||||
Gets the <see cref="P:Microsoft.AspNetCore.TestHost.RequestBuilder.TestServer"/> instance for which the request is being built.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.RequestBuilder.And(System.Action{System.Net.Http.HttpRequestMessage})">
|
||||
<summary>
|
||||
Configure any HttpRequestMessage properties.
|
||||
</summary>
|
||||
<param name="configure"></param>
|
||||
<returns>This <see cref="T:Microsoft.AspNetCore.TestHost.RequestBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.RequestBuilder.AddHeader(System.String,System.String)">
|
||||
<summary>
|
||||
Add the given header and value to the request or request content.
|
||||
</summary>
|
||||
<param name="name"></param>
|
||||
<param name="value"></param>
|
||||
<returns>This <see cref="T:Microsoft.AspNetCore.TestHost.RequestBuilder"/> for chaining.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.RequestBuilder.SendAsync(System.String)">
|
||||
<summary>
|
||||
Set the request method and start processing the request.
|
||||
</summary>
|
||||
<param name="method"></param>
|
||||
<returns>The resulting <see cref="T:System.Net.Http.HttpResponseMessage"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.RequestBuilder.GetAsync">
|
||||
<summary>
|
||||
Set the request method to GET and start processing the request.
|
||||
</summary>
|
||||
<returns>The resulting <see cref="T:System.Net.Http.HttpResponseMessage"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.RequestBuilder.PostAsync">
|
||||
<summary>
|
||||
Set the request method to POST and start processing the request.
|
||||
</summary>
|
||||
<returns>The resulting <see cref="T:System.Net.Http.HttpResponseMessage"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.ResponseBodyReaderStream">
|
||||
<summary>
|
||||
The client's view of the response body.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.TestServer">
|
||||
<summary>
|
||||
An <see cref="T:Microsoft.AspNetCore.Hosting.Server.IServer"/> implementation for executing tests.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.#ctor(System.IServiceProvider,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.TestHost.TestServerOptions})">
|
||||
<summary>
|
||||
For use with IHostBuilder.
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="optionsAccessor"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.#ctor(System.IServiceProvider,Microsoft.AspNetCore.Http.Features.IFeatureCollection,Microsoft.Extensions.Options.IOptions{Microsoft.AspNetCore.TestHost.TestServerOptions})">
|
||||
<summary>
|
||||
For use with IHostBuilder.
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="featureCollection"></param>
|
||||
<param name="optionsAccessor"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.#ctor(System.IServiceProvider)">
|
||||
<summary>
|
||||
For use with IHostBuilder.
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.#ctor(System.IServiceProvider,Microsoft.AspNetCore.Http.Features.IFeatureCollection)">
|
||||
<summary>
|
||||
For use with IHostBuilder.
|
||||
</summary>
|
||||
<param name="services"></param>
|
||||
<param name="featureCollection"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.#ctor(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
For use with IWebHostBuilder.
|
||||
</summary>
|
||||
<param name="builder"></param>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.#ctor(Microsoft.AspNetCore.Hosting.IWebHostBuilder,Microsoft.AspNetCore.Http.Features.IFeatureCollection)">
|
||||
<summary>
|
||||
For use with IWebHostBuilder.
|
||||
</summary>
|
||||
<param name="builder"></param>
|
||||
<param name="featureCollection"></param>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServer.BaseAddress">
|
||||
<summary>
|
||||
Gets or sets the base address associated with the HttpClient returned by the test server. Defaults to http://localhost/.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServer.Host">
|
||||
<summary>
|
||||
Gets the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" /> instance associated with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServer.Services">
|
||||
<summary>
|
||||
Gets the service provider associated with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServer.Features">
|
||||
<summary>
|
||||
Gets the collection of server features associated with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServer.AllowSynchronousIO">
|
||||
<summary>
|
||||
Gets or sets a value that controls whether synchronous IO is allowed for the <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Request"/> and <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Response"/>. The default value is <see langword="false" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServer.PreserveExecutionContext">
|
||||
<summary>
|
||||
Gets or sets a value that controls if <see cref="T:System.Threading.ExecutionContext"/> and <see cref="T:System.Threading.AsyncLocal`1"/> values are preserved from the client to the server. The default value is <see langword="false" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.CreateHandler">
|
||||
<summary>
|
||||
Creates a custom <see cref="T:System.Net.Http.HttpMessageHandler" /> for processing HTTP requests/responses with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.CreateHandler(System.Action{Microsoft.AspNetCore.Http.HttpContext})">
|
||||
<summary>
|
||||
Creates a custom <see cref="T:System.Net.Http.HttpMessageHandler" /> for processing HTTP requests/responses with custom configuration with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.CreateClient">
|
||||
<summary>
|
||||
Creates a <see cref="T:System.Net.Http.HttpClient" /> for processing HTTP requests/responses with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.CreateWebSocketClient">
|
||||
<summary>
|
||||
Creates a <see cref="T:Microsoft.AspNetCore.TestHost.WebSocketClient" /> for interacting with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.CreateRequest(System.String)">
|
||||
<summary>
|
||||
Begins constructing a request message for submission.
|
||||
</summary>
|
||||
<param name="path"></param>
|
||||
<returns><see cref="T:Microsoft.AspNetCore.TestHost.RequestBuilder"/> to use in constructing additional request details.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.SendAsync(System.Action{Microsoft.AspNetCore.Http.HttpContext},System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Creates, configures, sends, and returns a <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/>. This completes as soon as the response is started.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.TestServer.Dispose">
|
||||
<summary>
|
||||
Dispose the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHost" /> object associated with the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.TestServerOptions">
|
||||
<summary>
|
||||
Options for the test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServerOptions.AllowSynchronousIO">
|
||||
<summary>
|
||||
Gets or sets a value that controls whether synchronous IO is allowed for the <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Request"/> and <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Response"/>. The default value is <see langword="false" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServerOptions.PreserveExecutionContext">
|
||||
<summary>
|
||||
Gets or sets a value that controls if <see cref="T:System.Threading.ExecutionContext"/> and <see cref="T:System.Threading.AsyncLocal`1"/> values are preserved from the client to the server. The default value is <see langword="false" />.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.TestServerOptions.BaseAddress">
|
||||
<summary>
|
||||
Gets or sets the base address associated with the HttpClient returned by the test server. Defaults to http://localhost/.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions">
|
||||
<summary>
|
||||
Contains extensions for configuring the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.UseTestServer(Microsoft.AspNetCore.Hosting.IWebHostBuilder)">
|
||||
<summary>
|
||||
Enables the <see cref="T:Microsoft.AspNetCore.TestHost.TestServer" /> service.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.UseTestServer(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.AspNetCore.TestHost.TestServerOptions})">
|
||||
<summary>
|
||||
Enables the <see cref="T:Microsoft.AspNetCore.TestHost.TestServer" /> service.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="configureOptions">Configures test server options</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.GetTestServer(Microsoft.AspNetCore.Hosting.IWebHost)">
|
||||
<summary>
|
||||
Retrieves the TestServer from the host services.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.GetTestClient(Microsoft.AspNetCore.Hosting.IWebHost)">
|
||||
<summary>
|
||||
Retrieves the test client from the TestServer in the host services.
|
||||
</summary>
|
||||
<param name="host"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.ConfigureTestServices(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{Microsoft.Extensions.DependencyInjection.IServiceCollection})">
|
||||
<summary>
|
||||
Configures the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> instance with the services provided in <paramref name="servicesConfiguration" />.
|
||||
</summary>
|
||||
<param name="webHostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="servicesConfiguration">An <see cref="T:System.Action"/> that registers services onto the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.ConfigureTestContainer``1(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.Action{``0})">
|
||||
<summary>
|
||||
Configures the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> instance with the services provided in <paramref name="servicesConfiguration" />.
|
||||
</summary>
|
||||
<param name="webHostBuilder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="servicesConfiguration">An <see cref="T:System.Action"/> that registers services onto the <typeparamref name="TContainer"/>.</param>
|
||||
<typeparam name="TContainer">A collection of service descriptors.</typeparam>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.UseSolutionRelativeContentRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String)">
|
||||
<summary>
|
||||
Sets the content root of relative to the <paramref name="solutionRelativePath" />.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="solutionRelativePath">The directory of the solution file.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.UseSolutionRelativeContentRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String,System.String)">
|
||||
<summary>
|
||||
Sets the content root of relative to the <paramref name="solutionRelativePath" />.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="solutionRelativePath">The directory of the solution file.</param>
|
||||
<param name="solutionName">The name of the solution file to make the content root relative to.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.UseSolutionRelativeContentRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String,System.String,System.String)">
|
||||
<summary>
|
||||
Sets the content root of relative to the <paramref name="solutionRelativePath" />.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="solutionRelativePath">The directory of the solution file.</param>
|
||||
<param name="applicationBasePath">The root of the app's directory.</param>
|
||||
<param name="solutionName">The name of the solution file to make the content root relative to.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderExtensions.UseSolutionRelativeContentRoot(Microsoft.AspNetCore.Hosting.IWebHostBuilder,System.String,System.String,System.ReadOnlySpan{System.String})">
|
||||
<summary>
|
||||
Sets the content root of relative to the <paramref name="solutionRelativePath" />.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</param>
|
||||
<param name="solutionRelativePath">The directory of the solution file.</param>
|
||||
<param name="applicationBasePath">The root of the app's directory.</param>
|
||||
<param name="solutionNames">The names of the solution files to make the content root relative to. If empty, defaults to *.sln and *.slnx.</param>
|
||||
<returns>The <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.WebHostBuilderFactory">
|
||||
<summary>
|
||||
A factory for creating <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> instances.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderFactory.CreateFromAssemblyEntryPoint(System.Reflection.Assembly,System.String[])">
|
||||
<summary>
|
||||
Resolves an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> defined in the entry point of an assembly.
|
||||
</summary>
|
||||
<param name="assembly">The assembly to look for an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> in.</param>
|
||||
<param name="args">The arguments to use when creating the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> instance.</param>
|
||||
<returns>An <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> instance retrieved from the assembly in <paramref name="assembly"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebHostBuilderFactory.CreateFromTypesAssemblyEntryPoint``1(System.String[])">
|
||||
<summary>
|
||||
Resolves an <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder" /> defined in an assembly where <typeparamref name="T"/> is declared.
|
||||
</summary>
|
||||
<param name="args">The arguments to use when creating the <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> instance.</param>
|
||||
<typeparam name="T">Type contained in the target assembly</typeparam>
|
||||
<returns>An <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> instance retrieved from the assembly.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.TestHost.WebSocketClient">
|
||||
<summary>
|
||||
Provides a client for connecting over WebSockets to a test server.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.WebSocketClient.SubProtocols">
|
||||
<summary>
|
||||
Gets the list of WebSocket subprotocols that are established in the initial handshake.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.TestHost.WebSocketClient.ConfigureRequest">
|
||||
<summary>
|
||||
Gets or sets the handler used to configure the outgoing request to the WebSocket endpoint.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.TestHost.WebSocketClient.ConnectAsync(System.Uri,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Establishes a WebSocket connection to an endpoint.
|
||||
</summary>
|
||||
<param name="uri">The <see cref="T:System.Uri" /> of the endpoint.</param>
|
||||
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> used to terminate the connection.</param>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
8ndmr2NTgJ82Xv7QwF2OD8C/F7+SIbSFR9Au3nRkzOBVuZQwYt2yiSViy/wYDtkhyIlC5UrV/BHu7xBjViadrw==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "z2GYXGG6LjGoumT59xSB2dMnqSwQBjkxdDJmSJHwy5nPtZ435GXa6wj5hz/lRrAZ7NyXXxZNXVsiHXzHRru5eA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
BIN
local-nugets/microsoft.codecoverage/17.14.0/.signature.p7s
Normal file
BIN
local-nugets/microsoft.codecoverage/17.14.0/.signature.p7s
Normal file
Binary file not shown.
BIN
local-nugets/microsoft.codecoverage/17.14.0/Icon.png
Normal file
BIN
local-nugets/microsoft.codecoverage/17.14.0/Icon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,22 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.CodeCoverage</id>
|
||||
<version>17.14.0</version>
|
||||
<authors>Microsoft</authors>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<projectUrl>https://github.com/microsoft/vstest</projectUrl>
|
||||
<description>Microsoft.CodeCoverage package brings infra for collecting code coverage from vstest.console.exe and "dotnet test".</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>vstest visual-studio unittest testplatform mstest microsoft test testing codecoverage code-coverage</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/microsoft/vstest" commit="43aaae191867be953ee5f4699d650b5a43cc4557" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2" />
|
||||
<group targetFramework="net8.0" />
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,39 @@
|
||||
CodeCoverage
|
||||
|
||||
THIRD-PARTY SOFTWARE NOTICES AND INFORMATION
|
||||
Do Not Translate or Localize
|
||||
|
||||
This software incorporates components from the projects listed below. The original copyright notices
|
||||
and the licenses under which Microsoft received such components are set forth below and are provided for
|
||||
informational purposes only. Microsoft reserves all rights not expressly granted herein, whether by
|
||||
implication, estoppel or otherwise.
|
||||
|
||||
1. Mono.Cecil version 0.11.3 (https://github.com/jbevain/cecil)
|
||||
|
||||
|
||||
|
||||
%% Mono.Cecil NOTICES AND INFORMATION BEGIN HERE
|
||||
=========================================
|
||||
Copyright (c) 2008 - 2015 Jb Evain
|
||||
Copyright (c) 2008 - 2011 Novell, Inc.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
=========================================
|
||||
END OF Mono.Cecil NOTICES AND INFORMATION
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
NeXYhiKMa7ZiYo5QLtmUUIDphloSQjBZxZrcqcz8oB3WzM575QLFhNDXq5XZyDdXxZK0dFjd0k42NwBtVKj0Rg==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "mBMoXLsr5s1y2zOHWmKsE9veDcx8h1x/c3rz4baEdQKTeDcmQAPNbB54Pi/lhFO3K431eEq6PFbMgLaa6PHFfA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
@@ -0,0 +1,23 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) .NET Foundation and Contributors
|
||||
|
||||
All rights reserved.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,35 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.Binder</id>
|
||||
<version>8.0.0</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>Provides the functionality to bind an object to data in configuration providers for Microsoft.Extensions.Configuration. This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the Microsoft.Extensions.Configuration.ConfigurationBinder.Get extension method on the IConfiguration object. To use this package, you also need to install a package for the configuration provider, for example, Microsoft.Extensions.Configuration.Json for the JSON provider.</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/runtime" commit="5535e31a712343a63f5d7d796cd874e563e5ac14" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="8.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net6.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="8.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net7.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="8.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="8.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="8.0.0" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,138 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
Provides the functionality to bind an object to data in configuration providers for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the [Microsoft.Extensions.Configuration.ConfigurationBinder.Get](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder.get) extension method on the `IConfiguration` object. To use this package, you also need to install a package for the [configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration#configuration-providers), for example, [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/) for the JSON provider.
|
||||
|
||||
The types contained in this assembly use Reflection at runtime which is not friendly with linking or AOT. To better support linking and AOT as well as provide more efficient strongly-typed binding methods - this package also provides a source generator. This generator is enabled by default when a project sets `PublishAot` but can also be enabled using `<EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>`.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Configuring existing type instances from a configuration section (Bind)
|
||||
* Constructing new configured type instances from a configuration section (Get & GetValue)
|
||||
* Generating source to bind objects from a configuration section without a runtime reflection dependency.
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
The following example shows how to bind a JSON configuration section to .NET objects.
|
||||
|
||||
```cs
|
||||
using System;
|
||||
using Microsoft.Extensions.Configuration;
|
||||
|
||||
class Settings
|
||||
{
|
||||
public string Server { get; set; }
|
||||
public string Database { get; set; }
|
||||
public Endpoint[] Endpoints { get; set; }
|
||||
}
|
||||
|
||||
class Endpoint
|
||||
{
|
||||
public string IPAddress { get; set; }
|
||||
public int Port { get; set; }
|
||||
}
|
||||
|
||||
class Program
|
||||
{
|
||||
static void Main()
|
||||
{
|
||||
// Build a configuration object from JSON file
|
||||
IConfiguration config = new ConfigurationBuilder()
|
||||
.AddJsonFile("appsettings.json")
|
||||
.Build();
|
||||
|
||||
// Bind a configuration section to an instance of Settings class
|
||||
Settings settings = config.GetSection("Settings").Get<Settings>();
|
||||
|
||||
// Read simple values
|
||||
Console.WriteLine($"Server: {settings.Server}");
|
||||
Console.WriteLine($"Database: {settings.Database}");
|
||||
|
||||
// Read nested objects
|
||||
Console.WriteLine("Endpoints: ");
|
||||
|
||||
foreach (Endpoint endpoint in settings.Endpoints)
|
||||
{
|
||||
Console.WriteLine($"{endpoint.IPAddress}:{endpoint.Port}");
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
To run this example, include an `appsettings.json` file with the following content in your project:
|
||||
|
||||
```json
|
||||
{
|
||||
"Settings": {
|
||||
"Server": "example.com",
|
||||
"Database": "Northwind",
|
||||
"Endpoints": [
|
||||
{
|
||||
"IPAddress": "192.168.0.1",
|
||||
"Port": "80"
|
||||
},
|
||||
{
|
||||
"IPAddress": "192.168.10.1",
|
||||
"Port": "8080"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can include a configuration file using a code like this in your `.csproj` file:
|
||||
|
||||
```xml
|
||||
<ItemGroup>
|
||||
<Content Include="appsettings.json">
|
||||
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
|
||||
</Content>
|
||||
</ItemGroup>
|
||||
```
|
||||
|
||||
You can add the following property to enable the source generator. This requires a .NET 8.0 SDK or later.
|
||||
```xml
|
||||
<PropertyGroup>
|
||||
<EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>
|
||||
</PropertyGroup>
|
||||
```
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `Microsoft.Extensions.Configuration.ConfigurationBinder`
|
||||
* `Microsoft.Extensions.Configuration.BinderOptions`
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation -->
|
||||
|
||||
* [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration)
|
||||
|
||||
## Related Packages
|
||||
|
||||
<!-- The related packages associated with this package -->
|
||||
* [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration)
|
||||
* [Microsoft.Extensions.Configuration.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Abstractions)
|
||||
* [Microsoft.Extensions.Configuration.CommandLine](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.CommandLine)
|
||||
* [Microsoft.Extensions.Configuration.EnvironmentVariables](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.EnvironmentVariables)
|
||||
* [Microsoft.Extensions.Configuration.FileExtensions](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.FileExtensions)
|
||||
* [Microsoft.Extensions.Configuration.Ini](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Ini)
|
||||
* [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json)
|
||||
* [Microsoft.Extensions.Configuration.UserSecrets](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.UserSecrets)
|
||||
* [Microsoft.Extensions.Configuration.Xml](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Xml)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Configuration.Binder is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,31 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_Binder">
|
||||
<PropertyGroup Condition="'$(EnableConfigurationBindingGenerator)' == 'true'">
|
||||
<!-- The configuration binding source generator uses a preview version of the compiler interceptors feature. Enable it implicitly when the generator is enabled. -->
|
||||
<InterceptorsPreviewNamespaces>$(InterceptorsPreviewNamespaces);Microsoft.Extensions.Configuration.Binder.SourceGeneration</InterceptorsPreviewNamespaces>
|
||||
</PropertyGroup>
|
||||
|
||||
<Target Name="_Microsoft_Extensions_Configuration_Binder_RemoveAnalyzer"
|
||||
Condition="'$(EnableConfigurationBindingGenerator)' != 'true'"
|
||||
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets">
|
||||
|
||||
<ItemGroup>
|
||||
<Analyzer Remove="@(Analyzer->WithMetadataValue('NuGetPackageId', 'Microsoft.Extensions.Configuration.Binder'))" />
|
||||
</ItemGroup>
|
||||
</Target>
|
||||
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_Binder"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<PropertyGroup>
|
||||
<_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework
|
||||
Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'netcoreapp2.0')) AND
|
||||
!$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net6.0'))"
|
||||
>net6.0</_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework>
|
||||
<_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework
|
||||
Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net461')) AND
|
||||
!$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net462'))"
|
||||
>net462</_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework>
|
||||
</PropertyGroup>
|
||||
<Warning Condition="'$(_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework)' != ''"
|
||||
Text="Microsoft.Extensions.Configuration.Binder doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to $(_Microsoft_Extensions_Configuration_Binder_Compatible_TargetFramework) or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,623 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
When false (the default), the binder will only attempt to set public properties.
|
||||
If true, the binder will attempt to set all non read-only properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
When false (the default), no exceptions are thrown when trying to convert a value or when a configuration
|
||||
key is found for which the provided model object does not have an appropriate property which matches the key's name.
|
||||
When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
|
||||
of the error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
||||
<summary>
|
||||
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
||||
if the specified string is <see langword="null"/> or whitespace respectively.
|
||||
</summary>
|
||||
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
||||
<param name="paramName">The name of the parameter being checked.</param>
|
||||
<returns>The original value of <paramref name="argument"/>.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
||||
<summary>
|
||||
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which members are being accessed during the execution
|
||||
of a program.
|
||||
|
||||
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
||||
|
||||
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
||||
that the string represents a fully qualified type name.
|
||||
|
||||
When this attribute is applied to a class, interface, or struct, the members specified
|
||||
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
||||
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
||||
|
||||
If the attribute is applied to a method it's treated as a special case and it implies
|
||||
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
||||
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
||||
will use it there).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires dynamic access to code that is not referenced
|
||||
statically, for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
||||
code from an application.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of unreferenced code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of unreferenced code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires unreferenced code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
||||
<summary>
|
||||
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
||||
single code artifact.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
||||
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
||||
class, specifying the category of the tool and the identifier for an analysis rule.
|
||||
</summary>
|
||||
<param name="category">The category for the attribute.</param>
|
||||
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
||||
<summary>
|
||||
Gets the category identifying the classification of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
||||
for which a message suppression attribute applies.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
||||
<summary>
|
||||
Gets the identifier of the analysis tool rule to be suppressed.
|
||||
</summary>
|
||||
<remarks>
|
||||
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
||||
properties form a unique check identifier.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
||||
<summary>
|
||||
Gets or sets the scope of the code that is relevant for the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The Scope property is an optional argument that specifies the metadata scope for which
|
||||
the attribute is relevant.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
||||
<summary>
|
||||
Gets or sets a fully qualified path that represents the target of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
||||
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
||||
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
||||
The analysis tool user interface should be capable of automatically formatting the parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
||||
<summary>
|
||||
Gets or sets an optional argument expanding on exclusion criteria.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
||||
exclusion where the literal metadata target is not sufficiently precise. For example,
|
||||
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
||||
and it may be desirable to suppress a violation against a statement in the method that will
|
||||
give a rule violation, but not against all statements in the method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
||||
<summary>
|
||||
Gets or sets the justification for suppressing the code analysis message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires the ability to generate new code at runtime,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of dynamic code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of dynamic code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires dynamic code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,285 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
When false (the default), the binder will only attempt to set public properties.
|
||||
If true, the binder will attempt to set all non read-only properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
When false (the default), no exceptions are thrown when trying to convert a value or when a configuration
|
||||
key is found for which the provided model object does not have an appropriate property which matches the key's name.
|
||||
When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
|
||||
of the error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
||||
<summary>
|
||||
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
||||
if the specified string is <see langword="null"/> or whitespace respectively.
|
||||
</summary>
|
||||
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
||||
<param name="paramName">The name of the parameter being checked.</param>
|
||||
<returns>The original value of <paramref name="argument"/>.</returns>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires the ability to generate new code at runtime,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of dynamic code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of dynamic code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires dynamic code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,185 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
When false (the default), the binder will only attempt to set public properties.
|
||||
If true, the binder will attempt to set all non read-only properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
When false (the default), no exceptions are thrown when trying to convert a value or when a configuration
|
||||
key is found for which the provided model object does not have an appropriate property which matches the key's name.
|
||||
When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
|
||||
of the error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
||||
<summary>
|
||||
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
||||
if the specified string is <see langword="null"/> or whitespace respectively.
|
||||
</summary>
|
||||
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
||||
<param name="paramName">The name of the parameter being checked.</param>
|
||||
<returns>The original value of <paramref name="argument"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,185 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
When false (the default), the binder will only attempt to set public properties.
|
||||
If true, the binder will attempt to set all non read-only properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
When false (the default), no exceptions are thrown when trying to convert a value or when a configuration
|
||||
key is found for which the provided model object does not have an appropriate property which matches the key's name.
|
||||
When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
|
||||
of the error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
||||
<summary>
|
||||
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
||||
if the specified string is <see langword="null"/> or whitespace respectively.
|
||||
</summary>
|
||||
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
||||
<param name="paramName">The name of the parameter being checked.</param>
|
||||
<returns>The original value of <paramref name="argument"/>.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,623 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.Binder</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.BinderOptions">
|
||||
<summary>
|
||||
Options class used by the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBinder"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.BindNonPublicProperties">
|
||||
<summary>
|
||||
When false (the default), the binder will only attempt to set public properties.
|
||||
If true, the binder will attempt to set all non read-only properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.BinderOptions.ErrorOnUnknownConfiguration">
|
||||
<summary>
|
||||
When false (the default), no exceptions are thrown when trying to convert a value or when a configuration
|
||||
key is found for which the provided model object does not have an appropriate property which matches the key's name.
|
||||
When true, an <see cref="T:System.InvalidOperationException"/> is thrown with a description
|
||||
of the error.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.ConfigurationBinder">
|
||||
<summary>
|
||||
Static helper class that allows binding strongly typed objects to configuration values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get``1(Microsoft.Extensions.Configuration.IConfiguration,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<typeparam name="T">The type of the new instance to bind.</typeparam>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance of T if successful, default(T) otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type)">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Get(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the configuration instance to a new instance of type T.
|
||||
If this configuration section has a value, that will be used.
|
||||
Otherwise binding by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="type">The type of the new instance to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
<returns>The new instance if successful, null otherwise.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.String,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to the configuration section specified by the key by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="key">The key of the configuration section to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object)">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(Microsoft.Extensions.Configuration.IConfiguration,System.Object,System.Action{Microsoft.Extensions.Configuration.BinderOptions})">
|
||||
<summary>
|
||||
Attempts to bind the given object instance to configuration values by matching property names against configuration keys recursively.
|
||||
</summary>
|
||||
<param name="configuration">The configuration instance to bind.</param>
|
||||
<param name="instance">The object to bind.</param>
|
||||
<param name="configureOptions">Configures the binder options.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue``1(Microsoft.Extensions.Configuration.IConfiguration,System.String,``0)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to type T.
|
||||
</summary>
|
||||
<typeparam name="T">The type to convert the value to.</typeparam>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.ConfigurationBinder.GetValue(Microsoft.Extensions.Configuration.IConfiguration,System.Type,System.String,System.Object)">
|
||||
<summary>
|
||||
Extracts the value with the specified key and converts it to the specified type.
|
||||
</summary>
|
||||
<param name="configuration">The configuration.</param>
|
||||
<param name="type">The type to convert the value to.</param>
|
||||
<param name="key">The key of the configuration section's value to convert.</param>
|
||||
<param name="defaultValue">The default value to use if no value is found.</param>
|
||||
<returns>The converted value.</returns>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
|
||||
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
||||
<param name="argument">The reference type argument to validate as non-null.</param>
|
||||
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
||||
</member>
|
||||
<member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
|
||||
<summary>
|
||||
Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
|
||||
if the specified string is <see langword="null"/> or whitespace respectively.
|
||||
</summary>
|
||||
<param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
|
||||
<param name="paramName">The name of the parameter being checked.</param>
|
||||
<returns>The original value of <paramref name="argument"/>.</returns>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is suppling a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
||||
<summary>
|
||||
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which members are being accessed during the execution
|
||||
of a program.
|
||||
|
||||
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
||||
|
||||
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
||||
that the string represents a fully qualified type name.
|
||||
|
||||
When this attribute is applied to a class, interface, or struct, the members specified
|
||||
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
||||
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
||||
|
||||
If the attribute is applied to a method it's treated as a special case and it implies
|
||||
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
||||
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
||||
will use it there).
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
||||
with the specified member types.
|
||||
</summary>
|
||||
<param name="memberTypes">The types of members dynamically accessed.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
||||
<summary>
|
||||
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
||||
of members dynamically accessed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
||||
<summary>
|
||||
Specifies the types of members that are dynamically accessed.
|
||||
|
||||
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
||||
bitwise combination of its member values.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
||||
<summary>
|
||||
Specifies no members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
||||
<summary>
|
||||
Specifies the default, parameterless public constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
||||
<summary>
|
||||
Specifies all public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
||||
<summary>
|
||||
Specifies all non-public constructors.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
||||
<summary>
|
||||
Specifies all public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
||||
<summary>
|
||||
Specifies all non-public methods.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
||||
<summary>
|
||||
Specifies all public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
||||
<summary>
|
||||
Specifies all non-public fields.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
||||
<summary>
|
||||
Specifies all non-public nested types.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
||||
<summary>
|
||||
Specifies all public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
||||
<summary>
|
||||
Specifies all non-public properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
||||
<summary>
|
||||
Specifies all public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
||||
<summary>
|
||||
Specifies all non-public events.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
||||
<summary>
|
||||
Specifies all interfaces implemented by the type.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
||||
<summary>
|
||||
Specifies all members.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires dynamic access to code that is not referenced
|
||||
statically, for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
||||
code from an application.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of unreferenced code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of unreferenced code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires unreferenced code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
||||
<summary>
|
||||
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
||||
single code artifact.
|
||||
</summary>
|
||||
<remarks>
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
||||
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
||||
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
||||
class, specifying the category of the tool and the identifier for an analysis rule.
|
||||
</summary>
|
||||
<param name="category">The category for the attribute.</param>
|
||||
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
||||
<summary>
|
||||
Gets the category identifying the classification of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
||||
for which a message suppression attribute applies.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
||||
<summary>
|
||||
Gets the identifier of the analysis tool rule to be suppressed.
|
||||
</summary>
|
||||
<remarks>
|
||||
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
||||
properties form a unique check identifier.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
||||
<summary>
|
||||
Gets or sets the scope of the code that is relevant for the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The Scope property is an optional argument that specifies the metadata scope for which
|
||||
the attribute is relevant.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
||||
<summary>
|
||||
Gets or sets a fully qualified path that represents the target of the attribute.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
||||
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
||||
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
||||
The analysis tool user interface should be capable of automatically formatting the parameter.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
||||
<summary>
|
||||
Gets or sets an optional argument expanding on exclusion criteria.
|
||||
</summary>
|
||||
<remarks>
|
||||
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
||||
exclusion where the literal metadata target is not sufficiently precise. For example,
|
||||
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
||||
and it may be desirable to suppress a violation against a statement in the method that will
|
||||
give a rule violation, but not against all statements in the method.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
||||
<summary>
|
||||
Gets or sets the justification for suppressing the code analysis message.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
||||
<summary>
|
||||
Indicates that the specified method requires the ability to generate new code at runtime,
|
||||
for example through <see cref="N:System.Reflection"/>.
|
||||
</summary>
|
||||
<remarks>
|
||||
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
||||
with the specified message.
|
||||
</summary>
|
||||
<param name="message">
|
||||
A message that contains information about the usage of dynamic code.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
||||
<summary>
|
||||
Gets a message that contains information about the usage of dynamic code.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
||||
<summary>
|
||||
Gets or sets an optional URL that contains more information about the method,
|
||||
why it requires dynamic code, and what options a consumer has to deal with it.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotActivateAbstractOrInterface">
|
||||
<summary>Cannot create instance of type '{0}' because it is either abstract or an interface.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_CannotBindToConstructorParameter">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters cannot be declared as in, out, or ref. Invalid parameters are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ConstructorParametersDoNotMatchProperties">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters cannot be bound to. Constructor parameters must have corresponding properties. Fields are not supported. Missing properties are: '{1}'</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedBinding">
|
||||
<summary>Failed to convert configuration value at '{0}' to type '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_FailedToActivate">
|
||||
<summary>Failed to create instance of type '{0}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_GeneralErrorWhenBinding">
|
||||
<summary>'{0}' was set and binding has failed. The likely cause is an invalid configuration value.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingConfig">
|
||||
<summary>'{0}' was set on the provided {1}, but the following properties were not found on the instance of {2}: {3}</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MissingPublicInstanceConstructor">
|
||||
<summary>Cannot create instance of type '{0}' because it is missing a public instance constructor.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_MultipleParameterizedConstructors">
|
||||
<summary>Cannot create instance of type '{0}' because it has multiple public parameterized constructors.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterBeingBoundToIsUnnamed">
|
||||
<summary>Cannot create instance of type '{0}' because one or more parameters are unnamed.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_ParameterHasNoMatchingConfig">
|
||||
<summary>Cannot create instance of type '{0}' because parameter '{1}' has no matching config. Each parameter in the constructor that does not have a default value must have a corresponding config entry.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_UnsupportedMultidimensionalArray">
|
||||
<summary>Cannot create instance of type '{0}' because multidimensional arrays are not supported.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
mlkx6dQXuM1JA/6LlKqOwHofDUM4Zxe+OBcaXrQysXZdfalefwkuaZfszz9IKNVxYxemj8yP7TLwrU8fgrtyIw==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "ebFbu+vsz4rzeAICWavk9a0FutWVs7aNZap5k/IVxVhu2CnnhOp/H/gNtpzplrqjYDaNYdmv9a/DoUvH2ynVEQ==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
@@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.FileExtensions</id>
|
||||
<version>2.0.0</version>
|
||||
<authors>Microsoft</authors>
|
||||
<owners>Microsoft</owners>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<licenseUrl>https://raw.githubusercontent.com/aspnet/Home/2.0.0/LICENSE.txt</licenseUrl>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<iconUrl>https://go.microsoft.com/fwlink/?LinkID=288859</iconUrl>
|
||||
<description>Extension methods for configuring file-based configuration providers for Microsoft.Extensions.Configuration.</description>
|
||||
<copyright>Copyright © Microsoft Corporation</copyright>
|
||||
<tags>configuration</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/aspnet/Configuration" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration" version="2.0.0" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Physical" version="2.0.0" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,175 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.FileExtensions</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileConfigurationExtensions">
|
||||
<summary>
|
||||
Extension methods for <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder,Microsoft.Extensions.FileProviders.IFileProvider)">
|
||||
<summary>
|
||||
Sets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="fileProvider">The default file provider instance.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileProvider(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetBasePath(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
Sets the FileProvider for file-based providers to a PhysicalFileProvider with the base path.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="basePath">The absolute path of file-based providers.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.SetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{Microsoft.Extensions.Configuration.FileLoadExceptionContext})">
|
||||
<summary>
|
||||
Sets a default action to be invoked for file-based providers when an error occurs.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
|
||||
<param name="handler">The Action to be invoked on a file load exception.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationExtensions.GetFileLoadExceptionHandler(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Gets the default <see cref="T:Microsoft.Extensions.FileProviders.IFileProvider"/> to be used for file-based providers.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileConfigurationProvider">
|
||||
<summary>
|
||||
Base class for file based <see cref="T:Microsoft.Extensions.Configuration.ConfigurationProvider"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.#ctor(Microsoft.Extensions.Configuration.FileConfigurationSource)">
|
||||
<summary>
|
||||
Initializes a new instance with the specified source.
|
||||
</summary>
|
||||
<param name="source">The source settings.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationProvider.Source">
|
||||
<summary>
|
||||
The source settings for this provider.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load">
|
||||
<summary>
|
||||
Loads the contents of the file at <see cref="T:System.IO.Path"/>.
|
||||
</summary>
|
||||
<exception cref="T:System.IO.FileNotFoundException">If Optional is <c>false</c> on the source and a
|
||||
file does not exist at specified Path.</exception>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(System.IO.Stream)">
|
||||
<summary>
|
||||
Loads this provider's data from a stream.
|
||||
</summary>
|
||||
<param name="stream">The stream to read.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileConfigurationSource">
|
||||
<summary>
|
||||
Represents a base class for file based <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.FileProvider">
|
||||
<summary>
|
||||
Used to access the contents of the file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Path">
|
||||
<summary>
|
||||
The path to the file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.Optional">
|
||||
<summary>
|
||||
Determines if loading the file is optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadOnChange">
|
||||
<summary>
|
||||
Determines whether the source will be loaded if the underlying file changes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.ReloadDelay">
|
||||
<summary>
|
||||
Number of milliseconds that reload will wait before calling Load. This helps
|
||||
avoid triggering reload before a file is completely written. Default is 250.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileConfigurationSource.OnLoadException">
|
||||
<summary>
|
||||
Will be called if an uncaught exception occurs in FileConfigurationProvider.Load.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
<returns>A <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.EnsureDefaults(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
Called to use any default settings on the builder like the FileProvider or FileLoadExceptionHandler.
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileConfigurationSource.ResolveFileProvider">
|
||||
<summary>
|
||||
If no file provider has been set, for absolute Path, this will creates a physical file provider
|
||||
for the nearest existing directory.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.FileLoadExceptionContext">
|
||||
<summary>
|
||||
Contains information about a file load exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Provider">
|
||||
<summary>
|
||||
The <see cref="T:Microsoft.Extensions.Configuration.FileConfigurationProvider"/> that caused the exception.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Exception">
|
||||
<summary>
|
||||
The exception that occured in Load.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileLoadExceptionContext.Ignore">
|
||||
<summary>
|
||||
If true, the exception will not be rethrown.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_ExpectedPhysicalPath">
|
||||
<summary>
|
||||
The expected physical path was '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_ExpectedPhysicalPath(System.Object)">
|
||||
<summary>
|
||||
The expected physical path was '{0}'.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.FileExtensions.Resources.Error_FileNotFound">
|
||||
<summary>
|
||||
The configuration file '{0}' was not found and is not optional.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.FileExtensions.Resources.FormatError_FileNotFound(System.Object)">
|
||||
<summary>
|
||||
The configuration file '{0}' was not found and is not optional.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
BZgEA+Lr65quM9TutXR0QfOpzXE5szwwb8LfvoNxsOcr6vpeH8Ux8GaWojY0hS6nfnNRN+vr3k2S3rDCjycTQg==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "rXyqWj+ew+E+mqMxKkQAUPCSOsUexTSHdbSaAOnEi4ODsNKvI8nsmFagt8GeFDJcAz57zuoq8qrGbCbgsC0uYg==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,50 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.Extensions.Configuration.UserSecrets</id>
|
||||
<version>10.0.0-rc.2.25502.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://dot.net/</projectUrl>
|
||||
<description>User secrets configuration provider implementation for Microsoft.Extensions.Configuration. User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use UserSecretsConfigurationExtensions.AddUserSecrets extension method on IConfigurationBuilder to add user secrets provider to the configuration builder.</description>
|
||||
<releaseNotes>https://go.microsoft.com/fwlink/?LinkID=799421</releaseNotes>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="89c8f6a112d37d2ea8b77821e56d170a1bccdc5a" />
|
||||
<dependencies>
|
||||
<group targetFramework=".NETFramework4.6.2">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Json" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Physical" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net8.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Json" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Physical" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net9.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Json" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Physical" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Json" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Physical" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
<group targetFramework=".NETStandard2.0">
|
||||
<dependency id="Microsoft.Extensions.Configuration.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.Configuration.Json" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Abstractions" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
<dependency id="Microsoft.Extensions.FileProviders.Physical" version="10.0.0-rc.2.25502.107" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
</metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,19 @@
|
||||
## About
|
||||
|
||||
<!-- A description of the package and where one can find more documentation -->
|
||||
|
||||
User secrets configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use [UserSecretsConfigurationExtensions.AddUserSecrets](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.usersecretsconfigurationextensions.addusersecrets) extension method on `IConfigurationBuilder` to add user secrets provider to the configuration builder.
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation -->
|
||||
|
||||
* [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration)
|
||||
* [Safe storage of app secrets in development in ASP.NET Core](https://learn.microsoft.com/aspnet/core/security/app-secrets)
|
||||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.usersecrets)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.Extensions.Configuration.UserSecrets is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_UserSecrets_net462">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_UserSecrets_net462"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.UserSecrets 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net462 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,8 @@
|
||||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- This capability represents the UserSecretsID + secrets.json approach to storing local user secrets. -->
|
||||
<ProjectCapability Include="LocalUserSecrets" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,13 @@
|
||||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<PropertyGroup>
|
||||
<MSBuildAllProjects Condition="'$(MSBuildVersion)' == '' Or '$(MSBuildVersion)' < '16.0'">$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
|
||||
<GenerateUserSecretsAttribute Condition="'$(GenerateUserSecretsAttribute)'==''">true</GenerateUserSecretsAttribute>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup Condition=" '$(UserSecretsId)' != '' AND '$(GenerateUserSecretsAttribute)' != 'false' ">
|
||||
<AssemblyAttribute Include="Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<_Parameter1>$(UserSecretsId.Trim())</_Parameter1>
|
||||
</AssemblyAttribute>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -0,0 +1,8 @@
|
||||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- This capability represents the UserSecretsID + secrets.json approach to storing local user secrets. -->
|
||||
<ProjectCapability Include="LocalUserSecrets" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,13 @@
|
||||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<PropertyGroup>
|
||||
<MSBuildAllProjects Condition="'$(MSBuildVersion)' == '' Or '$(MSBuildVersion)' < '16.0'">$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
|
||||
<GenerateUserSecretsAttribute Condition="'$(GenerateUserSecretsAttribute)'==''">true</GenerateUserSecretsAttribute>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup Condition=" '$(UserSecretsId)' != '' AND '$(GenerateUserSecretsAttribute)' != 'false' ">
|
||||
<AssemblyAttribute Include="Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<_Parameter1>$(UserSecretsId.Trim())</_Parameter1>
|
||||
</AssemblyAttribute>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -0,0 +1,6 @@
|
||||
<Project InitialTargets="NETStandardCompatError_Microsoft_Extensions_Configuration_UserSecrets_net8_0">
|
||||
<Target Name="NETStandardCompatError_Microsoft_Extensions_Configuration_UserSecrets_net8_0"
|
||||
Condition="'$(SuppressTfmSupportBuildWarnings)' == ''">
|
||||
<Warning Text="Microsoft.Extensions.Configuration.UserSecrets 10.0.0-rc.2.25502.107 doesn't support $(TargetFramework) and has not been tested with it. Consider upgrading your TargetFramework to net8.0 or later. You may also set <SuppressTfmSupportBuildWarnings>true</SuppressTfmSupportBuildWarnings> in the project file to ignore this warning and attempt to run in this unsupported configuration at your own risk." />
|
||||
</Target>
|
||||
</Project>
|
||||
@@ -0,0 +1,8 @@
|
||||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<ItemGroup>
|
||||
<!-- This capability represents the UserSecretsID + secrets.json approach to storing local user secrets. -->
|
||||
<ProjectCapability Include="LocalUserSecrets" />
|
||||
</ItemGroup>
|
||||
|
||||
</Project>
|
||||
@@ -0,0 +1,13 @@
|
||||
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
||||
|
||||
<PropertyGroup>
|
||||
<MSBuildAllProjects Condition="'$(MSBuildVersion)' == '' Or '$(MSBuildVersion)' < '16.0'">$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
|
||||
<GenerateUserSecretsAttribute Condition="'$(GenerateUserSecretsAttribute)'==''">true</GenerateUserSecretsAttribute>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup Condition=" '$(UserSecretsId)' != '' AND '$(GenerateUserSecretsAttribute)' != 'false' ">
|
||||
<AssemblyAttribute Include="Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<_Parameter1>$(UserSecretsId.Trim())</_Parameter1>
|
||||
</AssemblyAttribute>
|
||||
</ItemGroup>
|
||||
</Project>
|
||||
@@ -0,0 +1,200 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
||||
<summary>
|
||||
Provides paths for user secrets configuration files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
||||
<summary>
|
||||
Returns the path to the JSON file that stores user secrets.
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
<remarks>
|
||||
This method uses the current user profile to locate the secrets
|
||||
file on disk in a location outside of source control.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.InternalGetSecretsPathFromSecretsId(System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Returns the path to the JSON file that stores user secrets or throws exception if not found.
|
||||
</para>
|
||||
<para>
|
||||
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<param name="throwIfNoRoot">specifies if an exception should be thrown when no root for user secrets is found</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<summary>
|
||||
Represents the user secrets ID.
|
||||
</summary>
|
||||
<remarks>
|
||||
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
||||
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
||||
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
||||
</summary>
|
||||
<param name="userSecretId">The user secrets ID.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
||||
<summary>
|
||||
Gets the user secrets ID.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
||||
<summary>
|
||||
Provides configuration extensions for adding user secrets configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is <see langword="false"/> and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Common_StringNullOrEmpty">
|
||||
<summary>Value cannot be null or an empty string.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">
|
||||
<summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">
|
||||
<summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsLocation">
|
||||
<summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,383 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
||||
<summary>
|
||||
Provides paths for user secrets configuration files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
||||
<summary>
|
||||
Returns the path to the JSON file that stores user secrets.
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
<remarks>
|
||||
This method uses the current user profile to locate the secrets
|
||||
file on disk in a location outside of source control.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.InternalGetSecretsPathFromSecretsId(System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Returns the path to the JSON file that stores user secrets or throws exception if not found.
|
||||
</para>
|
||||
<para>
|
||||
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<param name="throwIfNoRoot">specifies if an exception should be thrown when no root for user secrets is found</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<summary>
|
||||
Represents the user secrets ID.
|
||||
</summary>
|
||||
<remarks>
|
||||
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
||||
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
||||
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
||||
</summary>
|
||||
<param name="userSecretId">The user secrets ID.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
||||
<summary>
|
||||
Gets the user secrets ID.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
||||
<summary>
|
||||
Provides configuration extensions for adding user secrets configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is <see langword="false"/> and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Common_StringNullOrEmpty">
|
||||
<summary>Value cannot be null or an empty string.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">
|
||||
<summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">
|
||||
<summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsLocation">
|
||||
<summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,200 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
||||
<summary>
|
||||
Provides paths for user secrets configuration files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
||||
<summary>
|
||||
Returns the path to the JSON file that stores user secrets.
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
<remarks>
|
||||
This method uses the current user profile to locate the secrets
|
||||
file on disk in a location outside of source control.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.InternalGetSecretsPathFromSecretsId(System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Returns the path to the JSON file that stores user secrets or throws exception if not found.
|
||||
</para>
|
||||
<para>
|
||||
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<param name="throwIfNoRoot">specifies if an exception should be thrown when no root for user secrets is found</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<summary>
|
||||
Represents the user secrets ID.
|
||||
</summary>
|
||||
<remarks>
|
||||
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
||||
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
||||
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
||||
</summary>
|
||||
<param name="userSecretId">The user secrets ID.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
||||
<summary>
|
||||
Gets the user secrets ID.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
||||
<summary>
|
||||
Provides configuration extensions for adding user secrets configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is <see langword="false"/> and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Common_StringNullOrEmpty">
|
||||
<summary>Value cannot be null or an empty string.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">
|
||||
<summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">
|
||||
<summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsLocation">
|
||||
<summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,200 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
||||
<summary>
|
||||
Provides paths for user secrets configuration files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
||||
<summary>
|
||||
Returns the path to the JSON file that stores user secrets.
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
<remarks>
|
||||
This method uses the current user profile to locate the secrets
|
||||
file on disk in a location outside of source control.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.InternalGetSecretsPathFromSecretsId(System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Returns the path to the JSON file that stores user secrets or throws exception if not found.
|
||||
</para>
|
||||
<para>
|
||||
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<param name="throwIfNoRoot">specifies if an exception should be thrown when no root for user secrets is found</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<summary>
|
||||
Represents the user secrets ID.
|
||||
</summary>
|
||||
<remarks>
|
||||
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
||||
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
||||
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
||||
</summary>
|
||||
<param name="userSecretId">The user secrets ID.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
||||
<summary>
|
||||
Gets the user secrets ID.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
||||
<summary>
|
||||
Provides configuration extensions for adding user secrets configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is <see langword="false"/> and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Common_StringNullOrEmpty">
|
||||
<summary>Value cannot be null or an empty string.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">
|
||||
<summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">
|
||||
<summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsLocation">
|
||||
<summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
@@ -0,0 +1,383 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.Extensions.Configuration.UserSecrets</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.PathHelper">
|
||||
<summary>
|
||||
Provides paths for user secrets configuration files.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.GetSecretsPathFromSecretsId(System.String)">
|
||||
<summary>
|
||||
Returns the path to the JSON file that stores user secrets.
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
<remarks>
|
||||
This method uses the current user profile to locate the secrets
|
||||
file on disk in a location outside of source control.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.PathHelper.InternalGetSecretsPathFromSecretsId(System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Returns the path to the JSON file that stores user secrets or throws exception if not found.
|
||||
</para>
|
||||
<para>
|
||||
This uses the current user profile to locate the secrets file on disk in a location outside of source control.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="userSecretsId">The user secret ID.</param>
|
||||
<param name="throwIfNoRoot">specifies if an exception should be thrown when no root for user secrets is found</param>
|
||||
<returns>The full path to the secret file.</returns>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute">
|
||||
<summary>
|
||||
Represents the user secrets ID.
|
||||
</summary>
|
||||
<remarks>
|
||||
In most cases, this attribute is automatically generated during compilation by MSBuild targets
|
||||
included in the UserSecrets NuGet package. These targets use the MSBuild property 'UserSecretsId'
|
||||
to set the value for <see cref="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.
|
||||
</summary>
|
||||
<param name="userSecretId">The user secrets ID.</param>
|
||||
</member>
|
||||
<member name="P:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute.UserSecretsId">
|
||||
<summary>
|
||||
Gets the user secrets ID.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions">
|
||||
<summary>
|
||||
Provides configuration extensions for adding user secrets configuration source.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<exception cref="T:System.InvalidOperationException">The assembly containing <typeparamref name="T"/> does not have <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. Searches the assembly that contains type <typeparamref name="T"/>
|
||||
for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is <see langword="false"/> and the assembly containing <typeparamref name="T"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<typeparam name="T">The type from the assembly to search for an instance of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</typeparam>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Reflection.Assembly,System.Boolean,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source. This searches <paramref name="assembly"/> for an instance
|
||||
of <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>, which specifies a user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="assembly">The assembly with the <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute" />.</param>
|
||||
<param name="optional">Whether loading secrets is optional. When false, this method may throw.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<exception cref="T:System.InvalidOperationException"><paramref name="optional"/> is false and <paramref name="assembly"/> does not have a valid <see cref="T:Microsoft.Extensions.Configuration.UserSecrets.UserSecretsIdAttribute"/>.</exception>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.Configuration.UserSecretsConfigurationExtensions.AddUserSecrets(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.String,System.Boolean)">
|
||||
<summary>
|
||||
<para>
|
||||
Adds the user secrets configuration source with specified user secrets ID.
|
||||
</para>
|
||||
<para>
|
||||
A user secrets ID is unique value used to store and identify a collection of secret configuration values.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="configuration">The configuration builder.</param>
|
||||
<param name="userSecretsId">The user secrets ID.</param>
|
||||
<param name="reloadOnChange">Whether the configuration should be reloaded if the file changes.</param>
|
||||
<returns>The configuration builder.</returns>
|
||||
</member>
|
||||
<member name="P:System.SR.Common_StringNullOrEmpty">
|
||||
<summary>Value cannot be null or an empty string.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Invalid_Character_In_UserSecrets_Id">
|
||||
<summary>Invalid character '{0}' found in the user secrets ID at index '{1}'.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsIdAttribute">
|
||||
<summary>Could not find 'UserSecretsIdAttribute' on assembly '{0}'.
|
||||
Check that the project for '{0}' has set the 'UserSecretsId' build property.
|
||||
If the 'UserSecretsId' property is already set then add a reference to the Microsoft.Extensions.Configuration.UserSecret ...</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.Error_Missing_UserSecretsLocation">
|
||||
<summary>Could not determine an appropriate location for storing user secrets. Set the {0} environment variable to a folder where user secrets should be stored.</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.LibraryImportAttribute">
|
||||
<summary>
|
||||
Attribute used to indicate a source generator should create a function for marshalling
|
||||
arguments instead of relying on the runtime to generate an equivalent marshalling function at run-time.
|
||||
</summary>
|
||||
<remarks>
|
||||
This attribute is meaningless if the source generator associated with it is not enabled.
|
||||
The current built-in source generator only supports C# and only supplies an implementation when
|
||||
applied to static, partial, non-generic methods.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.Runtime.InteropServices.LibraryImportAttribute.#ctor(System.String)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.Runtime.InteropServices.LibraryImportAttribute"/>.
|
||||
</summary>
|
||||
<param name="libraryName">Name of the library containing the import.</param>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.LibraryName">
|
||||
<summary>
|
||||
Gets the name of the library containing the import.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.EntryPoint">
|
||||
<summary>
|
||||
Gets or sets the name of the entry point to be called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling">
|
||||
<summary>
|
||||
Gets or sets how to marshal string arguments to the method.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is set to a value other than <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />,
|
||||
<see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType" /> must not be specified.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType">
|
||||
<summary>
|
||||
Gets or sets the <see cref="T:System.Type"/> used to control how string arguments to the method are marshalled.
|
||||
</summary>
|
||||
<remarks>
|
||||
If this field is specified, <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshalling" /> must not be specified
|
||||
or must be set to <see cref="F:System.Runtime.InteropServices.StringMarshalling.Custom" />.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="P:System.Runtime.InteropServices.LibraryImportAttribute.SetLastError">
|
||||
<summary>
|
||||
Gets or sets whether the callee sets an error (SetLastError on Windows or errno
|
||||
on other platforms) before returning from the attributed method.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Runtime.InteropServices.StringMarshalling">
|
||||
<summary>
|
||||
Specifies how strings should be marshalled for generated p/invokes
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Custom">
|
||||
<summary>
|
||||
Indicates the user is supplying a specific marshaller in <see cref="P:System.Runtime.InteropServices.LibraryImportAttribute.StringMarshallingCustomType"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf8">
|
||||
<summary>
|
||||
Use the platform-provided UTF-8 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:System.Runtime.InteropServices.StringMarshalling.Utf16">
|
||||
<summary>
|
||||
Use the platform-provided UTF-16 marshaller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
||||
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
||||
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
||||
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
||||
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter may be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
||||
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified return value condition.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated parameter will not be null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
||||
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with the associated parameter name.</summary>
|
||||
<param name="parameterName">
|
||||
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
||||
<summary>Gets the associated parameter name.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
||||
<summary>Applied to a method that will never return under any circumstance.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
||||
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
||||
<summary>Initializes the attribute with the specified parameter value.</summary>
|
||||
<param name="parameterValue">
|
||||
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
||||
the associated parameter matches this value.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
||||
<summary>Gets the condition parameter value.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
||||
<summary>Initializes the attribute with a field or property member.</summary>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
||||
<summary>Initializes the attribute with the list of field and property members.</summary>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
||||
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
||||
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field or property member will not be null.
|
||||
</param>
|
||||
<param name="member">
|
||||
The field or property member that is promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
||||
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
||||
<param name="returnValue">
|
||||
The return value condition. If the method returns this value, the associated field and property members will not be null.
|
||||
</param>
|
||||
<param name="members">
|
||||
The list of field and property members that are promised to be not-null.
|
||||
</param>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
||||
<summary>Gets the return value condition.</summary>
|
||||
</member>
|
||||
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
||||
<summary>Gets field or property member names.</summary>
|
||||
</member>
|
||||
<member name="T:System.ExceptionPolyfills">
|
||||
<summary>Provides downlevel polyfills for static methods on Exception-derived types.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
oaSFhnfEtLcbDw5ziRRGdUizJZqpjeFPjgMhucHaU/+StdpwJFVC/2Ek4FJTJUCTiyUo1defmGTYLyOTp25r+A==
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "SsI4RqI8EH00+cYO96tbftlh87sNUv1eeyuBU1XZdQkG0RrHAOjWgl7P0FoLeTSMXJpOnfweeOWj2d1/5H3FxA==",
|
||||
"source": "https://api.nuget.org/v3/index.json"
|
||||
}
|
||||
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user