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.

Sign up for GitHub

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

Jump to bottom

OpenAPI 3 Schema issues #13

Closed
cgendreau opened this issue Apr 22, 2020 · 5 comments
Closed

OpenAPI 3 Schema issues #13

cgendreau opened this issue Apr 22, 2020 · 5 comments
Labels
1.0 In scope for version 1.0 of the specification schema Something isn't working with the API Schema

Comments

@cgendreau
Copy link
Contributor

  • email type is not defined
  • In schemas.Agent.properties.data.type : type should not be string but the 'agent' constant as defined per JSON API
  • query.sort description should be improved
@xuemeigan
Copy link
Collaborator

xuemeigan commented Apr 23, 2020 •
edited

  1. Added email type and improved sort order string : xuemeigan@4ed77ac
  2. I think Open API does not provide constant type : https://swagger.io/docs/specification/data-models/data-types/

@cgendreau
Copy link
Contributor Author

cgendreau commented Apr 23, 2020 •
edited

OAI/OpenAPI-Specification#1620
It should be possible to use 'const' in Open API 3.1: see OAI/OpenAPI-Specification#1313

@xuemeigan
Copy link
Collaborator

Used enum of 1 for agent type: xuemeigan@05541f9

@cgendreau
Copy link
Contributor Author

Please send a new PR, the previous one is already merged.

@cgendreau cgendreau added schema Something isn't working with the API Schema 1.0 In scope for version 1.0 of the specification labels Apr 24, 2020
@cgendreau
Copy link
Contributor Author

Fixed by #15

@xuemeigan xuemeigan mentioned this issue Jun 24, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
1.0 In scope for version 1.0 of the specification schema Something isn't working with the API Schema
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cgendreau @xuemeigan