Azure
Initial version of the code-signing dataplane service
Data Plane API - Pull Request
Initial onboarding definition for the dataplane service of the Azure Code Signing service. See: https://github.com/Azure/cadl-azure/issues/1999 cc: @DawnWang17
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
- Link to engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [x] a public preview
- [ ] GA release
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
- Design Document:
- Previous Open API Doc:
- Updated paths:
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
fix https://github.com/Azure/azure-rest-api-specs/issues/23716
Hi, @Jaxelr Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
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: 4 Errors, 16 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| 2023-06-15-preview | 2023-06-15-preview(31edfbc) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Operations with a 202 response must specify x-ms-long-running-operation: true.Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L55 |
|
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L89 |
|
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L169 |
|
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L243 |
|
| :warning: SecurityDefinitionDescription | Security definition should have a description. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L43 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L63 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L70 |
|
| :warning: ParameterDescription | Parameter should have a description. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L77 |
|
| :warning: ParameterOrder | Path parameter 'codeSigningAccountName' should appear before 'operationId'. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L148 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L152 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L159 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L162 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L225 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L232 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L302 |
|
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L305 |
|
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L338 |
|
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L372 |
|
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L385 |
|
| :warning: SchemaNamesConvention | Schema name should be Pascal case. Location: Azure.CodeSigning/preview/2023-06-15-preview/azure.codesigning.json#L399 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[NotRequired_Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs]Release - Generate from 80c5b33a4334eed1df2547e775e187b9e58d2a19. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. warn specification/codesigning/data-plane/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 9.6.7 -> 9.8.1 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️azure-codesigning [View full logs] [Release SDK Changes]info [Changelog] data-plan skip changelog generation temporarily
️❌ azure-sdk-for-net-track2 failed [Detail]
❌Failed [Logs]Release - Generate from 80c5b33a4334eed1df2547e775e187b9e58d2a19. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json warn specification/codesigning/data-plane/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json cmderr [Invoke-GenerateAndBuildV2.ps1] notice cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice New major version of npm available! 8.19.4 -> 9.8.1 cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g [email protected]` to update! cmderr [Invoke-GenerateAndBuildV2.ps1] npm notice cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 141 | [0m [36;1mGeneratePackage `[0m cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to build sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 141 | [0m [36;1mGeneratePackage `[0m cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to packe sdk. exit code: False cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGet-ChildItem: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:805 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 805 | [0m … rtifacts += [36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s[0m … cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mCannot find path cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1mit does not exist. cmderr [Invoke-GenerateAndBuildV2.ps1] [0m cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1mGeneratePackage: [0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/Invoke-GenerateAndBuildV2.ps1:141 cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1mLine | cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m 141 | [0m [36;1mGeneratePackage `[0m cmderr [Invoke-GenerateAndBuildV2.ps1] [36;1m | [31;1m ~~~~~~~~~~~~~~~~~ cmderr [Invoke-GenerateAndBuildV2.ps1] [31;1m[36;1m | [31;1mFailed to generate sdk artifact cmderr [Invoke-GenerateAndBuildV2.ps1] [0m
❌Azure.CodeSigning [View full logs] [Release SDK Changes]info [Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 80c5b33a4334eed1df2547e775e187b9e58d2a19. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read warn specification/codesigning/data-plane/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure-rest/azure-codesigning-rest [View full logs] [Release SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️❌ azure-sdk-for-java failed [Detail]
❌Failed [Logs]Release - Generate from 80c5b33a4334eed1df2547e775e187b9e58d2a19. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip cmderr [init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1 cmderr [init.sh] [notice] To update, run: pip install --upgrade pip warn specification/codesigning/data-plane/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] cmderr [generate.py] npm notice New major version of npm available! 8.19.4 -> 9.8.1 cmderr [generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.8.1> cmderr [generate.py] npm notice Run `npm install -g [email protected]` to update! cmderr [generate.py] npm notice cmderr [generate.py] warning: in the working copy of 'sdk/codesigning/azure-codesigning/pom.xml', CRLF will be replaced by LF the next time Git touches it
❌azure-codesigning [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Python | azure-codesigning | https://apiview.dev/Assemblies/Review/11fce64a45554df0aea8b315281c1e7e |
| Java | azure-codesigning | https://apiview.dev/Assemblies/Review/b87160105d774ff2ab9cb7c084e558bd |
| JavaScript | @azure-rest/azure-codesigning-rest | https://apiview.dev/Assemblies/Review/83ebfa5f4a4b4449b09e8ffbe6600b74 |
Hi, @Jaxelr, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
Hi @Jaxelr, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @Jaxelr. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Commenter does not have sufficient privileges for PR 22310 in repo Azure/azure-rest-api-specs
Hi, @Jaxelr. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
@msftbot dont close, I've been on holidays and will pick up this work on this sprint.
Force merging the PR, as the broken CI are caused by known bugs:
- https://github.com/Azure/typespec-azure/issues/1674
- https://github.com/Azure/typespec-azure/issues/3349
Note that the example of the LRO uses azure-async-operation. Therefore, either the example is wrong, or the LRO is wrong.
https://github.com/Azure/azure-rest-api-specs/blob/main/specification/codesigning/data-plane/Azure.CodeSigning/preview/2023-06-15-preview/examples/CertificateProfileOperations_Sign.json#L25C10-L25C31
Thanks @Jaxelr
Header should be operation-location. Please make sure it matches your backend runtime.
If possible, would you also give us an example of the last poll (when success)?
As LongRunningResourceAction, the final poll should be as shape
{
"id": "##",
"status": "succeeded",
"result": {
...
}
}
Thanks. Related doc on LRO of LongRunningResourceAction https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#long-running-action-operations