Emory University

Emory University files API

files resource

GitHub OpenAPI

Documentation

📖
Documentation
https://computablebrain.emory.edu/api/v1

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/openapi/emory-files-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/json-schema/emory-item-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/json-structure/emory-item-structure.json

Other Resources

🔗
x-examples
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/examples/emory-get-item-example.json
🔗
x-rules
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/rules/emory-rules.yml
🔗
x-vocabulary
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/vocabulary/emory-vocabulary.yml
🔗
x-json-ld
https://raw.githubusercontent.com/api-evangelist/emory/refs/heads/main/json-ld/emory-context.jsonld

OpenAPI Specification

emory-files-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Girder REST API (Emory Digital Slide Archive) annotation files API
  version: 3.2.14
  description: OpenAPI 3.0 conversion of the Girder REST API powering the Emory Digital Slide Archive (computablebrain). Converted faithfully from the live Swagger 2.0 document at https://computablebrain.emory.edu/api/v1/describe.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.txt
servers:
- url: https://computablebrain.emory.edu/api/v1
tags:
- description: files resource
  name: files
paths:
  /files:
    get:
      operationId: files_filesResponseRoot_files
      responses:
        '200':
          description: Success
        '400':
          description: A parameter was invalid.
      summary: List subitems or download a resource based on its path
      tags:
      - files
      parameters: []
  /files/{path}:
    get:
      operationId: files_filesResponse_path
      parameters:
      - name: path
        in: path
        required: true
        description: The path of the resource.  The path must be an absolute Unix path starting with either "/user/[user name]", for a user's resources or "/collection/[collection name]", for resources under a collection.
        schema:
          type: string
      responses:
        '200':
          description: Success
        '400':
          description: 'Path is invalid.


            Path refers to a resource that does not exist.'
        '403':
          description: Read access was denied for the resource.
      summary: List subitems or download a resource based on its path
      tags:
      - files
components:
  securitySchemes:
    Girder-Token:
      in: header
      name: Girder-Token
      type: apiKey