New public preview API for confidential ledger code transparency 2025-01-31-preview

[ivarprudnikov]

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

• Link to API Spec engagement record issue:

Is this review for (select one):

• a private preview
• 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 API Spec document (if applicable), and the root paths that have been updated.}

• Design Document:
  • Aligning with the latest draft SCITT IETF spec https://datatracker.ietf.org/doc/draft-ietf-scitt-architecture/
  • Aligning with the latest draft SCITT SCRAPI spec https://github.com/ietf-wg-scitt/draft-ietf-scitt-scrapi/blob/main/draft-ietf-scitt-scrapi.md
  • Aligning with the latest draft COSE receipt spec https://datatracker.ietf.org/doc/draft-ietf-cose-merkle-tree-proofs/
• Previous API Spec Doc:
• Updated paths:

As this is a preview API we will deprecate and not support the prior version and all future service apis will follow this newer spec.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔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
• 💌 email

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

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Schedule a data plane REST API spec review

Getting help

• First, please carefully read through this PR description, from top to bottom.
• If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
• To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
• For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
  and https://aka.ms/ci-fix.
• If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
  This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
• If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

fix #32559

[openapi-pipeline-app]

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]

Generated ApiView

Language	Package Name	ApiView Link
Java	azure-security-codetransparency	https://apiview.dev/Assemblies/Review/f48998389dd944129981099deb6e64fd?revisionId=6907861c2bc647388d8bebe6dab85ed6
Python	azure-codetransparency	https://apiview.dev/Assemblies/Review/aed746a7f4e149e9ba890b7da3276591?revisionId=21a308a91ff84440b833bd73b8310fc5

[azure-sdk]

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.CodeTransparency

[ivarprudnikov]

Private Preview version merged was merged in #27916

[mikeharder]

@danieljurek: Please investigate the failure of Swagger ApiDocPreview.

[maririos]

Based on conversations internally in the team I approved the suppressions added