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

konrad-jamrozik · 2024-04-05T19:46:39Z

As in subject. At first I planned to delete the samplefiles* and api-scenario directories, but conversation of this PR led me to instead update the information about them.

Related work:

Documentation: Deduplicate specs directory structure (folder layout) guidance azure-sdk-tools#7628
Update the specification directory structure article #28464
Pull Request 953: Forward specs dir layout article to specs repo article; add links to APEX breaking changes; update AutoRest links
Pull Request 963: Update link to sample AutoRest README.md + clarify meaning of branch protection rules table

openapi-pipeline-app · 2024-04-05T19:46:43Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2024-04-05T19:46:43Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

️⌛Automated merging requirements met pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-04-05T19:46:44Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2024-04-05T19:46:44Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

maririos · 2024-04-05T21:11:38Z

As a sanity check, adding @raych1 for the SDK automation references

documentation/api-scenario/how-to/GenerateABasicApiScenario.md

konrad-jamrozik · 2024-04-05T21:46:24Z

documentation/api-scenario/how-to/QuickStart.md

-
-## Install
-
-`oav` is an open-source powerful tool for swagger validation, API Scenario testing, and examples generation. GitHub: https://github.com/Azure/oav.


@scbedd given that you own oav: do you recall if it is still being used to power api-scenario ? If so, can you have a look at these docs to assess if they appear to be up-to-date?

Yes I know OAV supports example generation. It is also used to produce coverage reports for specs.

@weshaggard so we still use api-scenario functionality, yes?

From the README:

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.

In any case, I reverted deletions in documentation/api-scenario/.

raych1 · 2024-04-09T01:37:42Z

documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/scenarios/quickStart.yaml

@@ -1,34 +0,0 @@
-# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json


This doc is used as the quick start for API scenarios. If you keep the API scenario docs, this one should be reverted too.

raych1

@konrad-jamrozik , can you share me where the sample readme goes?

konrad-jamrozik · 2024-04-10T00:12:06Z

@konrad-jamrozik , can you share me where the sample readme goes?

@raychen1 I am unsure what you mean. I didn't delete the sample readme, which is here:

raych1 · 2024-04-10T02:58:58Z

@konrad-jamrozik , can you share me where the sample readme goes?

@raychen1 I am unsure what you mean. I didn't delete the sample readme, which is here:

https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/samplefiles/samplereadme.md

https://github.com/Azure/azure-rest-api-specs/blob/users/kojamroz/del_obs_samples/documentation/samplefiles/samplereadme.md

@konrad-jamrozik , thanks. Can you keep the files under documentation/samplefiles-dp/? The readme files for both multiple clients and single client are still valid.

…pi-scenario` (#28601) * ongoing * ongoing * update * ongoing * ongoing * better links

…pi-scenario` (Azure#28601) * ongoing * ongoing * update * ongoing * ongoing * better links

konrad-jamrozik changed the title ~~Remove obsolete samplefiles and api-scenario~~ Delete obsolete documentation/samplefiles* and documentation/api-scenario Apr 5, 2024

konrad-jamrozik self-assigned this Apr 5, 2024

konrad-jamrozik requested review from weshaggard and maririos April 5, 2024 19:50

maririos requested a review from raych1 April 5, 2024 21:11

maririos reviewed Apr 5, 2024

View reviewed changes

documentation/api-scenario/how-to/GenerateABasicApiScenario.md Outdated Show resolved Hide resolved

konrad-jamrozik commented Apr 5, 2024

View reviewed changes

konrad-jamrozik force-pushed the users/kojamroz/del_obs_samples branch 2 times, most recently from d68a625 to 0d5879e Compare April 8, 2024 20:46

konrad-jamrozik changed the title ~~Delete obsolete documentation/samplefiles* and documentation/api-scenario~~ Delete obsolete files in documentation/samplefiles* Apr 8, 2024

weshaggard approved these changes Apr 8, 2024

View reviewed changes

raych1 reviewed Apr 9, 2024

View reviewed changes

konrad-jamrozik force-pushed the users/kojamroz/del_obs_samples branch 2 times, most recently from 57ec311 to a04a827 Compare April 15, 2024 22:40

Konrad Jamrozik added 3 commits April 15, 2024 16:01

ongoing

4b89cda

ongoing

d9cf0cf

update

dbf536c

konrad-jamrozik force-pushed the users/kojamroz/del_obs_samples branch from a04a827 to dbf536c Compare April 15, 2024 23:09

konrad-jamrozik changed the title ~~Delete obsolete files in documentation/samplefiles*~~ Add some info about documentation/samplefiles* and documentation-api-scenario Apr 15, 2024

konrad-jamrozik changed the title ~~Add some info about documentation/samplefiles* and documentation-api-scenario~~ Add some info about documentation/samplefiles* and documentation/api-scenario Apr 15, 2024

Konrad Jamrozik added 2 commits April 15, 2024 16:11

ongoing

625767d

ongoing

5b99bb6

better links

1422a9f

konrad-jamrozik merged commit 5511728 into main Apr 15, 2024
32 checks passed

konrad-jamrozik deleted the users/kojamroz/del_obs_samples branch April 15, 2024 23:39

tjprescott pushed a commit that referenced this pull request Apr 17, 2024

Add some info about documentation/samplefiles* and `documentation/a…

2e55e1f

…pi-scenario` (#28601) * ongoing * ongoing * update * ongoing * ongoing * better links

wiboris pushed a commit to wiboris/azure-rest-api-specs that referenced this pull request May 7, 2024

Add some info about documentation/samplefiles* and `documentation/a…

2555fbd

…pi-scenario` (Azure#28601) * ongoing * ongoing * update * ongoing * ongoing * better links

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

konrad-jamrozik commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

maririos commented Apr 5, 2024

konrad-jamrozik Apr 5, 2024 •

edited

Loading

weshaggard Apr 8, 2024

konrad-jamrozik Apr 8, 2024 •

edited

Loading

konrad-jamrozik Apr 8, 2024

raych1 Apr 9, 2024

raych1 left a comment

konrad-jamrozik commented Apr 10, 2024 •

edited

Loading

raych1 commented Apr 10, 2024


		## Install

		`oav` is an open-source powerful tool for swagger validation, API Scenario testing, and examples generation. GitHub: https://github.com/Azure/oav.

		@@ -1,34 +0,0 @@
		# yaml-language-server: $schema=https://raw.githubusercontent.com/Azure/azure-rest-api-specs/main/documentation/api-scenario/references/v1.2/schema.json

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

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

Conversation

konrad-jamrozik commented Apr 5, 2024 • edited Loading

openapi-pipeline-app bot commented Apr 5, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Apr 5, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Apr 5, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented Apr 5, 2024 • edited Loading

maririos commented Apr 5, 2024

konrad-jamrozik Apr 5, 2024 • edited Loading

Choose a reason for hiding this comment

weshaggard Apr 8, 2024

Choose a reason for hiding this comment

konrad-jamrozik Apr 8, 2024 • edited Loading

Choose a reason for hiding this comment

konrad-jamrozik Apr 8, 2024

Choose a reason for hiding this comment

raych1 Apr 9, 2024

Choose a reason for hiding this comment

raych1 left a comment

Choose a reason for hiding this comment

konrad-jamrozik commented Apr 10, 2024 • edited Loading

raych1 commented Apr 10, 2024

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

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

konrad-jamrozik commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 5, 2024 •

edited

Loading

konrad-jamrozik Apr 5, 2024 •

edited

Loading

konrad-jamrozik Apr 8, 2024 •

edited

Loading

konrad-jamrozik commented Apr 10, 2024 •

edited

Loading