Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some info about documentation/samplefiles* and documentation/api-scenario #28601

Merged
merged 6 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# API Scenario Documentation

API Scenario is a YAML file defining RESTful API usage scenarios of your service with a sequence of API calls. API scenario can be used for service API functional test, API quality validation and SDK/CLIs test generation.
API Scenario is a YAML file defining RESTful API usage scenarios of your
service with a sequence of API calls. API scenario can be used for service
API functional test, API quality validation and SDK/CLIs test generation.

API scenario is implemented in the [Azure/aov](https://github.com/Azure/oav)
repository.

## Features

Expand All @@ -27,9 +32,7 @@ API Scenario is a YAML file defining RESTful API usage scenarios of your service
- [API Scenario Runner Reference](./references/Runner.md)
- [API Scenario JSON Schema](./references/v1.2/schema.json)

## Feedback
## Getting help

If you have any question or need support, feel free to contact us via:
- [StackOverflow](https://stackoverflow.microsoft.com/posts/tagged/28051)
- Teams channel: https://aka.ms/SwaggerSupport (for MS FTEs)
- Email: vscswagger@microsoft.com.
If you have any question or need support, reach out via
[aka.ms/azsdk/support](https://aka.ms/azsdk/support) (Microsoft-internal only)
30 changes: 30 additions & 0 deletions documentation/samplefiles-dp/ABOUT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# About `samplefiles-dp`

This `samplefiles-dp` directory contains sample AutoRest configuration files
for data-plane specs: `README.md`.
It also contains the sample hand-written OpenAPI specification files referenced
by the README files.

> [!CAUTION]
> The example OpenAPI specification files in this directory are hand-written,
> which is a legacy, obsolete approach. For current approach refer to
> [aka.ms/azsdk/typespec](https://aka.ms/azsdk/typespec).

For a case where a single SDK client is generated,
see [dataplane samples for single client](samplefiles-dp-for-single-client).
This is the default, common scenario.

For a case where a multiple SDK clients are generated,
see [dataplane samples for multi client](samplefiles-dp-for-multi-client).
This is an advanced scenario. You can learn more about it at
[aka.ms/azsdk/spec-dirs#advanced-scenario-service-group](https://aka.ms/azsdk/spec-dirs#advanced-scenario-service-group).

You can learn more about AutoRest configuration files at
[aka.ms/azsdk/autorest](https://aka.ms/azsdk/autorest).

You can learn more about the overall directory structure at
[aka.ms/azsdk/spec-dirs](https://aka.ms/azsdk/spec-dirs).

See also: [`samplefiles`](../samplefiles/ABOUT.md)


5 changes: 0 additions & 5 deletions documentation/samplefiles-dp/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ swagger-to-sdk:
- repo: azure-sdk-for-python
- repo: azure-sdk-for-java
- repo: azure-sdk-for-net-track2
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ swagger-to-sdk:
- repo: azure-sdk-for-python
- repo: azure-sdk-for-java
- repo: azure-sdk-for-net-track2
```
```
21 changes: 21 additions & 0 deletions documentation/samplefiles/ABOUT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# About `samplefiles`

This `samplefiles` directory contains sample AutoRest configuration files:
`README.*.md`. It also contains the sample hand-written OpenAPI
specification files referenced by the README files.

> [!CAUTION]
> The example OpenAPI specification files in this directory are hand-written,
> which is a legacy, obsolete approach. For current approach refer to
> [aka.ms/azsdk/typespec](https://aka.ms/azsdk/typespec).

Finally, the `./Microsoft.YourServiceName/stable/YYYY-MM-DD/scenarios/quickStart.yaml`
is an [`api-scenario`](../api-scenario/README.md) sample.

You can learn more about AutoRest configuration files at
[aka.ms/azsdk/autorest](https://aka.ms/azsdk/autorest).

You can learn more about the overall directory structure at
[aka.ms/azsdk/spec-dirs](https://aka.ms/azsdk/spec-dirs).

See also: [`samplefiles-dp`](../samplefiles-dp/ABOUT.md)