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

OpenAI Plugin Manifest OpenAPI Output Validation #31

Open
peombwa opened this issue Oct 9, 2023 · 2 comments
Open

OpenAI Plugin Manifest OpenAPI Output Validation #31

peombwa opened this issue Oct 9, 2023 · 2 comments

Comments

@peombwa
Copy link
Contributor

peombwa commented Oct 9, 2023

Describe the solution you'd like
We should ensure that the OpenAPI specification in OpenAI's plugin manifest output folder conforms to the validation rules at https://platform.openai.com/docs/plugins/getting-started:

Keep in mind the following limits in your OpenAPI specification, which are subject to change:

  • 200 characters max for each API endpoint description/summary field in API specification
  • 200 characters max for each API param description field in API specification

Please note that these rules are subject to change. We should look at storing and reading the rules from a configuration file.

This is just a quality-of-life improvement to help customer catch and address common errors that can occur from the manifest.

@peombwa
Copy link
Contributor Author

peombwa commented Oct 13, 2023

Closing for now since the rules are subject to change. We will reopen if the validation is deemed necessary.

@peombwa peombwa closed this as completed Oct 13, 2023
@maisarissi
Copy link

I believe she should validate that now.
In a world where people will augment their OpenAPI descriptions to be more AI friendly, people will start adding more details to description and we need to make sure we are validating the existing 200 characters validaton.

@maisarissi maisarissi reopened this Mar 8, 2024
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