Skip to content
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

[Se] Define how to check for two backslide conditions #1527

Open
mario-guerra opened this issue Sep 11, 2024 · 1 comment
Open

[Se] Define how to check for two backslide conditions #1527

mario-guerra opened this issue Sep 11, 2024 · 1 comment

Comments

@mario-guerra
Copy link
Member

Context

The TypeSpec team has a plan for converting existing Azure services to TypeSpec. The process involves manual refinement of TypeSpec files (TSPs), validation through human reviews, and various work items assigned to different teams for approval and automation. The primary goal is to ensure that the converted TypeSpec generates an OpenAPI specification functionally equivalent to the original, maintaining round-trip correctness.

Description

The TypeSpec team needs to create mechanisms to detect two specific backslide conditions:

  1. When a service that was converted to TypeSpec reverts to using OpenAPI.
  2. When the OpenAPI specification is manually modified after being generated from TypeSpec.

These checks are crucial to maintain the integrity of the conversion process and ensure that services remain compliant with TypeSpec standards. The checks may have performance implications and could require reliance on oversight committees if they prove too complex to automate.

@allenjzhang
Copy link
Member

For #2, are you referring to the OAS spec being outside of the rest-api-specs repo? If they are inside of the repo, tsv will catch it (at least we greened RPSaaSMaster)

@markcowl markcowl added the epic label Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants