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

API - Docs: contributions points - schema property: lacking a lot of properties and documentation. #203721

Closed
Malix-Labs opened this issue Jan 29, 2024 · 6 comments
Assignees

Comments

@Malix-Labs
Copy link
Contributor

Malix-Labs commented Jan 29, 2024

the api documentation about contributions points schema property is lacking a lot of properties and documentation.

For instance, this is a list of all the properties the LSP is showing containing the letter "a" in it.
image
A lot of them are not listed anywhere in the api documentation about contributions points schema property

Does this issue occur when all extensions are disabled?: No (Because that LSP feature it comes from a built-in extension (I didn't find which))

  • VS Code Version: 1.85.2 - 8b37750 - x64
@Malix-Labs Malix-Labs changed the title API - Docs: contributions points - schema property: lacking **A LOT** of properties and documentation. API - Docs: contributions points - schema property: lacking a lot of properties and documentation. Jan 29, 2024
@jrieken jrieken assigned aeschli and unassigned jrieken Jan 30, 2024
@aeschli
Copy link
Contributor

aeschli commented Jan 30, 2024

As explained in the documentation, this configuration keys are defined using a superset of JSON Schema.
In the VS Code documentation, we only list the properties we added on top.

https://json-schema.org/understanding-json-schema is a good documentation of JSON Schema.

@aeschli aeschli closed this as completed Jan 30, 2024
@Malix-Labs
Copy link
Contributor Author

Malix-Labs commented Jan 30, 2024

Wdym @aeschli?
Are there not supposed to be any documentation for them?
Is there a way to list them all without using the autocomplete LSP?

@aeschli
Copy link
Contributor

aeschli commented Jan 31, 2024

It would take up a lot of space in the documentation and we would be repeating what's much better explained in the JSON schema documentation. We also don't go into the details of the JSON format. The target audience are extension developers, so I think it's ok to assume that they can look up the necessary information.

@Malix-Labs
Copy link
Contributor Author

@aeschli
Okay, but where to find the whole schema?

@ematipico
Copy link

@aeschli, where's the schema, though? You haven't linked it yet and we need it understand how we should define our configurations

@aeschli
Copy link
Contributor

aeschli commented Feb 19, 2024

You can use everything from JSON schema (draft-07)

https://json-schema.org/understanding-json-schema describes the properties of JSON schemas and also has a line to the meta schema, if you need that? https://json-schema.org/draft-07/schema

@microsoft microsoft locked and limited conversation to collaborators Jun 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants