Skip to content

[Docs cleanup] API scenario testing docsΒ #44680

Description

@lirenhe

Context: API scenario testing (OAV) consumes the generated OpenAPI, so the tooling is still valid
Question: do we still need this tool or just make it archive?

Tasks:

  • 🟑 documentation/api-scenario/README.md β€” "Swagger" β†’ "generated OpenAPI"
  • 🟑 documentation/api-scenario/how-to/GenerateABasicApiScenario.md β€” inputs are generated OpenAPI, not hand-authored Swagger
  • 🟑 documentation/api-scenario/how-to/MakeTestProxyRecording.md β€” "Swagger consistency" β†’ "OpenAPI consistency"
  • 🟑 documentation/api-scenario/how-to/QuickStart.md β€” drop AutoRest/readme.md-tag dependency framing
  • 🟑 documentation/api-scenario/how-to/ResolveDependencies.md β€” emphasize generated OpenAPI sources; clarify readmeTag
  • 🟑 documentation/api-scenario/references/ApiScenarioDefinition.md β€” "Swagger operation/OperationId" β†’ "OpenAPI"
  • 🟑 documentation/api-scenario/references/Runner.md β€” replace AutoRest/readme.md config discovery with generated OpenAPI discovery
  • 🟑 documentation/api-scenario/references/ErrorCodeReference.md
  • 🟑 documentation/api-scenario/references/Variables.md
  • 🟑 documentation/api-scenario/references/v1.2/schema.json

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions