-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Enterprise Knowledge Graph Documentation in one swagger json file #6743
Conversation
Add Search Swagger documentation in Enterprise Knowledge Graph
hi @tengr any update? |
Just updated. |
@tengr Let me know once you've final approval from API review board. |
HI @anuchandy , could you pls continue reviewing and push to end? |
"parameters": [ | ||
{ | ||
"in": "query", | ||
"name": "service", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wasn't this an internal-only parameter? Or am I misremembering?
"type": "string" | ||
}, | ||
"isAggregate": { | ||
"type": "boolean", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is malformed JSON. I'm not really sure why this is not being flagged by our tools. But please fix this up.
The swagger document is malformed. Not sure why our tools are not flagging it. But it needs to be fixed up. |
just fixed. |
The semantic validation is now failing due to the document not being a valid swagger/openapi document. |
], | ||
"responses": { | ||
"200": { | ||
"description": "Success", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will the number of items/the size of the data ever require the service to do paging?
} | ||
}, | ||
"definitions": { | ||
"ConverseRequest": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are missing descriptions for almost all attributes. Understanding what values are allowed for attributes like entityType
will be very challenging for users of the API.
} | ||
} | ||
}, | ||
"EntityType": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you have a model item with only a single property? Is the intent for the number of attributes to grow over time? If so, should attributes named entityType
be of type "/definitions/EntityTypeor should the attribute name be
entityTypeName`?
} | ||
} | ||
}, | ||
"SparqlQueryDbResponse": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest naming the type in a way that makes it clear that this is a SPARQL response object and add a description that indicates that this is a standard format, not something that is unique to this service.
@tengr could you take a look at review comments? |
Latest improvements:
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Contribution checklist:
ARM API Review Checklist
Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.
Please follow the link to find more details on API review process.