Skip to content

DO NOT MERGE: [kusto] Add CADL spec #21529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

mpodwysocki
Copy link
Contributor

Data Plane API - Pull Request

Adds the Kusto Data Plane Spec as noted here: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/api/rest/

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
  • 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.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

@openapi-workflow-bot
Copy link

Hi, @mpodwysocki 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 11, 2022

    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: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: specification/kusto/Kusto.Data/cadl-output
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 7997da196f60fcc5b50153a2d518cd325833faba/specification/kusto/Kusto.Data
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Query_get.
    Url: kusto/Kusto.Data/cadl-output/openapi.json#L11:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Query_post.
    Url: kusto/Kusto.Data/cadl-output/openapi.json#L92:15
    ️❌SemanticValidation: 6 Errors, 0 Warnings failed [Detail]
    Rule Message
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
    JsonUrl: kusto/Kusto.Data/cadl-output/openapi.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: openapi
    JsonUrl: kusto/Kusto.Data/cadl-output/openapi.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: components
    JsonUrl: kusto/Kusto.Data/cadl-output/openapi.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: servers
    JsonUrl: kusto/Kusto.Data/cadl-output/openapi.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: content
    JsonUrl: kusto/Kusto.Data/cadl-output/openapi.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: requestBody
    JsonUrl: kusto/Kusto.Data/cadl-output/openapi.json
    ️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    Click detail for error messages. Exception contact [email protected] or https://aka.ms/swaggersupport.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️❌SpellCheck: 55 Errors, 0 Warnings failed [Detail]

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    HowToFix Unknown word (Paramters), please fix the error or add words to ./custom-words.txt
    path: kusto/Kusto.Data/cadl-output/openapi.json#L433:52
    HowToFix Unknown word (globby), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L57:10
    HowToFix Unknown word (picocolors), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L63:10
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L128:20
    HowToFix Unknown word (scandir), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L128:31
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L133:11
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L140:20
    HowToFix Unknown word (nodelib), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L148:20
    HowToFix Unknown word (scandir), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L153:22
    HowToFix Unknown word (fastq), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L154:10
    HowToFix Unknown word (cliui), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L261:19
    HowToFix Unknown word (fastq), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L363:19
    HowToFix Unknown word (reusify), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L368:10
    HowToFix Unknown word (domexception), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L386:15
    HowToFix Unknown word (formdata), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L404:19
    HowToFix Unknown word (globby), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L434:19
    HowToFix Unknown word (extglob), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L477:22
    HowToFix Unknown word (extglob), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L498:13
    HowToFix Unknown word (kleur), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L533:19
    HowToFix Unknown word (picomatch), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L563:10
    HowToFix Unknown word (domexception), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L597:24
    HowToFix Unknown word (formdata), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L622:10
    HowToFix Unknown word (opencollective), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L628:18
    HowToFix Unknown word (picocolors), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L675:19
    HowToFix Unknown word (picomatch), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L680:19
    HowToFix Unknown word (kleur), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L710:10
    HowToFix Unknown word (sisteransi), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L711:10
    HowToFix Unknown word (reusify), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L760:19
    HowToFix Unknown word (iojs), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L765:10
    HowToFix Unknown word (sisteransi), please fix the error or add words to ./custom-words.txt
    path: specification/kusto/Kusto.Data/package-lock.json#L801:19
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️❌CadlValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    MissingPackageJson "details":"The 'package.json' is missing in the cadl folder spe,
    please ensure the 'package.json' is added in the PR."
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 11, 2022

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=331067&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 1 "
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

    @AzureRestAPISpecReview AzureRestAPISpecReview added the Cadl Authored with Cadl label Nov 11, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Cadl Authored with Cadl
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants