Confidential Ledger Preview spec #13613

lynshi · 2021-03-24T20:02:42Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. March-April 2021
When you expect to publish swagger? Please provide date, or month to public if date is not available yet. March-April 2021
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-03-24T20:02:44Z

Hi, @lynshi Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-workflow-bot · 2021-03-24T20:02:45Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-03-24T20:02:45Z

Swagger Validation Report

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

There are no breaking changes.

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

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- confidentialledger/data-plane/readme.md tag:package-0.1-preview-ledger
- confidentialledger/data-plane/readme.md tag:package-0.1-preview-identity
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- confidentialledger/data-plane/readme.md tag:default

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"confidentialledger/data-plane/readme.md",
"tag":"package-0.1-preview-ledger",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"confidentialledger/data-plane/readme.md",
"tag":"package-0.1-preview-ledger",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"confidentialledger/data-plane/readme.md",
"tag":"package-0.1-preview-ledger",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"confidentialledger/data-plane/readme.md",
"tag":"package-0.1-preview-ledger",
"details":"> Installed AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"confidentialledger/data-plane/readme.md",
"tag":"package-0.1-preview-identity",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"confidentialledger/data-plane/readme.md",
"tag":"package-0.1-preview-identity",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

openapi-pipeline-app · 2021-03-24T20:02:46Z

Swagger Generation Artifacts

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 038e917. SDK Automation 14.0.0

command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-05-06 23:31:36 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

️❌ azure-sdk-for-go failed [Detail]

❌Failed [Logs]Release - Generate from 038e917. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
cmderr	[main.go] [ERROR] total 1 error(s):
cmderr	[main.go] [ERROR] cannot generate readme 'specification/confidentialledger/data-plane/readme.md': autorest error with arguments '--use=@microsoft.azure/autorest.go@2.1.180, --go, --verbose, --go-sdk-folder=., --multiapi, --use-onever, --version=V2, --go.license-header=MICROSOFT_MIT_NO_VERSION, ../../../../../azure-rest-api-specs/specification/confidentialledger/data-plane/readme.md, --metadata-output-folder=../../../../../azure-rest-api-specs/specification/confidentialledger/data-plane':
cmderr	[main.go] [ERROR] exit status 1
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go
warn	Skip package processing as generation is failed

️❌ azure-sdk-for-js failed [Detail]

❌Failed [Logs]Release - Generate from 038e917. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/confidentialledger/data-plane/readme.md
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js]: autorest
warn	Skip package processing as generation is failed

️❌ azure-sdk-for-python failed [Detail]

❌Failed [Logs]Release - Generate from 038e917. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmdout	[automation_generate.sh] [Autorest]/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed

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

 Please click here to preview with your @microsoft account.

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

openapi-workflow-bot · 2021-03-24T20:04:46Z

Hi @lynshi, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json

specification/confidentialledger/data-plane/readme.csharp.md

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json

christothes

Some naming tweaks as discussed in arch board.

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json

* add data-plane work * receipt has state * fix model errors * add custom words * run prettier * update comments * x-ms-pageable * pr comments * small fix * suggested renames * typo * change output folder * change identity service client title * fix urls * fix typo * prefix operation ids to for better codegen

lynshi added 2 commits March 24, 2021 12:49

add data-plane work

7acfbd1

receipt has state

51950c4

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Mar 24, 2021

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Mar 24, 2021

fix model errors

c3b4313

lynshi marked this pull request as ready for review March 24, 2021 20:20

openapi-assignment-bot bot assigned tjprescott Mar 24, 2021

christothes self-requested a review March 24, 2021 20:50

lynshi added 2 commits March 24, 2021 13:53

add custom words

3523bf8

run prettier

a3c580f

lynshi marked this pull request as draft March 24, 2021 22:20

christothes reviewed Mar 25, 2021

View reviewed changes

lmazuel assigned christothes and unassigned tjprescott Mar 25, 2021

update comments

607be5b

lynshi mentioned this pull request Apr 1, 2021

Board Review: Introducing Confidential Ledger Azure/azure-sdk#2646

Closed

lynshi marked this pull request as ready for review April 5, 2021 20:51

x-ms-pageable

92d7355

christothes reviewed Apr 14, 2021

View reviewed changes

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json Outdated Show resolved Hide resolved

christothes reviewed Apr 15, 2021

View reviewed changes

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json Outdated Show resolved Hide resolved

lynshi added 2 commits April 19, 2021 11:52

pr comments

61bfd1d

small fix

f26f6b7

lmazuel mentioned this pull request May 3, 2021

Board Light Review: Confidential Ledger Azure/azure-sdk#2777

Closed

christothes reviewed May 3, 2021

View reviewed changes

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json Show resolved Hide resolved

...alledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json Outdated Show resolved Hide resolved

suggested renames

b421fe7

typo

0f79e4b

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 4, 2021

change output folder

56c330e

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 6, 2021

change identity service client title

7645ed9

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 6, 2021

fix urls

68fbc1b

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels May 6, 2021

lynshi added 2 commits May 6, 2021 15:02

fix typo

2e985ec

prefix operation ids to for better codegen

e6a40cf

christothes approved these changes May 6, 2021

View reviewed changes

lmazuel merged commit 038e917 into Azure:master May 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Confidential Ledger Preview spec #13613

Confidential Ledger Preview spec #13613

lynshi commented Mar 24, 2021

openapi-workflow-bot bot commented Mar 24, 2021

openapi-workflow-bot bot commented Mar 24, 2021

openapi-pipeline-app bot commented Mar 24, 2021 •

edited

Loading

openapi-pipeline-app bot commented Mar 24, 2021 •

edited

Loading

openapi-workflow-bot bot commented Mar 24, 2021

christothes left a comment

Confidential Ledger Preview spec #13613

Confidential Ledger Preview spec #13613

Conversation

lynshi commented Mar 24, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 24, 2021

openapi-workflow-bot bot commented Mar 24, 2021

openapi-pipeline-app bot commented Mar 24, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Mar 24, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Mar 24, 2021

christothes left a comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Mar 24, 2021 •

edited

Loading

openapi-pipeline-app bot commented Mar 24, 2021 •

edited

Loading