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

v1.2 #277

Merged
merged 39 commits into from
Sep 7, 2021
Merged

v1.2 #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
a85bee9
Bump to 1.2
patrickkwang May 27, 2021
536a343
Remove relation from query edge
vdancik May 5, 2021
246a17d
Remove relation from knowledge graph edge
vdancik Jun 3, 2021
d85d736
meta_knowledge_graph attributes
vdancik Jun 17, 2021
ae81ec8
fix typo
vdancik Jun 24, 2021
2396468
default value for constraint declaration
vdancik Jul 8, 2021
b24d2ad
Proposal for TRAPI 1.2 asyncquery
edeutsch Jun 8, 2021
ba52da0
Update TranslatorReasonerAPI.yaml
edeutsch Jun 14, 2021
a104568
fix line too long
edeutsch Jun 14, 2021
adbd9bc
add x-trapi asyncquery template
edeutsch Jun 14, 2021
f46de11
Explicitly describe /asyncquery implementation expectations
edeutsch Jun 24, 2021
a6b9c8a
add implementation expectations
edeutsch Jun 24, 2021
8bb96b3
fix typos
edeutsch Jun 24, 2021
2bb670a
Sunset deprecated /predicates
edeutsch Jun 24, 2021
b00652b
Add further optional behavior to callback
edeutsch Jun 24, 2021
360e982
Remove 'relation' in MetaEdge?
edeutsch Jul 1, 2021
fdf2fc3
Add tag for /meta_knowledge_graph
edeutsch Jul 1, 2021
3091d75
Addition of workflow template
edeutsch Jun 24, 2021
83f31c8
remove extra quotes for yamllint
edeutsch Jun 24, 2021
149e147
Add subattributes to attributes
edeutsch Jul 8, 2021
7a3aae1
Add subAttribute to prevent recursion
edeutsch Jul 22, 2021
1f7cee5
Add change log for TRAPI 1.2
edeutsch Jul 29, 2021
e4b86d2
minor wording tweaks
edeutsch Jul 29, 2021
c41351e
add two anticipated features
edeutsch Jul 29, 2021
8d14860
Handle missing `required` field in doc template
patrickkwang Jul 29, 2021
648dc4b
Update reference docs
patrickkwang Jul 29, 2021
4d7237b
Add enum handling to reference template
patrickkwang Aug 2, 2021
ac8ea6d
Update docs with enum
patrickkwang Aug 2, 2021
ca27444
add attributes to edge bindings
vdancik Jul 22, 2021
4b44065
Cosmetic tweaks
edeutsch Aug 4, 2021
988885b
Pin workflow schema version to 1.0.0
patrickkwang Aug 4, 2021
cfe78f0
Add default [] for qnode/qedge constraints
patrickkwang Aug 18, 2021
f845a78
Make nodes and edges required under MetaKnowledgeGraph
edeutsch Aug 17, 2021
148f1b9
Removed like 861 as discussed
edeutsch Aug 20, 2021
b908a9d
Fix documentation to reflect prior removal of 'relation'
edeutsch Aug 17, 2021
ff88657
Remove reference to class/subclass when refering to predicate
edeutsch Aug 30, 2021
ee5efb7
Add forgotten explicit nullable: true attribributes
edeutsch Aug 17, 2021
07ac069
add minItems: 1 and remove nullable: false as discussed
edeutsch Aug 30, 2021
56403fb
Update reference documentation
patrickkwang Sep 7, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 28 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
# Change Log TRAPI 1.1 -> 1.2
- /predicates endpoint is REMOVED
https://github.com/NCATSTranslator/ReasonerAPI/pull/261/files

- Removed all 'relation' properties in Edge, QEdge, MetaEdge

- /meta_knowledge_graph allows optional attributes[] property (encouraged but not required)
https://github.com/NCATSTranslator/ReasonerAPI/pull/259/files

- Add support for workflow and operations v1.0.0 (encouraged but not yet required)
https://github.com/NCATSTranslator/ReasonerAPI/pull/262/files

- /asyncquery endpoint added (recommended but not required)
https://github.com/NCATSTranslator/ReasonerAPI/pull/255/files
https://github.com/NCATSTranslator/ReasonerAPI/pull/263/files

- Add result.score (highly encouraged but not required)
https://github.com/NCATSTranslator/ReasonerAPI/pull/247/files

- /meta_knowledge_graph should only include specific relationships, not ancestor-inferred relationships (policy clarification)

- Add one level of subattributes to Attribute
https://github.com/NCATSTranslator/ReasonerAPI/pull/268/files

- Add attributes[] to EdgeBinding to complement Edge and Node
https://github.com/NCATSTranslator/ReasonerAPI/pull/269/files


# Change Log TRAPI 1.0 -> 1.1
- Many changes to "info" template at top. Please refresh to the latest template
- info.version is now your API version not TRAPI version
Expand Down
8 changes: 8 additions & 0 deletions ImplementationRules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ The rules are organized by class and property.

The terms MUST, SHOULD, MAY are used as defined in RFC 2119 https://tools.ietf.org/html/rfc2119

## /asyncquery
- Knowledge Providers (KPs) MAY implement /asyncquery
- Autonomous Reasoning Agents (ARAs) SHOULD implement /asyncquery
- The /asyncquery endpoint SHOULD be left in an OpenAPI definition for a TRAPI endpoint even if
if it is not implemented, since it is part of the TRAPI core schema
- Each TRAPI server MUST indicate with true or false if the /asyncquery endpoint is implemented
by the server via the x-trapi asyncquery property as found in the TRAPI core schema template.

## QNode.ids
- MAY be null, or MAY be missing. The meaning is the same.
- MUST NOT be an empty array (#199)
Expand Down