Plfm 8720 #687
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| { | ||
| "openapi": "3.0.0", | ||
| "info": { | ||
| "title": "CRUD Opperations Schema", | ||
| "version": "v1" | ||
| }, | ||
| "paths": { | ||
| "/entity/{entityId}/annotations": { | ||
| "get": { | ||
| "description": "Get the annotations of an entity.", | ||
| "operationId": "orgSageOneEntityAnnotationsGet", | ||
| "parameters": [ | ||
| { | ||
| "name": "entityId", | ||
| "description": "The 'syn' Id of the entity to get the annotations for.", | ||
| "in": "path", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Auto-generated description", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/org.sagebionetworks.repo.model.annotation.v2.Annotations" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "put": { | ||
| "description": "Set the annotations of an entity.", | ||
| "operationId": "orgSageOneEntityAnnotationsPut", | ||
| "x-requireConfirmation": "ENABLED", | ||
| "parameters": [ | ||
| { | ||
| "name": "entityId", | ||
| "description": "The 'syn' of the target Entity.", | ||
| "in": "path", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| ], | ||
| "requestBody": { | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/org.sagebionetworks.repo.model.annotation.v2.Annotations" | ||
| } | ||
| } | ||
| }, | ||
| "required": true | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "description": "the updated annotations", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/org.sagebionetworks.repo.model.annotation.v2.Annotations" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "org.sagebionetworks.repo.model.annotation.v2.Annotations": { | ||
| "type": "object", | ||
| "description": "Each annotation is a key-value pair of metadata for an Entity.", | ||
| "properties": { | ||
| "id": { | ||
| "type": "string", | ||
| "description": "The 'syn' ID of the Entity" | ||
| }, | ||
| "etag": { | ||
| "type": "string", | ||
| "description": "The current etag of the Entity. The etag of an Entity will change each time an Entity is updated. An annotations update request will be rejected if provided etag does not match the current etag of the Entity." | ||
| }, | ||
| "annotations": { | ||
| "type": "object", | ||
| "description": "Annotations are a map of key-value pairs. The key is the name of the annotation. The value is an object.", | ||
| "additionalProperties": { | ||
| "$ref": "#/components/schemas/org.sagebionetworks.repo.model.annotation.v2.AnnotationsValue" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "id", | ||
| "etag", | ||
| "annotations" | ||
| ] | ||
| }, | ||
| "org.sagebionetworks.repo.model.annotation.v2.AnnotationsValue": { | ||
| "type": "object", | ||
| "description": "This object defines the value of an annotation.", | ||
| "properties": { | ||
| "type": { | ||
| "$ref": "#/components/schemas/org.sagebionetworks.repo.model.annotation.v2.AnnotationsValueType" | ||
| }, | ||
| "value": { | ||
| "type": "array", | ||
| "description": "The annotation's value must include one or more strings. See the 'type' to determine how each string should be parsed. An empty array is not allowed.", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "type", | ||
| "value" | ||
| ] | ||
| }, | ||
| "org.sagebionetworks.repo.model.annotation.v2.AnnotationsValueType": { | ||
| "type": "string", | ||
| "description": "The annotation's type defines how each string value should be parsed.", | ||
| "enum": [ | ||
| "STRING", | ||
| "DOUBLE", | ||
| "LONG", | ||
| "TIMESTAMP_MS", | ||
| "BOOLEAN" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Instead of the UUID, the stack + instance should be enough for defining a version.