workspace.json file should be fully schematized with a JSON schema

[garethj-msft]

Is your feature request related to a problem? Please describe the problem.

I am trying to build a TypeSpec emitter for the workspace.json file, and to do so accurately, it would be very helpful to have a full JSON schema for the file.

Client library/SDK language

None

Describe the solution you'd like

A json schema file that fully represents the workspace.json file

Additional context

No response

[baywet]

@garethj-msft can you provide more details on why TypeSpec needs to read/write to the workspace file please? (what information)

We've already started a discussion about the auth information in #5073
Beyond that, what else is required?

(and yes, as a general rule of thumb, I'm in favour of a schema, we actually had an initial version here https://github.com/microsoft/kiota/blob/main/specs/schemas/workspace.json but it lacks description, and is probably missing a couple of fields)

[garethj-msft]

Hi, sure.

TypeSpec only needs to write to the file, to drive Kiota CLI within TTK. It does not need to read it.
There's information in the file that's duplicated with the TypeSpec file, such as the names of the plugins. This makes it a real pain if you rename your plugin or make another change that needs to be in both files.

By far the simplest dev experience is for TypeSpec to just take over ownership of writing the file in the Copilot DA scenario, as the other, more complex, data such as the Includes/Excludes output of the picker is no longer required (as the user will be modelling just the part of the API they want to use in their plugin in TypeSpec, nothing more)

[thewahome]

Hey @garethj-msft there're plans to have a new integration option that exposes Kiota via npm.
My expectation is that Typespec can leverage the package, and have Kiota write the workspace,json file instead. Having a schema is still important, but IMHO it could be left to Kiota

[garethj-msft]

@thewahome Sounds good. What's the timeline? We need it for MVP summit in March.

[petrhollayms]

We need to figure out the integration for TS Preview2 milestone as discussed yesterday, but the agreement is to not use workspace.json file, so it looks like we can close this issue here, right? @edixon-github