Skip to content

YAML Linting #25

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

Closed
earth2marsh opened this issue May 8, 2014 · 1 comment
Closed

YAML Linting #25

earth2marsh opened this issue May 8, 2014 · 1 comment

Comments

@earth2marsh
Copy link
Contributor

This story refers to item number 3 below…

There are at least three ways we can help guide users:

  1. Auto-complete. Minimum is the total syntax, best is contextual to the structure's location
  2. Contextual help to offer syntax guidance (could be as simple as an expandable pane or dialog)
  3. Validation of the Swagger-YAML (linting). This is more than just creating valid YAML—it includes checking for required elements, etc.
  4. Buttons such as "add a resource" or "add a method" or "add a query parameter", etc.

The guiding question is, "How do we make authoring the swagger-yaml easy for people who do not yet know the synax?"

@earth2marsh
Copy link
Contributor Author

Marsh to refactor into separate issues.

@earth2marsh earth2marsh modified the milestone: Later May 16, 2014
@mohsen1 mohsen1 closed this as completed Aug 21, 2014
ioggstream added a commit to italia/schema-editor that referenced this issue Nov 14, 2024
…vocabularies. (swagger-api#32)

* Preliminary autocomplete for CPV classes. See swagger-api#25.

* Autocomplete some json-ld keywords.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants