azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

New API version script

Open JonathanCrd opened this issue 1 year ago • 7 comments

Updating the Copy-apiversion script to update the Readme tags and improve the parameters.

Most relevant changes are:

  • If the user does not provide a base version to copy the files from, the latest preview version will be used by default.
  • Data-plane is no longer the default for this script, this parameter is now mandatory.
  • Added argument-completion for parameters
  • New tag version section added to the Readme file
  • The main tag version in the Readme is updated ~~only if the new version is stable or if there are no stable versions for that provider~~ with the last stable or preview version.

This script is intended to replace the "New OpenAPI specs" tool in OpenAPI Hub

JonathanCrd avatar Feb 27 '24 02:02 JonathanCrd

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named TypeSpec Validation has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

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?

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

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

@JonathanCrd Do you have any specs PR that was created for a new API version added using this script?

praveenkuttappan avatar Mar 08 '24 00:03 praveenkuttappan

@JonathanCrd Do you have any specs PR that was created for a new API version added using this script?

No, do you want me to create a PR in this repo for testing purposes?

I tested this script on my local machine but didn't push the commits.

JonathanCrd avatar Mar 08 '24 01:03 JonathanCrd

@JonathanCrd how did you test this? We should try to figure out how to include some tests for this as there is a lot of assumptions with the regex's happening here.

weshaggard avatar Mar 08 '24 16:03 weshaggard