From 4f960bf4a9a24c4fd2c7810aed953b9d3d486d1b Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 10:16:58 -0600
Subject: [PATCH 1/7] Modified 2 files

---
 .stoplight/styleguide.json | 94 +++++++++++++++++++-------------------
 MorphoSource-REST-API.yaml |  2 +-
 2 files changed, 48 insertions(+), 48 deletions(-)

diff --git a/.stoplight/styleguide.json b/.stoplight/styleguide.json
index 4a42578..dd00c96 100644
--- a/.stoplight/styleguide.json
+++ b/.stoplight/styleguide.json
@@ -14,7 +14,7 @@
   "rules": {},
   "inheritedRules": [
     {
-      "id": "FeGkgNhqnnebE5J-72kih",
+      "id": "2NkF6ozXTzR-KlI0YMj9b",
       "given": [
         "#API_Contact"
       ],
@@ -29,7 +29,7 @@
       "message": "Contact object should have \"url\""
     },
     {
-      "id": "KfrvleGDG5AEa46fW1W8j",
+      "id": "rzTbLcMUdvJnfhpRf0hI9",
       "given": [
         "#API_Contact"
       ],
@@ -44,7 +44,7 @@
       "message": "Contact object should have \"email\""
     },
     {
-      "id": "6HB22b23Eg9JO6AXC8Euk",
+      "id": "EN8Dwa-KTPMxfgAs68pE6",
       "given": [
         "#API_Document"
       ],
@@ -59,7 +59,7 @@
       "message": "Info object should have \"contact\" object."
     },
     {
-      "id": "vgG0az55lspZz1L5jaXtj",
+      "id": "B4bbX5SCh8WeWYbTCWzfk",
       "given": [
         "#API_Document"
       ],
@@ -74,7 +74,7 @@
       "message": "Info object should have \"description\" object."
     },
     {
-      "id": "hb_Uag412TonKrLpZTfUC",
+      "id": "zG90RfTHIZLXTfxFEhUX0",
       "given": [
         "#API_Document"
       ],
@@ -89,7 +89,7 @@
       "message": "Info object should have \"license\" object."
     },
     {
-      "id": "vQJke_xcDWiN5oo19UWd5",
+      "id": "w8GPOyw_68T3NlPlCUx5S",
       "given": [
         "#API_License"
       ],
@@ -104,7 +104,7 @@
       "message": "License object should include \"url\"."
     },
     {
-      "id": "36ik5WoaOmoHxLxQfgP3M",
+      "id": "bGRfwVjbgMe-eoLxRE7Vn",
       "given": [
         "#All_Markdown"
       ],
@@ -121,7 +121,7 @@
       "message": "Markdown descriptions must not have \"eval(\"."
     },
     {
-      "id": "A0omAIfdCQT78eWLj6Xkc",
+      "id": "Xz5H80fGnG3KVWtPIsqWu",
       "given": [
         "#All_Markdown"
       ],
@@ -138,7 +138,7 @@
       "message": "Markdown descriptions must not have \"<script>\" tags."
     },
     {
-      "id": "5FZYe2ZIezPdbVCY8hEQK",
+      "id": "rxSzs_OviJc0gW5DNTZun",
       "given": [
         "#API_Tags"
       ],
@@ -155,7 +155,7 @@
       "message": "OpenAPI object should have alphabetical \"tags\"."
     },
     {
-      "id": "HJNTpbliZwySnTGdnsygr",
+      "id": "pS49jzPscOOyPbkPGuvjN",
       "given": [
         "#API_Tags"
       ],
@@ -175,7 +175,7 @@
       "message": "OpenAPI object should have non-empty \"tags\" array."
     },
     {
-      "id": "7TDwDs46U0Nw80vfCDrps",
+      "id": "AKjeJEY-aw70uTB9AwEmQ",
       "given": [
         "#Operation_Object"
       ],
@@ -190,7 +190,7 @@
       "message": "Operation \"description\" should be present and non-empty string."
     },
     {
-      "id": "OEpBIj__fbWjex4a1GFz5",
+      "id": "62wgqUsGEqeL2Ybpig4Sj",
       "given": [
         "#Operation_Object"
       ],
@@ -205,7 +205,7 @@
       "message": "Operation should have \"operationId\"."
     },
     {
-      "id": "vkl1IQkWIj2sx7ZYoZf4o",
+      "id": "9qNOLrbzgR_vDfnb9-FhZ",
       "given": [
         "#Operation_Object"
       ],
@@ -223,7 +223,7 @@
       "message": "OperationId should not have characters that are invalid when used in URL."
     },
     {
-      "id": "z-HR4ZvHV2fygcAeKI5fV",
+      "id": "6XLxYmwG4MRncHIpLCi6v",
       "given": [
         "#API_Tags"
       ],
@@ -240,7 +240,7 @@
       "message": "Operation should not have more than a single tag."
     },
     {
-      "id": "4XYqfl3dLMPLb1qBk4zAO",
+      "id": "G9ECysPHML2-Y_oDsxEZH",
       "given": [
         "#Operation_Object"
       ],
@@ -259,7 +259,7 @@
       "message": "Operation should have non-empty \"tags\" array."
     },
     {
-      "id": "WkkQh9cHG6JoR5I56ocsx",
+      "id": "XrIgEoL0vkBK7djvG_wOU",
       "given": [
         "#Path_Item"
       ],
@@ -277,7 +277,7 @@
       "message": "Path parameter declarations must not be empty, ex.\"/given/{}\" is invalid."
     },
     {
-      "id": "iRVB5j57INV3J2sWg7zkm",
+      "id": "_gpO_KldtEFcWGTGEGb0S",
       "given": [
         "#API_Contact"
       ],
@@ -292,7 +292,7 @@
       "message": "Contact object should have \"name\""
     },
     {
-      "id": "Esdvs6PHGCcsjY0ePWR4D",
+      "id": "9DLPBlba2TunTHVGONd1M",
       "given": [
         "#Path_Object"
       ],
@@ -310,7 +310,7 @@
       "message": "Path should not end with slash."
     },
     {
-      "id": "Z0QPmj0r6BZ9fRDXniwil",
+      "id": "Q_bXZHV2QyVKj8KNqvwuc",
       "given": [
         "#Path_Object"
       ],
@@ -328,7 +328,7 @@
       "message": "Path should not include query string."
     },
     {
-      "id": "L-DrLUAlOFqoIhG1hvQtE",
+      "id": "ZUnskFUCIfnQA3YPqWyNF",
       "given": [
         "#API_Tags_Item"
       ],
@@ -343,7 +343,7 @@
       "message": "Tag object should have \"description\"."
     },
     {
-      "id": "ANTov8Tet7rQicy13B4Qv",
+      "id": "MSzSuJSMJ5EhyJYmvV05k",
       "given": [
         "#API_Server"
       ],
@@ -367,7 +367,7 @@
       "message": "Server should be present."
     },
     {
-      "id": "oass1K5ub_YictHhUFk9s",
+      "id": "A1lI5PWgY4YYc_i4vBgVF",
       "given": [
         "#API_Server_URL"
       ],
@@ -384,7 +384,7 @@
       "message": "Server URL should not have trailing slash"
     },
     {
-      "id": "2gtL6gIc9rWzMRvU7oJj6",
+      "id": "yc2q3F81oG-V3v9-lNt98",
       "given": [
         "#Operation_Object"
       ],
@@ -399,7 +399,7 @@
       "message": "Operation should have at least one \"2xx\" or \"3xx\" response."
     },
     {
-      "id": "cS7zcS3fsBJi4JtjZXqIB",
+      "id": "FG_69eYMh65j1gvh6sEYk",
       "given": [
         "#API_Document"
       ],
@@ -413,7 +413,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "KWS_v0LpGRAgeK5kABUws",
+      "id": "XlZ43Vxadxx_wQbbu91FE",
       "given": [
         "#Operation_Object"
       ],
@@ -428,7 +428,7 @@
       "message": "Operation parameters are unique and non-repeating."
     },
     {
-      "id": "iB3ORwR4VxGAtgyS9JIX_",
+      "id": "i7rzwCR20nArca5i2Hwk8",
       "given": [
         "#All_Enum"
       ],
@@ -442,7 +442,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "y7dhfP0WzQI1AJYYwMbc0",
+      "id": "AnHqcGsawmao13oGePrh2",
       "given": [
         "#API_Document"
       ],
@@ -459,7 +459,7 @@
       ]
     },
     {
-      "id": "UnAEI0Ta_T0QVEYKEWw47",
+      "id": "JgtlbZe4nAZSZpyEu0-Tm",
       "given": [
         "#API_Document"
       ],
@@ -476,7 +476,7 @@
       ]
     },
     {
-      "id": "h3VlKJWPw24H1IYWCK9rB",
+      "id": "_nCdlY1ZnEoY5R7X1KxHZ",
       "given": [
         "#API_Document"
       ],
@@ -493,7 +493,7 @@
       ]
     },
     {
-      "id": "oqNiQEa-O3-tD1hFFnbA-",
+      "id": "fO3lkYFi0sZOVn1Di6PqE",
       "given": [
         "#API_Document"
       ],
@@ -507,7 +507,7 @@
       "message": "Every operation must have unique operationId"
     },
     {
-      "id": "8F1Fc76YXyVfyK73Bz-Nj",
+      "id": "IPYrg2ojmIncIKvoLoXLz",
       "given": [
         "#Operation_Object"
       ],
@@ -524,7 +524,7 @@
       ]
     },
     {
-      "id": "mNhF6EM1DNPzbHJlwRFUU",
+      "id": "u0OuHRPBwnwyWqzEE-J5W",
       "given": [
         "#API_Document"
       ],
@@ -538,7 +538,7 @@
       "message": "Operation tags must be defined in global tags"
     },
     {
-      "id": "4vptdBpSVtYlKOMP97qHR",
+      "id": "pm9sRYJPGCVtNil3iE27G",
       "given": [
         "#All_Ref"
       ],
@@ -556,7 +556,7 @@
       ]
     },
     {
-      "id": "gp7kW5Fb9Ir-aRjF5zNGA",
+      "id": "1vkInLCKjbBRphaHvQmte",
       "given": [
         "#API_Document"
       ],
@@ -578,7 +578,7 @@
       ]
     },
     {
-      "id": "5kMbiR0TcCjKzu3gxgdy9",
+      "id": "gFoTrLnnTvCJGzyeU80kx",
       "given": [
         "#API_Document"
       ],
@@ -601,7 +601,7 @@
       ]
     },
     {
-      "id": "B3nn2VQwVzVRMX9JICjg0",
+      "id": "G7B23rnQSg4poMU-IH7Az",
       "given": [
         "#All_Enum"
       ],
@@ -622,7 +622,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "4ViApwY5cflEfGQg2bZ_8",
+      "id": "LQa6RFLpKqu_tgSfJz9Us",
       "given": [
         "#API_Document"
       ],
@@ -650,7 +650,7 @@
       ]
     },
     {
-      "id": "qp1gl_tgNlz3xO2MmVhU3",
+      "id": "CEMvGyvp25qZwmIbL26GV",
       "given": [
         "#API_Document"
       ],
@@ -668,7 +668,7 @@
       ]
     },
     {
-      "id": "unFYo09F3ugn7UY2r_LEA",
+      "id": "1Tlx1AIGW8L-dK7Yj7kf5",
       "given": [
         "#API_Server_URL"
       ],
@@ -684,7 +684,7 @@
       "message": "Server URL must not point at example.com."
     },
     {
-      "id": "TuO3tmnLJQ8iD9drzzGgs",
+      "id": "-OZa59ZyzOoFrN8Y_WfRu",
       "given": [
         "#Request_Parameter_All"
       ],
@@ -698,7 +698,7 @@
       "message": "Parameter objects must have \"description\"."
     },
     {
-      "id": "OpXNQqfPDVL9flecJB-Wh",
+      "id": "yrc68WkUijGgCRO1ExXsv",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -716,7 +716,7 @@
       ]
     },
     {
-      "id": "z8uRigJc9b_HNIS6Vq7Gr",
+      "id": "himtj8E3kZZvA1ZFCPge5",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -734,7 +734,7 @@
       ]
     },
     {
-      "id": "N73rgZkbJhDxBynNrnrJk",
+      "id": "Nkti3jodUuaaU8ghpLcqt",
       "given": [
         "#All_Example"
       ],
@@ -757,7 +757,7 @@
       ]
     },
     {
-      "id": "GQOO-gaoPhzeI9TRJkm1S",
+      "id": "CRlnam5qfbGVQCnhZGB_6",
       "given": [
         "#All_Example_Schema"
       ],
@@ -779,7 +779,7 @@
       ]
     },
     {
-      "id": "YL-KGuQSGog8oU4ruDzXx",
+      "id": "PB7uei4G8EPXEmcalGewE",
       "given": [
         "#All_Example_Schema"
       ],
@@ -801,7 +801,7 @@
       ]
     },
     {
-      "id": "k7CGYUIMjvD4M9Muv4Bbj",
+      "id": "qCVk224yfr6xYWSI_NUyl",
       "given": [
         "#All_Example_Media"
       ],
@@ -823,7 +823,7 @@
       ]
     },
     {
-      "id": "a5_BC18sUY5-4_nRwC7XY",
+      "id": "X4ZAy7VWY6rJ-tIj7KsZk",
       "given": [
         "#All_Example_Media"
       ],
diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index 8568def..e386987 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -3,7 +3,7 @@ x-stoplight:
   id: rm6bqdolcidct
 info:
   title: MorphoSource REST API
-  version: 0.4.0
+  version: 0.5.0
   summary: MorphoSource REST API to retrieve metadata for repository records
   contact:
     name: Julie Winchester

From 7b09f512bf8b1dadb7fbfe8d72bbe6f0e1a60d25 Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 10:51:45 -0600
Subject: [PATCH 2/7] Modified MorphoSource-REST-API.yaml

---
 MorphoSource-REST-API.yaml | 90 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 89 insertions(+), 1 deletion(-)

diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index e386987..c216dfc 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -851,96 +851,184 @@ components:
       properties:
         id:
           type: array
+          description: "\t\nMorphosource-specific unique ID identifier for a Work (Media, Organization, Device, etc.).\nhttps://www.morphosource.org/terms/ms/ID"
           items:
             type: string
+            example: '000123456'
         title:
           type: array
+          description: |-
+            A name given to the resource.
+            http://purl.org/dc/terms/title
           items:
             type: string
+            example: 'Skull cranium [Mesh] [Photogrammetry]'
         media_type:
           type: array
+          description: "Type, nature, or classification of a Media file dataset, which may include one or more specific files. This is the general or high-level type of all file data, it is not the file type of any specific file. Most Media Types encompass a variety of different specific file types. Values must be from the Media Type controlled vocabulary (https://www.morphosource.org/terms/mscv/MediaType).\n\thttp://www.morphosource.org/terms/ms/mediaType"
           items:
             type: string
+            example: Mesh
         modality:
           type: array
+          description: |-
+            The imaging modality used in the imaging event. Value must be from Image Modality controlled vocabulary (https://www.morphosource.org/terms/mscv/ImageModalityType).
+            http://www.morphosource.org/terms/ms/ieModality
           items:
             type: string
+            example: Photogrammetry
         device:
           type: array
+          description: |-
+            Manufacturer and model names of device used to image physical object to create media.
+
+            Device record class: https://www.morphosource.org/terms/ms/Device
           items:
             type: string
+            example: CameraCorp Camera D8500
         device_facility:
           type: array
+          description: |-
+            Institution and organization name for imaging facility that imaged physical object to create Media.
+
+            Organization record class: https://www.morphosource.org/terms/ms/Organization
           items:
             type: string
+            example: University of Education Imaging Facility for Scanning Things
         media_parent_id:
           type: array
+          description: |-
+            Morphosource-specific unique ID identifier for a Work (Media, Organization, Device, etc.). Specifically, the ID for the Media with a parental hierarchical relationship to this Media.
+            https://www.morphosource.org/terms/ms/ID
           items:
             type: string
         physical_object_id:
           type: array
+          description: |-
+            Morphosource-specific unique ID identifier for a Work (Media, Organization, Device, etc.). Specifically, the ID for the record of the physical object that this Media represents.
+            https://www.morphosource.org/terms/ms/ID
           items:
             type: string
         physical_object_title:
           type: array
+          description: |-
+            For biological specimens, the combined institution code, collection code, and catalog number separated by colons as a Darwin Core triplet. For a cultural heritage object, this is either the Darwin Core triplet or a short object tile. 
+            http://purl.org/dc/terms/title
           items:
             type: string
         physical_object_organization:
           type: array
+          description: |-
+            Organization name of the organization that manages the physical object from which the Media was imaged.
+
+            Organization record class: https://www.morphosource.org/terms/ms/Organization
           items:
             type: string
         physical_object_type:
           type: array
+          description: 'Type of the Object, typically "Biological Specimen" or "Cultural Heritage Object".'
           items:
             type: string
-        physical_object_taxonomy:
+        physical_object_taxonomy_name:
           type: array
+          description: 'Binomial taxonomic name, in most cases a combination of genus and species names. For objects identified only with higher order taxonomy, this may take the form of a higher order name followed by "indet."'
           items:
             type: string
+            x-stoplight:
+              id: uafr8zm9zx65k
+        physical_object_taxonomy_gbif:
+          type: array
+          description: 'List of taxonomic names associated with this physical object through a GBIF aggregated taxonomy, if one is available.'
+          items:
+            type: string
+            x-stoplight:
+              id: 0u6pb2oe3r8od
         part:
           type: array
+          description: |-
+            The portion or product of organism morphology, behaviour, environment, etc. that is either predominantly shown or particularly well exemplified by the media resource, denoted by an IRI.
+            http://rs.tdwg.org/ac/terms/subjectPart
           items:
             type: string
         side:
           type: array
+          description: |-
+            The side of a larger object on which is located a represented component part, if media represents a component part of a larger whole object. Values must be from the Side controlled vocabulary (http://www.morphosource.org/terms/ms/Side). Values are somewhat oriented toward objects with bilateral symmetry, but may in some cases be applied for objects with other kinds of symmetry.
+            https://www.morphosource.org/terms/ms/side
           items:
             type: string
+            example: Midline
         creator:
           type: array
+          description: |-
+            Examples of a Creator include a person, an organization, or a service. Typically, the name of a Creator should be used to indicate the entity.
+
+            An entity primarily responsible for making the resource.
+            http://purl.org/dc/elements/1.1/creator
           items:
             type: string
         short_description:
           type: array
+          description: |-
+            Brief summary description of Media. This could include a brief summary of what is represented in the Media or the context surrounding the Media.
+            https://www.morphosource.org/terms/ms/shortDescription
           items:
             type: string
         description:
           type: array
+          description: |-
+            Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource.
+
+            An account of the resource.
+            http://purl.org/dc/elements/1.1/description
           items:
             type: string
         ip_holder:
           type: array
+          description: |-
+            List of holders of intellectual property rights (copyright or license-based) for the Media.
+            https://www.morphosource.org/terms/ms/rightsHolder
           items:
             type: string
         copyright_statement:
           type: array
+          description: |-
+            Standardized rights statement used to communicate the copyright and/or reuse status of digital objects. Values must be from the Rights Statement controlled vocabulary (https://rightsstatements.org).
+            https://www.morphosource.org/terms/ms/rightsStatement
           items:
             type: string
         license:
           type: array
+          description: |-
+            Recommended practice is to identify the license document with a URI. If this is not possible or feasible, a literal value that identifies the license may be provided.
+
+            A legal document giving official permission to do something with the resource.
+            http://purl.org/dc/terms/license
           items:
             type: string
         morphosource_use_agreement_type:
           type: array
+          description: |-
+            Type of MorphoSource use agreement that users must agree to in order to download Media and that is packaged with an associated Media download. Values must be from the Use Agreement Type controlled vocabulary (http://www.morphosource.org/terms/mscv/UseAgreementType).
+            https://www.morphosource.org/terms/ms/morphosourceUseAgreementType
           items:
             type: string
         permits_commercial_use:
           type: array
+          description: |
+            Whether commercial use of Media is permitted. Values must be from the Commercial Use Permission controlled vocabulary (http://www.morphosource.org/terms/mscv/CommercialUsePermission).
+            https://www.morphosource.org/terms/ms/permitsCommercialUse
           items:
             type: string
+            example: CommercialUseNotPermitted
         permits_3d_use:
           type: array
+          description: |-
+            Whether Media may be 3D printed freely, may be 3D printed in limited ways, or if 3D printing is prohibited. Values must be from the 3D Printing Permission controlled vocabulary (http://www.morphosource.org/terms/mscv/3DPrintingPermission).
+            https://www.morphosource.org/terms/ms/permits3DUse
           items:
             type: string
+            example: 3DPrintingLimited
         required_archival_of_published_derivatives:
           type: array
           items:

From 6cf6cef34918a435c365a102a8fa2576120fdc28 Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 11:30:30 -0600
Subject: [PATCH 3/7] Add Media schema field information

---
 .stoplight/styleguide.json |  94 +++++++++++++++---------------
 MorphoSource-REST-API.yaml | 114 ++++++++++++++++++++++++++++++++++---
 2 files changed, 152 insertions(+), 56 deletions(-)

diff --git a/.stoplight/styleguide.json b/.stoplight/styleguide.json
index dd00c96..0a0614c 100644
--- a/.stoplight/styleguide.json
+++ b/.stoplight/styleguide.json
@@ -14,7 +14,7 @@
   "rules": {},
   "inheritedRules": [
     {
-      "id": "2NkF6ozXTzR-KlI0YMj9b",
+      "id": "lD4qf1G4e4XaTNK6JSdx6",
       "given": [
         "#API_Contact"
       ],
@@ -29,7 +29,7 @@
       "message": "Contact object should have \"url\""
     },
     {
-      "id": "rzTbLcMUdvJnfhpRf0hI9",
+      "id": "qFTc_yUwU0rUhOuNN4DIL",
       "given": [
         "#API_Contact"
       ],
@@ -44,7 +44,7 @@
       "message": "Contact object should have \"email\""
     },
     {
-      "id": "EN8Dwa-KTPMxfgAs68pE6",
+      "id": "-DSo_qhqFrXt1KJgbwbh7",
       "given": [
         "#API_Document"
       ],
@@ -59,7 +59,7 @@
       "message": "Info object should have \"contact\" object."
     },
     {
-      "id": "B4bbX5SCh8WeWYbTCWzfk",
+      "id": "qviBkQl9Q6vtDaz0h7Gz2",
       "given": [
         "#API_Document"
       ],
@@ -74,7 +74,7 @@
       "message": "Info object should have \"description\" object."
     },
     {
-      "id": "zG90RfTHIZLXTfxFEhUX0",
+      "id": "mJEWhhV7dHNG_hhDRps7h",
       "given": [
         "#API_Document"
       ],
@@ -89,7 +89,7 @@
       "message": "Info object should have \"license\" object."
     },
     {
-      "id": "w8GPOyw_68T3NlPlCUx5S",
+      "id": "yQJPyWIaP72BIqTHW0YKB",
       "given": [
         "#API_License"
       ],
@@ -104,7 +104,7 @@
       "message": "License object should include \"url\"."
     },
     {
-      "id": "bGRfwVjbgMe-eoLxRE7Vn",
+      "id": "oQWDzZ2RKppbCXaTk1RV1",
       "given": [
         "#All_Markdown"
       ],
@@ -121,7 +121,7 @@
       "message": "Markdown descriptions must not have \"eval(\"."
     },
     {
-      "id": "Xz5H80fGnG3KVWtPIsqWu",
+      "id": "FB6Fflf-UHdCdfkaKCx1B",
       "given": [
         "#All_Markdown"
       ],
@@ -138,7 +138,7 @@
       "message": "Markdown descriptions must not have \"<script>\" tags."
     },
     {
-      "id": "rxSzs_OviJc0gW5DNTZun",
+      "id": "43HkljTcJsNX4Awv1c-FG",
       "given": [
         "#API_Tags"
       ],
@@ -155,7 +155,7 @@
       "message": "OpenAPI object should have alphabetical \"tags\"."
     },
     {
-      "id": "pS49jzPscOOyPbkPGuvjN",
+      "id": "n0Jn4p8GrR1NYbWiap6pw",
       "given": [
         "#API_Tags"
       ],
@@ -175,7 +175,7 @@
       "message": "OpenAPI object should have non-empty \"tags\" array."
     },
     {
-      "id": "AKjeJEY-aw70uTB9AwEmQ",
+      "id": "IAQ20fz3PrW5nUq07OQys",
       "given": [
         "#Operation_Object"
       ],
@@ -190,7 +190,7 @@
       "message": "Operation \"description\" should be present and non-empty string."
     },
     {
-      "id": "62wgqUsGEqeL2Ybpig4Sj",
+      "id": "SDHOytb1kCjLG6l1v4qxE",
       "given": [
         "#Operation_Object"
       ],
@@ -205,7 +205,7 @@
       "message": "Operation should have \"operationId\"."
     },
     {
-      "id": "9qNOLrbzgR_vDfnb9-FhZ",
+      "id": "n3-TKnFOx3CQJHsK-bvZJ",
       "given": [
         "#Operation_Object"
       ],
@@ -223,7 +223,7 @@
       "message": "OperationId should not have characters that are invalid when used in URL."
     },
     {
-      "id": "6XLxYmwG4MRncHIpLCi6v",
+      "id": "590olqAucojrVEu8V_CvS",
       "given": [
         "#API_Tags"
       ],
@@ -240,7 +240,7 @@
       "message": "Operation should not have more than a single tag."
     },
     {
-      "id": "G9ECysPHML2-Y_oDsxEZH",
+      "id": "5Vpsa-Txn0OpQi0C4KY-B",
       "given": [
         "#Operation_Object"
       ],
@@ -259,7 +259,7 @@
       "message": "Operation should have non-empty \"tags\" array."
     },
     {
-      "id": "XrIgEoL0vkBK7djvG_wOU",
+      "id": "tbkjbP5rgbAQaEEM-dyDC",
       "given": [
         "#Path_Item"
       ],
@@ -277,7 +277,7 @@
       "message": "Path parameter declarations must not be empty, ex.\"/given/{}\" is invalid."
     },
     {
-      "id": "_gpO_KldtEFcWGTGEGb0S",
+      "id": "DSwUth0PVnyuIuT_fbXHE",
       "given": [
         "#API_Contact"
       ],
@@ -292,7 +292,7 @@
       "message": "Contact object should have \"name\""
     },
     {
-      "id": "9DLPBlba2TunTHVGONd1M",
+      "id": "7tCMagVfn83j06iWtrVz2",
       "given": [
         "#Path_Object"
       ],
@@ -310,7 +310,7 @@
       "message": "Path should not end with slash."
     },
     {
-      "id": "Q_bXZHV2QyVKj8KNqvwuc",
+      "id": "-1PfV-PYzRFaubIZCrdEd",
       "given": [
         "#Path_Object"
       ],
@@ -328,7 +328,7 @@
       "message": "Path should not include query string."
     },
     {
-      "id": "ZUnskFUCIfnQA3YPqWyNF",
+      "id": "74YdgO2zHZjePLOK3-z0v",
       "given": [
         "#API_Tags_Item"
       ],
@@ -343,7 +343,7 @@
       "message": "Tag object should have \"description\"."
     },
     {
-      "id": "MSzSuJSMJ5EhyJYmvV05k",
+      "id": "8KzI5EtWEcsdURUFQX3Ki",
       "given": [
         "#API_Server"
       ],
@@ -367,7 +367,7 @@
       "message": "Server should be present."
     },
     {
-      "id": "A1lI5PWgY4YYc_i4vBgVF",
+      "id": "Odavt0u7LFKcIuMWWYmfw",
       "given": [
         "#API_Server_URL"
       ],
@@ -384,7 +384,7 @@
       "message": "Server URL should not have trailing slash"
     },
     {
-      "id": "yc2q3F81oG-V3v9-lNt98",
+      "id": "QVZ1yrjad9l3avPcs13Z7",
       "given": [
         "#Operation_Object"
       ],
@@ -399,7 +399,7 @@
       "message": "Operation should have at least one \"2xx\" or \"3xx\" response."
     },
     {
-      "id": "FG_69eYMh65j1gvh6sEYk",
+      "id": "mAsatRwNb8yl2mEPzcw1e",
       "given": [
         "#API_Document"
       ],
@@ -413,7 +413,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "XlZ43Vxadxx_wQbbu91FE",
+      "id": "uMP3XYZu4xAioQXk1XWYW",
       "given": [
         "#Operation_Object"
       ],
@@ -428,7 +428,7 @@
       "message": "Operation parameters are unique and non-repeating."
     },
     {
-      "id": "i7rzwCR20nArca5i2Hwk8",
+      "id": "N0jO84AybCo1Clg4kNy7K",
       "given": [
         "#All_Enum"
       ],
@@ -442,7 +442,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "AnHqcGsawmao13oGePrh2",
+      "id": "RccXDkMgf8ZFbFCVt-6Fy",
       "given": [
         "#API_Document"
       ],
@@ -459,7 +459,7 @@
       ]
     },
     {
-      "id": "JgtlbZe4nAZSZpyEu0-Tm",
+      "id": "J9bXvRMwUWbjAQevpRow4",
       "given": [
         "#API_Document"
       ],
@@ -476,7 +476,7 @@
       ]
     },
     {
-      "id": "_nCdlY1ZnEoY5R7X1KxHZ",
+      "id": "-w9UdLTZ1V8BrVfJK5uco",
       "given": [
         "#API_Document"
       ],
@@ -493,7 +493,7 @@
       ]
     },
     {
-      "id": "fO3lkYFi0sZOVn1Di6PqE",
+      "id": "Px_c5BNfcuh90vlvIj_8b",
       "given": [
         "#API_Document"
       ],
@@ -507,7 +507,7 @@
       "message": "Every operation must have unique operationId"
     },
     {
-      "id": "IPYrg2ojmIncIKvoLoXLz",
+      "id": "3pydeWkcV8GxhreeTpANv",
       "given": [
         "#Operation_Object"
       ],
@@ -524,7 +524,7 @@
       ]
     },
     {
-      "id": "u0OuHRPBwnwyWqzEE-J5W",
+      "id": "WzaBrgXxfENHLi3kX2681",
       "given": [
         "#API_Document"
       ],
@@ -538,7 +538,7 @@
       "message": "Operation tags must be defined in global tags"
     },
     {
-      "id": "pm9sRYJPGCVtNil3iE27G",
+      "id": "c0tWZND3K4TDCw9TxSTn-",
       "given": [
         "#All_Ref"
       ],
@@ -556,7 +556,7 @@
       ]
     },
     {
-      "id": "1vkInLCKjbBRphaHvQmte",
+      "id": "Rc90qzd2f4tR-5PigEy74",
       "given": [
         "#API_Document"
       ],
@@ -578,7 +578,7 @@
       ]
     },
     {
-      "id": "gFoTrLnnTvCJGzyeU80kx",
+      "id": "FNSdwFfmuSGpJgE1fZkya",
       "given": [
         "#API_Document"
       ],
@@ -601,7 +601,7 @@
       ]
     },
     {
-      "id": "G7B23rnQSg4poMU-IH7Az",
+      "id": "6EERoiggSW2Opxr22E4dc",
       "given": [
         "#All_Enum"
       ],
@@ -622,7 +622,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "LQa6RFLpKqu_tgSfJz9Us",
+      "id": "0nEZ757YqU3470CVW50O8",
       "given": [
         "#API_Document"
       ],
@@ -650,7 +650,7 @@
       ]
     },
     {
-      "id": "CEMvGyvp25qZwmIbL26GV",
+      "id": "6_qr_fq4eV_gQM7YXjMdU",
       "given": [
         "#API_Document"
       ],
@@ -668,7 +668,7 @@
       ]
     },
     {
-      "id": "1Tlx1AIGW8L-dK7Yj7kf5",
+      "id": "cUjEywvra349MFAxp-ai-",
       "given": [
         "#API_Server_URL"
       ],
@@ -684,7 +684,7 @@
       "message": "Server URL must not point at example.com."
     },
     {
-      "id": "-OZa59ZyzOoFrN8Y_WfRu",
+      "id": "4ops_3fk_G8PSUW7AcPe8",
       "given": [
         "#Request_Parameter_All"
       ],
@@ -698,7 +698,7 @@
       "message": "Parameter objects must have \"description\"."
     },
     {
-      "id": "yrc68WkUijGgCRO1ExXsv",
+      "id": "0h0ZOHGZV7Z7fabCzbfpN",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -716,7 +716,7 @@
       ]
     },
     {
-      "id": "himtj8E3kZZvA1ZFCPge5",
+      "id": "K7leN9x-6sesr8y0pFF8q",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -734,7 +734,7 @@
       ]
     },
     {
-      "id": "Nkti3jodUuaaU8ghpLcqt",
+      "id": "KLvhrYUeOksXhEKn8sI2y",
       "given": [
         "#All_Example"
       ],
@@ -757,7 +757,7 @@
       ]
     },
     {
-      "id": "CRlnam5qfbGVQCnhZGB_6",
+      "id": "TXQKzKsAXQsmjwVcfZiV2",
       "given": [
         "#All_Example_Schema"
       ],
@@ -779,7 +779,7 @@
       ]
     },
     {
-      "id": "PB7uei4G8EPXEmcalGewE",
+      "id": "FA94z0WijfWT7Ka1WprOw",
       "given": [
         "#All_Example_Schema"
       ],
@@ -801,7 +801,7 @@
       ]
     },
     {
-      "id": "qCVk224yfr6xYWSI_NUyl",
+      "id": "KJ2k08yBwabQ8uZ7tvBG5",
       "given": [
         "#All_Example_Media"
       ],
@@ -823,7 +823,7 @@
       ]
     },
     {
-      "id": "X4ZAy7VWY6rJ-tIj7KsZk",
+      "id": "tRA2Zq7MsCCFeUslL0fnS",
       "given": [
         "#All_Example_Media"
       ],
diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index c216dfc..a95a754 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -847,7 +847,7 @@ components:
       x-stoplight:
         id: kmijtc5zxqytw
       type: object
-      description: 'Record for 3D, 2D, or AV media representing a physical object. This model represents the results from a search or individual record query.'
+      description: 'Record for 3D, 2D, or AV media representing a physical object. This model represents the results from a search or individual record query. Some fields may only be relevant to particular media types and/or modalities, and will not pertain to all Media records.'
       properties:
         id:
           type: array
@@ -862,7 +862,7 @@ components:
             http://purl.org/dc/terms/title
           items:
             type: string
-            example: 'Skull cranium [Mesh] [Photogrammetry]'
+            example: 'Cranium [Mesh] [Photogrammetry]'
         media_type:
           type: array
           description: "Type, nature, or classification of a Media file dataset, which may include one or more specific files. This is the general or high-level type of all file data, it is not the file type of any specific file. Most Media Types encompass a variety of different specific file types. Values must be from the Media Type controlled vocabulary (https://www.morphosource.org/terms/mscv/MediaType).\n\thttp://www.morphosource.org/terms/ms/mediaType"
@@ -902,6 +902,7 @@ components:
             https://www.morphosource.org/terms/ms/ID
           items:
             type: string
+            example: '000123451'
         physical_object_id:
           type: array
           description: |-
@@ -909,6 +910,7 @@ components:
             https://www.morphosource.org/terms/ms/ID
           items:
             type: string
+            example: '000104732'
         physical_object_title:
           type: array
           description: |-
@@ -916,6 +918,7 @@ components:
             http://purl.org/dc/terms/title
           items:
             type: string
+            example: 'INST:COLL:SPEC1234'
         physical_object_organization:
           type: array
           description: |-
@@ -924,11 +927,13 @@ components:
             Organization record class: https://www.morphosource.org/terms/ms/Organization
           items:
             type: string
+            example: Museum of Biological Specimens Collection of Vertebrates
         physical_object_type:
           type: array
           description: 'Type of the Object, typically "Biological Specimen" or "Cultural Heritage Object".'
           items:
             type: string
+            example: Biological Specimen
         physical_object_taxonomy_name:
           type: array
           description: 'Binomial taxonomic name, in most cases a combination of genus and species names. For objects identified only with higher order taxonomy, this may take the form of a higher order name followed by "indet."'
@@ -936,6 +941,7 @@ components:
             type: string
             x-stoplight:
               id: uafr8zm9zx65k
+            example: Puma concolor
         physical_object_taxonomy_gbif:
           type: array
           description: 'List of taxonomic names associated with this physical object through a GBIF aggregated taxonomy, if one is available.'
@@ -943,6 +949,7 @@ components:
             type: string
             x-stoplight:
               id: 0u6pb2oe3r8od
+            example: Felidae
         part:
           type: array
           description: |-
@@ -950,6 +957,7 @@ components:
             http://rs.tdwg.org/ac/terms/subjectPart
           items:
             type: string
+            example: Cranium
         side:
           type: array
           description: |-
@@ -958,6 +966,14 @@ components:
           items:
             type: string
             example: Midline
+        short_description:
+          type: array
+          description: |-
+            Brief summary description of Media. This could include a brief summary of what is represented in the Media or the context surrounding the Media.
+            https://www.morphosource.org/terms/ms/shortDescription
+          items:
+            type: string
+            example: Mesh with texture and color of Puma concolor cranium
         creator:
           type: array
           description: |-
@@ -967,13 +983,7 @@ components:
             http://purl.org/dc/elements/1.1/creator
           items:
             type: string
-        short_description:
-          type: array
-          description: |-
-            Brief summary description of Media. This could include a brief summary of what is represented in the Media or the context surrounding the Media.
-            https://www.morphosource.org/terms/ms/shortDescription
-          items:
-            type: string
+            example: Jane Smith
         description:
           type: array
           description: |-
@@ -983,6 +993,7 @@ components:
             http://purl.org/dc/elements/1.1/description
           items:
             type: string
+            example: Longer description with additional context of Media scanning or identity not captured in other fields.
         ip_holder:
           type: array
           description: |-
@@ -990,6 +1001,7 @@ components:
             https://www.morphosource.org/terms/ms/rightsHolder
           items:
             type: string
+            example: Museum of Biological Specimens
         copyright_statement:
           type: array
           description: |-
@@ -997,6 +1009,7 @@ components:
             https://www.morphosource.org/terms/ms/rightsStatement
           items:
             type: string
+            example: 'http://rightsstatements.org/vocab/NKC/1.0/'
         license:
           type: array
           description: |-
@@ -1006,6 +1019,7 @@ components:
             http://purl.org/dc/terms/license
           items:
             type: string
+            example: 'http://www.morphosource.org/terms/licenseUnknown/'
         morphosource_use_agreement_type:
           type: array
           description: |-
@@ -1013,6 +1027,7 @@ components:
             https://www.morphosource.org/terms/ms/morphosourceUseAgreementType
           items:
             type: string
+            example: Standard
         permits_commercial_use:
           type: array
           description: |
@@ -1031,92 +1046,173 @@ components:
             example: 3DPrintingLimited
         required_archival_of_published_derivatives:
           type: array
+          description: |-
+            Whether and how future derivatives created from Media must be rearchived on a public-facing digital repository such as MorphoSource. Values may include mandatory requirements or optional suggestions. Values must be from Derivative Rearchival Statement controlled vocabulary (http://www.morphosource.org/terms/mscv/DerivativeRearchivalStatement).
+            https://www.morphosource.org/terms/ms/requiredArchivalOfPublishedDerivatives
           items:
             type: string
+            example: OnAnyRepository
         funding:
           type: array
+          description: |-
+            Text description of organizations or individuals who funded the creation of the resource.
+            https://www.morphosource.org/terms/ms/funding
           items:
             type: string
+            example: NSF 123456789
         publisher:
           type: array
+          description: |-
+            Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.
+
+            An entity responsible for making the resource available.
+            http://purl.org/dc/elements/1.1/publisher
           items:
             type: string
         cite_as:
           type: array
+          description: |-
+            Instructions and guidelines for the citation of a Media. This should include additional instructions beyond those included in other metadata fields or in any download usage agreement.
+            https://www.morphosource.org/terms/ms/citeAs
           items:
             type: string
         ark:
           type: array
+          description: |
+            Persistent identifier for MorphoSource Media automatically created on Media submission. ARKs can apply to both unpublished and published media.
+            https://www.morphosource.org/terms/ms/ark
           items:
             type: string
         doi:
           type: array
+          description: |-
+            Persistent identifier for MorphoSource Media created only on user request. DOIs can apply only to published media.
+            https://www.morphosource.org/terms/ms/doi
           items:
             type: string
         external_identifier:
           type: array
+          description: |-
+            Used to provide third-party or external identifiers, which may be URIs or UUIDs, for this Media.
+            http://purl.org/dc/terms/identifier
           items:
             type: string
         external_media_url:
           type: array
+          description: |-
+            URL for additional resource that might provide additional information about the Media or Physical Object.
+            https://www.morphosource.org/terms/ms/relatedURL
           items:
             type: string
         visibility:
           type: array
+          description: |-
+            Publication status, denoting whether or not Media may be found in public search and whether or not Media files may be downloaded. Values must be from Publication Status controlled vocabulary (http://www.morphosource.org/terms/ms/PublicationStatus).
+            https://www.morphosource.org/terms/ms/visibility
           items:
             type: string
+            example: Restricted
         in_collections:
           type: array
+          description: Names of projects and teams to which the Media belongs.
           items:
             type: string
         date_uploaded:
           type: array
+          description: |-
+            Recommended practice is to describe the date, date/time, or period of time as recommended for the property Date, of which this is a subproperty.
+
+            Date of upload of the resource.
+            https://www.morphosource.org/terms/ms/dateUploaded
           items:
             type: string
+            example: '2022-02-02T19:00:37Z'
         date_modified:
           type: array
+          description: |-
+            Recommended practice is to describe the date, date/time, or period of time as recommended for the property Date, of which this is a subproperty.
+
+            Date on which the resource was changed.
+            https://www.morphosource.org/terms/ms/dateModified
           items:
             type: string
+            example: '2022-02-02T19:00:37Z'
         legacy_media_group_id:
           type: array
+          description: |-
+            MorphoSource-specific unique ID identifier that was used to group Media together in the now-defunct 1.0 version of the MorphoSource repository. In MorphoSource 1.0, Media groups were used to collect all media derived from the same Imaging Event. Media groups are no longer used, with media-to-media imaging and processing event relationships now being used instead to track hierarchical relationships between Media. Only present if Media was originally contributed to MorphoSource 1.0. Different from morphosource:ID identifier.
+            https://www.morphosource.org/terms/ms/legacyMediaGroupID
           items:
             type: string
         legacy_media_file_id:
           type: array
+          description: |-
+            MorphoSource-specific unique ID identifier that was used to represent a Media in the now-defunct 1.0 version of the MorphoSource repository. Only present if Media was originally contributed to MorphoSource 1.0. Different from morphosource:ID identifier.
+            https://www.morphosource.org/terms/ms/legacyMediaFileID
           items:
             type: string
         x_pixel_spacing:
           type: array
+          description: |-
+            Distance between centers of adjacent pixels in the X axis, for Media with pixel data where pixel spacing corresponds to real-world length measurement. Unit of measurement is described by morphosource:unit. Applies to Image and CTImageSeries media.
+            https://www.morphosource.org/terms/ms/xSpacing
           items:
             type: string
+            example: '0.154'
         y_pixel_spacing:
           type: array
+          description: |-
+            Distance between centers of adjacent pixels in the Y axis, for Media with pixel data where pixel spacing corresponds to real-world length measurement. Unit of measurement is described by morphosource:unit. Applies to Image and CTImageSeries media.
+            https://www.morphosource.org/terms/ms/ySpacing
           items:
             type: string
+            example: '0.154'
         z_pixel_spacing:
           type: array
+          description: |-
+            Distance between centers of adjacent pixels in the Z axis, for Media with 3D pixel data where pixel spacing corresponds to real-world length measurement. Unit of measurement is described by morphosource:unit. Applies to CTImageSeries media.
+            http://www.morphosource.org/terms/ms/zSpacing
           items:
             type: string
+            example: '0.154'
         slice_thickness:
           type: array
+          description: |-
+            Nominal slice thickness, in mm.
+            http://purl.org/healthcarevocab/v1#SliceThickness
           items:
             type: string
         unit:
           type: array
+          description: |-
+            Length measurement unit. For Mesh Media, this is the length unit associated with the 3D coordinate space of the mesh. For CTImageSeries Media, this is the length unit for X/Y/Z pixel spacing. Values must be from the Length Measurement Unit controlled vocabulary (http://www.morphosource.org/terms/ms/LengthMeasurementUnit).
+            https://www.morphosource.org/terms/ms/unit
           items:
             type: string
+            example: Mm
         number_of_images_in_set:
           type: array
+          description: |-
+            For Media with a ZIP archive with many component files, this is the number of files in the primary image collection in a CT image stack or photogrammetry image collection. This only applies to CTImageSeries or PhotogrammetryImageSeries Media.
+            https://www.morphosource.org/terms/ms/numberOfImagesInSet
           items:
             type: string
         data_manager:
           type: array
+          description: |-
+            The user that has the highest level of management control over a Media or another Work record. For Media, this user is also known as the Data Manager.
+            https://www.morphosource.org/terms/ms/owner
           items:
             type: string
+            example: Jane Smith
         data_depositor:
           type: array
+          description: |-
+            The MorphoSource user who uploaded the Media. May or may not also be the Media Data Manager.
+            https://www.morphosource.org/terms/ms/depositor
           items:
             type: string
+            example: Jane Smith
     Physical-Object:
       title: Physical Object
       x-stoplight:

From aa1e5791ecc3536214825b0957c75584d731cb47 Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 11:42:38 -0600
Subject: [PATCH 4/7] Add Physical Object schema field information

---
 MorphoSource-REST-API.yaml | 88 ++++++++++++++++++++++++++++++++++----
 1 file changed, 79 insertions(+), 9 deletions(-)

diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index a95a754..155b7c9 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -966,14 +966,6 @@ components:
           items:
             type: string
             example: Midline
-        short_description:
-          type: array
-          description: |-
-            Brief summary description of Media. This could include a brief summary of what is represented in the Media or the context surrounding the Media.
-            https://www.morphosource.org/terms/ms/shortDescription
-          items:
-            type: string
-            example: Mesh with texture and color of Puma concolor cranium
         creator:
           type: array
           description: |-
@@ -984,6 +976,14 @@ components:
           items:
             type: string
             example: Jane Smith
+        short_description:
+          type: array
+          description: |-
+            Brief summary description of Media. This could include a brief summary of what is represented in the Media or the context surrounding the Media.
+            https://www.morphosource.org/terms/ms/shortDescription
+          items:
+            type: string
+            example: Mesh with texture and color of Puma concolor cranium
         description:
           type: array
           description: |-
@@ -1213,6 +1213,14 @@ components:
           items:
             type: string
             example: Jane Smith
+        data_sponsor:
+          type: array
+          description: The entity covering costs of data storage for this Media on MorphoSource.
+          items:
+            type: string
+            example: Jane Smith
+            x-stoplight:
+              id: 9nmj5frrts1im
     Physical-Object:
       title: Physical Object
       x-stoplight:
@@ -1222,66 +1230,128 @@ components:
       properties:
         id:
           type: array
+          description: |-
+            Morphosource-specific unique ID identifier for a Work (Media, Organization, Device, etc.).
+            https://www.morphosource.org/terms/ms/PhysicalObject#ID
           items:
             type: string
         title:
           type: array
+          description: |-
+            For biological specimens, the combined institution code, collection code, and catalog number separated by colons as a Darwin Core triplet. For a cultural heritage object, this is either the Darwin Core triplet or a short object tile. 
+            http://purl.org/dc/terms/title
           items:
             type: string
         organization:
           type: array
+          description: |-
+            Organization name of the organization that manages the physical object from which the Media was imaged.
+
+            Organization record class: https://www.morphosource.org/terms/ms/Organization
           items:
             type: string
         institution_code:
           type: array
+          description: |-
+            The name (or acronym) in use by the institution having custody of the object(s) or information referred to in the record.
+            http://rs.tdwg.org/dwc/terms/institutionCode
           items:
             type: string
         collection_code:
           type: array
+          description: |-
+            The name, acronym, coden, or initialism identifying the collection or data set from which the record was derived.
+            http://rs.tdwg.org/dwc/terms/collectionCode
           items:
             type: string
         catalog_number:
           type: array
+          description: |-
+            An identifier (preferably unique) for the record within the data set or collection.
+            http://rs.tdwg.org/dwc/terms/catalogNumber
           items:
             type: string
         occurrence_id:
           type: array
+          description: |-
+            Recommended best practice is to use a persistent, globally unique identifier.
+
+            An identifier for the Occurrence (as opposed to a particular digital record of the occurrence). In the absence of a persistent global unique identifier, construct one from a combination of identifiers in the record that will most closely make the occurrenceID globally unique.
+            http://rs.tdwg.org/dwc/terms/occurrenceID
           items:
             type: string
         idigbio_uuid:
           type: array
+          description: |-
+            Global unique identifier for the Biological Specimen provided by iDigBio and used as the primary identifier of the Biological Specimen's record in the iDigBio aggregator if present. This is sometimes used in addition to more general identifiers or Darwin Core triplets (institution code : collection code : catalog number) to uniquely identify Biological Specimen.
+            https://www.morphosource.org/terms/ms/idigbioUUID
           items:
             type: string
         idigbio_recordset_id:
           type: array
+          description: |-
+            An identifier for an entire museum, institution, or laboratory specimen collection which includes the Biological Specimen. May be a global unique identifier or an identifier specific to a collection or institution.
+            https://www.morphosource.org/terms/ms/idigbioRecordsetID
           items:
             type: string
         type:
           type: array
+          description: 'Type of the Object, typically "Biological Specimen" or "Cultural Heritage Object".'
           items:
             type: string
         vouchered:
           type: array
+          description: |-
+            Whether the Biological Specimen is a holotype or not. If present, value must be "Yes" or "No".
+            https://www.morphosource.org/terms/ms/isTypeSpecimen
           items:
             type: string
-        taxonomy:
+        taxonomy_name:
+          type: array
+          description: 'Binomial taxonomic name, in most cases a combination of genus and species names. For objects identified only with higher order taxonomy, this may take the form of a higher order name followed by "indet."'
+          items:
+            type: string
+            x-stoplight:
+              id: cybhh61iz02gf
+        taxonomy_gbif:
           type: array
+          description: 'List of taxonomic names associated with this physical object through a GBIF aggregated taxonomy, if one is available.'
           items:
             type: string
+            x-stoplight:
+              id: sue4ujsxzbp26
         sex:
           type: array
+          description: |-
+            Recommended best practice is to use a controlled vocabulary.
+
+            The sex of the biological individual(s) represented in the Occurrence.
+            http://rs.tdwg.org/dwc/terms/sex
           items:
             type: string
         creator:
           type: array
+          description: |-
+            Entity responsible for collecting or creating the object.
+            http://purl.org/dc/elements/1.1/creator
           items:
             type: string
         date_uploaded:
           type: array
+          description: |-
+            Recommended practice is to describe the date, date/time, or period of time as recommended for the property Date, of which this is a subproperty.
+
+            Date of upload of the resource. 
+            https://www.morphosource.org/terms/ms/dateUploaded
           items:
             type: string
         date_modified:
           type: array
+          description: |-
+            Recommended practice is to describe the date, date/time, or period of time as recommended for the property Date, of which this is a subproperty.
+
+            Date on which the resource was changed. 
+            https://www.morphosource.org/terms/ms/dateModified
           items:
             type: string
     Catalog-Pages-Information:

From 120e253d7bfde16233b3f1c3644ba03b7ad31168 Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 12:19:22 -0600
Subject: [PATCH 5/7] Add api/media query parameters

---
 .stoplight/styleguide.json |  94 +++++++++++++--------------
 MorphoSource-REST-API.yaml | 129 ++++++++++++++++++++++++++++++++++---
 2 files changed, 168 insertions(+), 55 deletions(-)

diff --git a/.stoplight/styleguide.json b/.stoplight/styleguide.json
index 0a0614c..06d5043 100644
--- a/.stoplight/styleguide.json
+++ b/.stoplight/styleguide.json
@@ -14,7 +14,7 @@
   "rules": {},
   "inheritedRules": [
     {
-      "id": "lD4qf1G4e4XaTNK6JSdx6",
+      "id": "_ulei1fOh3U5wuLYWnhoj",
       "given": [
         "#API_Contact"
       ],
@@ -29,7 +29,7 @@
       "message": "Contact object should have \"url\""
     },
     {
-      "id": "qFTc_yUwU0rUhOuNN4DIL",
+      "id": "TW8wcVQPQZnhIJGoCvgC-",
       "given": [
         "#API_Contact"
       ],
@@ -44,7 +44,7 @@
       "message": "Contact object should have \"email\""
     },
     {
-      "id": "-DSo_qhqFrXt1KJgbwbh7",
+      "id": "dx6E9DWwPPTMpZNx9jNJN",
       "given": [
         "#API_Document"
       ],
@@ -59,7 +59,7 @@
       "message": "Info object should have \"contact\" object."
     },
     {
-      "id": "qviBkQl9Q6vtDaz0h7Gz2",
+      "id": "7x2t1hUFxPCyPUbkUiCl4",
       "given": [
         "#API_Document"
       ],
@@ -74,7 +74,7 @@
       "message": "Info object should have \"description\" object."
     },
     {
-      "id": "mJEWhhV7dHNG_hhDRps7h",
+      "id": "4S1f9MzxMfLVLWeR9B6u7",
       "given": [
         "#API_Document"
       ],
@@ -89,7 +89,7 @@
       "message": "Info object should have \"license\" object."
     },
     {
-      "id": "yQJPyWIaP72BIqTHW0YKB",
+      "id": "wZtyiOqKvfgU3_8SOh6K7",
       "given": [
         "#API_License"
       ],
@@ -104,7 +104,7 @@
       "message": "License object should include \"url\"."
     },
     {
-      "id": "oQWDzZ2RKppbCXaTk1RV1",
+      "id": "PR5S3i6BJjOJ2eRVkobno",
       "given": [
         "#All_Markdown"
       ],
@@ -121,7 +121,7 @@
       "message": "Markdown descriptions must not have \"eval(\"."
     },
     {
-      "id": "FB6Fflf-UHdCdfkaKCx1B",
+      "id": "i2KJqIiex_B8GQO32TQVR",
       "given": [
         "#All_Markdown"
       ],
@@ -138,7 +138,7 @@
       "message": "Markdown descriptions must not have \"<script>\" tags."
     },
     {
-      "id": "43HkljTcJsNX4Awv1c-FG",
+      "id": "lBQktRJO-K0atVyedTCfE",
       "given": [
         "#API_Tags"
       ],
@@ -155,7 +155,7 @@
       "message": "OpenAPI object should have alphabetical \"tags\"."
     },
     {
-      "id": "n0Jn4p8GrR1NYbWiap6pw",
+      "id": "TIcYYIY8q2z8cvID7UL6g",
       "given": [
         "#API_Tags"
       ],
@@ -175,7 +175,7 @@
       "message": "OpenAPI object should have non-empty \"tags\" array."
     },
     {
-      "id": "IAQ20fz3PrW5nUq07OQys",
+      "id": "K8iwOmC6SJP530obcbjgF",
       "given": [
         "#Operation_Object"
       ],
@@ -190,7 +190,7 @@
       "message": "Operation \"description\" should be present and non-empty string."
     },
     {
-      "id": "SDHOytb1kCjLG6l1v4qxE",
+      "id": "DwQz6ct_lL66lfdmhLWjQ",
       "given": [
         "#Operation_Object"
       ],
@@ -205,7 +205,7 @@
       "message": "Operation should have \"operationId\"."
     },
     {
-      "id": "n3-TKnFOx3CQJHsK-bvZJ",
+      "id": "uw1VP7L1dav0RPoBgFoF4",
       "given": [
         "#Operation_Object"
       ],
@@ -223,7 +223,7 @@
       "message": "OperationId should not have characters that are invalid when used in URL."
     },
     {
-      "id": "590olqAucojrVEu8V_CvS",
+      "id": "Ewa1u530xV5Db8K-Z-haJ",
       "given": [
         "#API_Tags"
       ],
@@ -240,7 +240,7 @@
       "message": "Operation should not have more than a single tag."
     },
     {
-      "id": "5Vpsa-Txn0OpQi0C4KY-B",
+      "id": "Ctpzh_SQY1wiDnK-JElEq",
       "given": [
         "#Operation_Object"
       ],
@@ -259,7 +259,7 @@
       "message": "Operation should have non-empty \"tags\" array."
     },
     {
-      "id": "tbkjbP5rgbAQaEEM-dyDC",
+      "id": "oBeZ1nNfGaF1q9pN69Vzg",
       "given": [
         "#Path_Item"
       ],
@@ -277,7 +277,7 @@
       "message": "Path parameter declarations must not be empty, ex.\"/given/{}\" is invalid."
     },
     {
-      "id": "DSwUth0PVnyuIuT_fbXHE",
+      "id": "TqG0jnlb9cjPPCFiEsIXa",
       "given": [
         "#API_Contact"
       ],
@@ -292,7 +292,7 @@
       "message": "Contact object should have \"name\""
     },
     {
-      "id": "7tCMagVfn83j06iWtrVz2",
+      "id": "TkK-SUw6hK4_OJAA90BxP",
       "given": [
         "#Path_Object"
       ],
@@ -310,7 +310,7 @@
       "message": "Path should not end with slash."
     },
     {
-      "id": "-1PfV-PYzRFaubIZCrdEd",
+      "id": "0dKh4XfVyH8BdxxgF7zKp",
       "given": [
         "#Path_Object"
       ],
@@ -328,7 +328,7 @@
       "message": "Path should not include query string."
     },
     {
-      "id": "74YdgO2zHZjePLOK3-z0v",
+      "id": "VPjFLVmAn03_RKVDOljsS",
       "given": [
         "#API_Tags_Item"
       ],
@@ -343,7 +343,7 @@
       "message": "Tag object should have \"description\"."
     },
     {
-      "id": "8KzI5EtWEcsdURUFQX3Ki",
+      "id": "aIAbe2DvhC14Ji4vRM4hM",
       "given": [
         "#API_Server"
       ],
@@ -367,7 +367,7 @@
       "message": "Server should be present."
     },
     {
-      "id": "Odavt0u7LFKcIuMWWYmfw",
+      "id": "TQ8-FkdhjludjfAOwWeh5",
       "given": [
         "#API_Server_URL"
       ],
@@ -384,7 +384,7 @@
       "message": "Server URL should not have trailing slash"
     },
     {
-      "id": "QVZ1yrjad9l3avPcs13Z7",
+      "id": "-0s3yMQbILx00DHMS-Tlo",
       "given": [
         "#Operation_Object"
       ],
@@ -399,7 +399,7 @@
       "message": "Operation should have at least one \"2xx\" or \"3xx\" response."
     },
     {
-      "id": "mAsatRwNb8yl2mEPzcw1e",
+      "id": "Yy6J6JQ8EkYueiygzLyaW",
       "given": [
         "#API_Document"
       ],
@@ -413,7 +413,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "uMP3XYZu4xAioQXk1XWYW",
+      "id": "PhhJ6ORieayBod9FE707I",
       "given": [
         "#Operation_Object"
       ],
@@ -428,7 +428,7 @@
       "message": "Operation parameters are unique and non-repeating."
     },
     {
-      "id": "N0jO84AybCo1Clg4kNy7K",
+      "id": "kiUQv_XsSRTTQy4p0DWKA",
       "given": [
         "#All_Enum"
       ],
@@ -442,7 +442,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "RccXDkMgf8ZFbFCVt-6Fy",
+      "id": "z86WcCciWrxMo5Oa8f4I1",
       "given": [
         "#API_Document"
       ],
@@ -459,7 +459,7 @@
       ]
     },
     {
-      "id": "J9bXvRMwUWbjAQevpRow4",
+      "id": "4vFv42-kArzhHNzz0C0gA",
       "given": [
         "#API_Document"
       ],
@@ -476,7 +476,7 @@
       ]
     },
     {
-      "id": "-w9UdLTZ1V8BrVfJK5uco",
+      "id": "D-TbDlWw_b7j_ys0Qt35q",
       "given": [
         "#API_Document"
       ],
@@ -493,7 +493,7 @@
       ]
     },
     {
-      "id": "Px_c5BNfcuh90vlvIj_8b",
+      "id": "ek3iAkCJo_WYLfP7JCea4",
       "given": [
         "#API_Document"
       ],
@@ -507,7 +507,7 @@
       "message": "Every operation must have unique operationId"
     },
     {
-      "id": "3pydeWkcV8GxhreeTpANv",
+      "id": "Gkjcn2A_oLkWucjP1p2b_",
       "given": [
         "#Operation_Object"
       ],
@@ -524,7 +524,7 @@
       ]
     },
     {
-      "id": "WzaBrgXxfENHLi3kX2681",
+      "id": "vMrtU6Sdkyt0tfJInb2WE",
       "given": [
         "#API_Document"
       ],
@@ -538,7 +538,7 @@
       "message": "Operation tags must be defined in global tags"
     },
     {
-      "id": "c0tWZND3K4TDCw9TxSTn-",
+      "id": "kY_E95IbAqQE4YiaMVfXd",
       "given": [
         "#All_Ref"
       ],
@@ -556,7 +556,7 @@
       ]
     },
     {
-      "id": "Rc90qzd2f4tR-5PigEy74",
+      "id": "u3H7ZhbrLKbLDE2FIRTa4",
       "given": [
         "#API_Document"
       ],
@@ -578,7 +578,7 @@
       ]
     },
     {
-      "id": "FNSdwFfmuSGpJgE1fZkya",
+      "id": "9WLn6IFDWgbupnx1kEvBk",
       "given": [
         "#API_Document"
       ],
@@ -601,7 +601,7 @@
       ]
     },
     {
-      "id": "6EERoiggSW2Opxr22E4dc",
+      "id": "ZFwjAjyu2QadWocsEr0HJ",
       "given": [
         "#All_Enum"
       ],
@@ -622,7 +622,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "0nEZ757YqU3470CVW50O8",
+      "id": "O2JfxOMh8aFtHp53j4_az",
       "given": [
         "#API_Document"
       ],
@@ -650,7 +650,7 @@
       ]
     },
     {
-      "id": "6_qr_fq4eV_gQM7YXjMdU",
+      "id": "o4gzNmLnxS5mofi50JTx_",
       "given": [
         "#API_Document"
       ],
@@ -668,7 +668,7 @@
       ]
     },
     {
-      "id": "cUjEywvra349MFAxp-ai-",
+      "id": "CJHx5RZpyPINgnjgbz4kZ",
       "given": [
         "#API_Server_URL"
       ],
@@ -684,7 +684,7 @@
       "message": "Server URL must not point at example.com."
     },
     {
-      "id": "4ops_3fk_G8PSUW7AcPe8",
+      "id": "pjFHTR3Z9LXTrntdjorCG",
       "given": [
         "#Request_Parameter_All"
       ],
@@ -698,7 +698,7 @@
       "message": "Parameter objects must have \"description\"."
     },
     {
-      "id": "0h0ZOHGZV7Z7fabCzbfpN",
+      "id": "z8LaQSTFuPV4mxFNxoBKo",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -716,7 +716,7 @@
       ]
     },
     {
-      "id": "K7leN9x-6sesr8y0pFF8q",
+      "id": "4ap8Q1gWkhatDSfvXhBJL",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -734,7 +734,7 @@
       ]
     },
     {
-      "id": "KLvhrYUeOksXhEKn8sI2y",
+      "id": "JDsatNlN1uA8EGR5NAhTv",
       "given": [
         "#All_Example"
       ],
@@ -757,7 +757,7 @@
       ]
     },
     {
-      "id": "TXQKzKsAXQsmjwVcfZiV2",
+      "id": "S0lPuW2SC3kiDDAxCXT1b",
       "given": [
         "#All_Example_Schema"
       ],
@@ -779,7 +779,7 @@
       ]
     },
     {
-      "id": "FA94z0WijfWT7Ka1WprOw",
+      "id": "T8RCG4fHNyMqq89AnQib2",
       "given": [
         "#All_Example_Schema"
       ],
@@ -801,7 +801,7 @@
       ]
     },
     {
-      "id": "KJ2k08yBwabQ8uZ7tvBG5",
+      "id": "KeFqs14y-bEEx2YTA_F3S",
       "given": [
         "#All_Example_Media"
       ],
@@ -823,7 +823,7 @@
       ]
     },
     {
-      "id": "tRA2Zq7MsCCFeUslL0fnS",
+      "id": "fc4IhHxjvTjanP_QiJZGq",
       "given": [
         "#All_Example_Media"
       ],
diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index 155b7c9..955ae66 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -89,13 +89,16 @@ paths:
                       media:
                         $ref: '#/components/schemas/Media'
               examples: {}
+        '404':
+          $ref: '#/components/responses/404-Not-Found'
       operationId: get-api-media-id
       description: |-
         Returns metadata for a single media record. 
 
-        API key is not required for published media, but can be used to authenticate access to private media.
+        API key is optional. Querying published media does not require an API key. An API key can be used to query private media the user has specific access to view. If this route is used to query a media that does not exist, a media that is private and the request does not supply an API key, or a media that is private and an API key is supplied but the user does not have access to view the media, then a 404 Not Found response will be returned.
       parameters: []
       security:
+        - {}
         - API-Key: []
       tags:
         - Media endpoints
@@ -137,21 +140,131 @@ paths:
               examples: {}
       operationId: get-api-media
       description: |-
-        Searches for media records and returns metadata. 
+        Searches for multiple Media records and returns metadata. A free text search query parameter is used to search across many different Media record fields. Results will be returned in paged format, with default results being returned for the first page of up to 1,000 results. Results can be filtered through the use of filter facets, which should always be supplied as query parameters in the form "f.<field_name>". See below for the list of applicable filter facet fields. This route provides equivalent functionality to the MorphoSource Media Search page (https://www.morphosource.org/catalog/media), the use of query parameters is very similar between that page and this endpoint. Experimenting with the features of the Media Search page may be instructive for use of this endpoint.
 
-        API key is not required for published media, but can be used to authenticate access to private media.
+        API key is optional. Searching published media does not require an API key. An API key can be used to search private media the user has specific access to view.
       parameters:
         - schema:
             type: string
-            example: all_fields
           in: query
-          name: search_field
-          description: Must be "all_fields" to use search query
+          name: q
+          description: 'Search query. This is optional, and without a query all Media matching filter facet options will be shown. Omitting query and filter information can be used to query all Media the user has access to view'
+        - schema:
+            type: integer
+            default: 1
+            format: int32
+          in: query
+          name: page
+          description: Current results page. Displays number of results equal to per_page parameter at current page increment.
+        - schema:
+            type: integer
+            default: 10
+            maximum: 1000
+            minimum: 1
+            format: int32
+          in: query
+          name: per_page
+          description: Number of results to display. Maximum value of 1000 results per page.
         - schema:
             type: string
+            example: CT Image Series
           in: query
-          name: q
-          description: Search query
+          name: f.media_type
+          description: Media Type
+        - schema:
+            type: string
+            example: MicroNanoXRayComputedTomography
+          in: query
+          name: f.modality
+          description: Modality
+        - schema:
+            type: string
+            example: Biological Specimen
+          in: query
+          name: f.object_type
+          description: Object Type
+        - schema:
+            type: string
+            example: Museum of Biological Specimens Collection of Vertebrates
+          in: query
+          name: f.organization
+          description: Organization
+        - schema:
+            type: string
+            example: University of Education Facility for Scanning Things
+          in: query
+          name: f.imaging_facility
+          description: Imaging Facility
+        - schema:
+            type: string
+            example: Open Download
+          in: query
+          name: f.publication_status
+          description: Publication Status
+        - schema:
+            type: string
+            example: 'http://rightsstatements.org/vocab/InC/1.0/'
+          in: query
+          name: f.rights_statement
+          description: Rights Statement
+        - schema:
+            type: string
+            example: 'https://creativecommons.org/licenses/by-nc/4.0/'
+          in: query
+          name: f.license
+          description: CC License
+        - schema:
+            type: string
+            example: Puma concolor
+          in: query
+          name: f.taxonomy_name
+          description: Taxonomy (Name)
+        - schema:
+            type: string
+            example: Felidae
+          in: query
+          name: f.taxonomy_gbif
+          description: Taxonomy (GBIF)
+        - schema:
+            type: string
+          in: query
+          name: f.tag
+          description: Tag
+        - schema:
+            type: string
+          in: query
+          name: f.team
+          description: Team Containing Media
+        - schema:
+            type: string
+          in: query
+          name: f.project
+          description: Project Containing Media
+        - schema:
+            type: string
+          in: query
+          name: f.media_list
+          description: Media List Containing Media
+        - schema:
+            type: string
+          in: query
+          name: f.seq_section_list
+          description: Sequential Section List Containing Media
+        - schema:
+            type: string
+          in: query
+          name: f.owner
+          description: Data Manager
+        - schema:
+            type: string
+          in: query
+          name: f.depositor
+          description: Data Uploader
+        - schema:
+            type: string
+          in: query
+          name: f.sponsor
+          description: Data Sponsor
       security:
         - API-Key: []
       tags:

From 43548d4db6482be22a598e4fcd9f116c83bd5724 Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 12:29:18 -0600
Subject: [PATCH 6/7] Add physical object search query params

---
 MorphoSource-REST-API.yaml | 94 +++++++++++++++++++++++++++++++++-----
 1 file changed, 83 insertions(+), 11 deletions(-)

diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index 955ae66..e7b363d 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -93,9 +93,9 @@ paths:
           $ref: '#/components/responses/404-Not-Found'
       operationId: get-api-media-id
       description: |-
-        Returns metadata for a single media record. 
+        Returns metadata for a single Media record. 
 
-        API key is optional. Querying published media does not require an API key. An API key can be used to query private media the user has specific access to view. If this route is used to query a media that does not exist, a media that is private and the request does not supply an API key, or a media that is private and an API key is supplied but the user does not have access to view the media, then a 404 Not Found response will be returned.
+        API key is optional. Querying published media does not require an API key. An API key can be used to query private Media the user has specific access to view. If this route is used to query a Media that does not exist, a Media that is private and the request does not supply an API key, or a Media that is private and an API key is supplied but the user does not have access to view the Media, then a 404 Not Found response will be returned.
       parameters: []
       security:
         - {}
@@ -290,11 +290,12 @@ paths:
               examples: {}
       operationId: get-api-physical-object-id
       description: |-
-        Returns metadata for a single physical object (biological specimen or cultural heritage object) record.
+        Returns metadata for a single Physical Object (Biological Specimen or Cultural Heritage Object) record.
 
-        It is possible to include an API key, but by default all physical object records are public. Therefore, this is generally unnecessary.
+        It is possible to include an API key, but by default all Physical Object records are public. Therefore, this is generally unnecessary.
       parameters: []
       security:
+        - {}
         - API-Key: []
       tags:
         - Physical object endpoints
@@ -334,25 +335,96 @@ paths:
               examples: {}
       operationId: get-api-physical-objects
       description: |-
-        Searches for physical object (biological specimen or cultural heritage object) records and returns metadata. 
+        Searches for multiple Physical Object (Biological Specimen or Cultural Heritage Object) records and returns metadata. A free text search query parameter is used to search across many different Physical Object record fields. Results will be returned in paged format, with default results being returned for the first page of up to 1,000 results. Results can be filtered through the use of filter facets, which should always be supplied as query parameters in the form "f.<field_name>". See below for the list of applicable filter facet fields. This route provides equivalent functionality to the MorphoSource Object Search page (https://www.morphosource.org/catalog/objects), the use of query parameters is very similar between that page and this endpoint. Experimenting with the features of the Object Search page may be instructive for use of this endpoint.
 
-        It is possible to include an API key, but by default all physical object records are public. Therefore, this is generally unnecessary.
+        It is possible to include an API key, but by default all Physical Object records are public. Therefore, this is generally unnecessary.
       parameters:
         - schema:
             type: string
-            example: all_fields
           in: query
-          name: search_field
-          description: Must be "all_fields" to use search query
+          name: q
+          description: 'Search query. This is optional, and without a query all Physical Object matching filter facet options will be shown. Omitting query and filter information can be used to query all Physical Objects.'
+        - schema:
+            type: integer
+            default: 1
+          in: query
+          name: page
+          description: Current results page. Displays number of results equal to per_page parameter at current page increment.
+        - schema:
+            type: integer
+            default: 10
+            minimum: 1
+            maximum: 1000
+          in: query
+          name: per_page
+          description: Number of results to display. Maximum value of 1000 results per page.
         - schema:
             type: string
+            example: Biological Specimen
           in: query
-          name: q
-          description: Search query
+          name: f.object_type
+          description: Object Type
+        - schema:
+            type: string
+          in: query
+          name: f.creator
+          description: Collector/Creator
+        - schema:
+            type: string
+            example: Museum of Biological Specimens Collection of Vertebrates
+          in: query
+          name: f.organization
+          description: Organization
+        - schema:
+            type: string
+            example: Puma concolor
+          in: query
+          name: f.taxonomy_name
+          description: Taxonomy (Name)
+        - schema:
+            type: string
+            example: Felidae
+          in: query
+          name: f.taxonomy_gbif
+          description: Taxonomy (GBIF)
+        - schema:
+            type: string
+            example: CT Image Series
+          in: query
+          name: f.media_type
+          description: Media Type
+        - schema:
+            type: string
+          in: query
+          name: f.media_tag
+          description: Media Tag
+        - schema:
+            type: string
+          in: query
+          name: f.team
+          description: Team Containing Media of Object
+        - schema:
+            type: string
+          in: query
+          name: f.project
+          description: Project Containing Media of Object
+        - schema:
+            type: string
+          in: query
+          name: f.media_list
+          description: Media List Containing Media of Object
+        - schema:
+            type: string
+          in: query
+          name: f.seq_section_list
+          description: Sequential Section List Containing Media of Object
       security:
+        - {}
         - API-Key: []
       tags:
         - Physical object endpoints
+      requestBody:
+        content: {}
     parameters: []
   '/api/organizations/{organization-id}':
     get:

From 26a95bf9f11dab8bcc8bb398e8324ae809977682 Mon Sep 17 00:00:00 2001
From: Julie Winchester <julie.winchester@duke.edu>
Date: Tue, 14 Nov 2023 12:39:05 -0600
Subject: [PATCH 7/7] Add organization and project/team query parameters

---
 .stoplight/styleguide.json | 94 ++++++++++++++++++-------------------
 MorphoSource-REST-API.yaml | 95 ++++++++++++++++++++++++++++++++------
 2 files changed, 128 insertions(+), 61 deletions(-)

diff --git a/.stoplight/styleguide.json b/.stoplight/styleguide.json
index 06d5043..92f6e10 100644
--- a/.stoplight/styleguide.json
+++ b/.stoplight/styleguide.json
@@ -14,7 +14,7 @@
   "rules": {},
   "inheritedRules": [
     {
-      "id": "_ulei1fOh3U5wuLYWnhoj",
+      "id": "1U2wIzo7ixAyLwG4nx_PJ",
       "given": [
         "#API_Contact"
       ],
@@ -29,7 +29,7 @@
       "message": "Contact object should have \"url\""
     },
     {
-      "id": "TW8wcVQPQZnhIJGoCvgC-",
+      "id": "-ZlG6WWacSWC7nP_qNkYx",
       "given": [
         "#API_Contact"
       ],
@@ -44,7 +44,7 @@
       "message": "Contact object should have \"email\""
     },
     {
-      "id": "dx6E9DWwPPTMpZNx9jNJN",
+      "id": "HGzjm-9KOYoOMCTLjjgJe",
       "given": [
         "#API_Document"
       ],
@@ -59,7 +59,7 @@
       "message": "Info object should have \"contact\" object."
     },
     {
-      "id": "7x2t1hUFxPCyPUbkUiCl4",
+      "id": "dsAyqbEsLcY2fw_Ss3Rm4",
       "given": [
         "#API_Document"
       ],
@@ -74,7 +74,7 @@
       "message": "Info object should have \"description\" object."
     },
     {
-      "id": "4S1f9MzxMfLVLWeR9B6u7",
+      "id": "yzhOzdXjzsshPxdPCTGmW",
       "given": [
         "#API_Document"
       ],
@@ -89,7 +89,7 @@
       "message": "Info object should have \"license\" object."
     },
     {
-      "id": "wZtyiOqKvfgU3_8SOh6K7",
+      "id": "YZUrZjrcAT8azCatXcjzI",
       "given": [
         "#API_License"
       ],
@@ -104,7 +104,7 @@
       "message": "License object should include \"url\"."
     },
     {
-      "id": "PR5S3i6BJjOJ2eRVkobno",
+      "id": "J-dRQR23Fw3HaQKs8q9Ot",
       "given": [
         "#All_Markdown"
       ],
@@ -121,7 +121,7 @@
       "message": "Markdown descriptions must not have \"eval(\"."
     },
     {
-      "id": "i2KJqIiex_B8GQO32TQVR",
+      "id": "1cEUJ1U50X56puh81LCJk",
       "given": [
         "#All_Markdown"
       ],
@@ -138,7 +138,7 @@
       "message": "Markdown descriptions must not have \"<script>\" tags."
     },
     {
-      "id": "lBQktRJO-K0atVyedTCfE",
+      "id": "yur9hq8dBUbLbEYxkxzs4",
       "given": [
         "#API_Tags"
       ],
@@ -155,7 +155,7 @@
       "message": "OpenAPI object should have alphabetical \"tags\"."
     },
     {
-      "id": "TIcYYIY8q2z8cvID7UL6g",
+      "id": "wyQgysT4Oc30esBubYJsf",
       "given": [
         "#API_Tags"
       ],
@@ -175,7 +175,7 @@
       "message": "OpenAPI object should have non-empty \"tags\" array."
     },
     {
-      "id": "K8iwOmC6SJP530obcbjgF",
+      "id": "l84VMoVGYE7PGuQMzV3Ts",
       "given": [
         "#Operation_Object"
       ],
@@ -190,7 +190,7 @@
       "message": "Operation \"description\" should be present and non-empty string."
     },
     {
-      "id": "DwQz6ct_lL66lfdmhLWjQ",
+      "id": "madf_30zjsRXcXas7xpsc",
       "given": [
         "#Operation_Object"
       ],
@@ -205,7 +205,7 @@
       "message": "Operation should have \"operationId\"."
     },
     {
-      "id": "uw1VP7L1dav0RPoBgFoF4",
+      "id": "cZrGz6CJYya5mWjJTwLiA",
       "given": [
         "#Operation_Object"
       ],
@@ -223,7 +223,7 @@
       "message": "OperationId should not have characters that are invalid when used in URL."
     },
     {
-      "id": "Ewa1u530xV5Db8K-Z-haJ",
+      "id": "UVgi7ZX3WWgY_tpXr2-nA",
       "given": [
         "#API_Tags"
       ],
@@ -240,7 +240,7 @@
       "message": "Operation should not have more than a single tag."
     },
     {
-      "id": "Ctpzh_SQY1wiDnK-JElEq",
+      "id": "rcDdJ9G964erBdn-zDcm8",
       "given": [
         "#Operation_Object"
       ],
@@ -259,7 +259,7 @@
       "message": "Operation should have non-empty \"tags\" array."
     },
     {
-      "id": "oBeZ1nNfGaF1q9pN69Vzg",
+      "id": "lAzXqqvbeeou_5DsK5x6D",
       "given": [
         "#Path_Item"
       ],
@@ -277,7 +277,7 @@
       "message": "Path parameter declarations must not be empty, ex.\"/given/{}\" is invalid."
     },
     {
-      "id": "TqG0jnlb9cjPPCFiEsIXa",
+      "id": "kf1X29ZiqFcalaieFLRE9",
       "given": [
         "#API_Contact"
       ],
@@ -292,7 +292,7 @@
       "message": "Contact object should have \"name\""
     },
     {
-      "id": "TkK-SUw6hK4_OJAA90BxP",
+      "id": "zbccLf1W08-o--cR4b6iU",
       "given": [
         "#Path_Object"
       ],
@@ -310,7 +310,7 @@
       "message": "Path should not end with slash."
     },
     {
-      "id": "0dKh4XfVyH8BdxxgF7zKp",
+      "id": "VieHaW9r8twW7Mf2R3zZd",
       "given": [
         "#Path_Object"
       ],
@@ -328,7 +328,7 @@
       "message": "Path should not include query string."
     },
     {
-      "id": "VPjFLVmAn03_RKVDOljsS",
+      "id": "JD5RWLIFn9JiiyNpmwAPd",
       "given": [
         "#API_Tags_Item"
       ],
@@ -343,7 +343,7 @@
       "message": "Tag object should have \"description\"."
     },
     {
-      "id": "aIAbe2DvhC14Ji4vRM4hM",
+      "id": "L44odZGcuVhMbTBmLNtj-",
       "given": [
         "#API_Server"
       ],
@@ -367,7 +367,7 @@
       "message": "Server should be present."
     },
     {
-      "id": "TQ8-FkdhjludjfAOwWeh5",
+      "id": "Qs9F10B8PX043cM6yqMMY",
       "given": [
         "#API_Server_URL"
       ],
@@ -384,7 +384,7 @@
       "message": "Server URL should not have trailing slash"
     },
     {
-      "id": "-0s3yMQbILx00DHMS-Tlo",
+      "id": "hlr7PEiBg1AER3O0-bXRb",
       "given": [
         "#Operation_Object"
       ],
@@ -399,7 +399,7 @@
       "message": "Operation should have at least one \"2xx\" or \"3xx\" response."
     },
     {
-      "id": "Yy6J6JQ8EkYueiygzLyaW",
+      "id": "IWwzaoFeQsFV72njvBYCu",
       "given": [
         "#API_Document"
       ],
@@ -413,7 +413,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "PhhJ6ORieayBod9FE707I",
+      "id": "FdqhVp9t06GpwdK1H6K9c",
       "given": [
         "#Operation_Object"
       ],
@@ -428,7 +428,7 @@
       "message": "Operation parameters are unique and non-repeating."
     },
     {
-      "id": "kiUQv_XsSRTTQy4p0DWKA",
+      "id": "1TJXCOPepAYCy6adhOzGt",
       "given": [
         "#All_Enum"
       ],
@@ -442,7 +442,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "z86WcCciWrxMo5Oa8f4I1",
+      "id": "uz34jnq6FPFiJJs95rZu4",
       "given": [
         "#API_Document"
       ],
@@ -459,7 +459,7 @@
       ]
     },
     {
-      "id": "4vFv42-kArzhHNzz0C0gA",
+      "id": "50nJASlAKo_xyx0hvmO-l",
       "given": [
         "#API_Document"
       ],
@@ -476,7 +476,7 @@
       ]
     },
     {
-      "id": "D-TbDlWw_b7j_ys0Qt35q",
+      "id": "MPABAdOXP4lAIUQIbh2Ui",
       "given": [
         "#API_Document"
       ],
@@ -493,7 +493,7 @@
       ]
     },
     {
-      "id": "ek3iAkCJo_WYLfP7JCea4",
+      "id": "xP6lzs5tVQr5h9Np5vlxB",
       "given": [
         "#API_Document"
       ],
@@ -507,7 +507,7 @@
       "message": "Every operation must have unique operationId"
     },
     {
-      "id": "Gkjcn2A_oLkWucjP1p2b_",
+      "id": "41e2cv86N2Qq2pV5zUu94",
       "given": [
         "#Operation_Object"
       ],
@@ -524,7 +524,7 @@
       ]
     },
     {
-      "id": "vMrtU6Sdkyt0tfJInb2WE",
+      "id": "dsD5HdUF-xvAvm_FhIPgV",
       "given": [
         "#API_Document"
       ],
@@ -538,7 +538,7 @@
       "message": "Operation tags must be defined in global tags"
     },
     {
-      "id": "kY_E95IbAqQE4YiaMVfXd",
+      "id": "_rYCt5q2ZfuJ7t-kZ1VTj",
       "given": [
         "#All_Ref"
       ],
@@ -556,7 +556,7 @@
       ]
     },
     {
-      "id": "u3H7ZhbrLKbLDE2FIRTa4",
+      "id": "Ubgspvdz6wBf3sz-CogqU",
       "given": [
         "#API_Document"
       ],
@@ -578,7 +578,7 @@
       ]
     },
     {
-      "id": "9WLn6IFDWgbupnx1kEvBk",
+      "id": "gAvFX5YfKoQNaVIZ0JdCs",
       "given": [
         "#API_Document"
       ],
@@ -601,7 +601,7 @@
       ]
     },
     {
-      "id": "ZFwjAjyu2QadWocsEr0HJ",
+      "id": "M7E5ennN7hawZExb6rTDZ",
       "given": [
         "#All_Enum"
       ],
@@ -622,7 +622,7 @@
       "message": "{{error}}"
     },
     {
-      "id": "O2JfxOMh8aFtHp53j4_az",
+      "id": "RyWQvJcOiuPkVF4L9PLR5",
       "given": [
         "#API_Document"
       ],
@@ -650,7 +650,7 @@
       ]
     },
     {
-      "id": "o4gzNmLnxS5mofi50JTx_",
+      "id": "LBDkW4kqoTxNDQQJJ_lFf",
       "given": [
         "#API_Document"
       ],
@@ -668,7 +668,7 @@
       ]
     },
     {
-      "id": "CJHx5RZpyPINgnjgbz4kZ",
+      "id": "xeeBxKgLvAv6zpPwfO7qV",
       "given": [
         "#API_Server_URL"
       ],
@@ -684,7 +684,7 @@
       "message": "Server URL must not point at example.com."
     },
     {
-      "id": "pjFHTR3Z9LXTrntdjorCG",
+      "id": "18UY_Suf02MNinWIMhgR6",
       "given": [
         "#Request_Parameter_All"
       ],
@@ -698,7 +698,7 @@
       "message": "Parameter objects must have \"description\"."
     },
     {
-      "id": "z8LaQSTFuPV4mxFNxoBKo",
+      "id": "cMs61U2_3gpiohIFqHbqH",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -716,7 +716,7 @@
       ]
     },
     {
-      "id": "4ap8Q1gWkhatDSfvXhBJL",
+      "id": "EpVIej7up6aSq-O9NgNMW",
       "given": [
         "#API_Document_RecursiveSearch"
       ],
@@ -734,7 +734,7 @@
       ]
     },
     {
-      "id": "JDsatNlN1uA8EGR5NAhTv",
+      "id": "DiOR7rbvRdXb7iBdolBXj",
       "given": [
         "#All_Example"
       ],
@@ -757,7 +757,7 @@
       ]
     },
     {
-      "id": "S0lPuW2SC3kiDDAxCXT1b",
+      "id": "7gVhZfJuMCfbBmiQnmbuu",
       "given": [
         "#All_Example_Schema"
       ],
@@ -779,7 +779,7 @@
       ]
     },
     {
-      "id": "T8RCG4fHNyMqq89AnQib2",
+      "id": "_-v5dx2I1NGNAG_6KEuHX",
       "given": [
         "#All_Example_Schema"
       ],
@@ -801,7 +801,7 @@
       ]
     },
     {
-      "id": "KeFqs14y-bEEx2YTA_F3S",
+      "id": "xyUX3rWAPC8b5jjoiS5PS",
       "given": [
         "#All_Example_Media"
       ],
@@ -823,7 +823,7 @@
       ]
     },
     {
-      "id": "fc4IhHxjvTjanP_QiJZGq",
+      "id": "zO3F_BQXXGsQKXlFz-O7k",
       "given": [
         "#All_Example_Media"
       ],
diff --git a/MorphoSource-REST-API.yaml b/MorphoSource-REST-API.yaml
index e7b363d..8f3caac 100644
--- a/MorphoSource-REST-API.yaml
+++ b/MorphoSource-REST-API.yaml
@@ -266,6 +266,7 @@ paths:
           name: f.sponsor
           description: Data Sponsor
       security:
+        - {}
         - API-Key: []
       tags:
         - Media endpoints
@@ -343,7 +344,7 @@ paths:
             type: string
           in: query
           name: q
-          description: 'Search query. This is optional, and without a query all Physical Object matching filter facet options will be shown. Omitting query and filter information can be used to query all Physical Objects.'
+          description: 'Search query. This is optional, and without a query all Physical Objects matching filter facet options will be shown. Omitting query and filter information can be used to query all Physical Objects.'
         - schema:
             type: integer
             default: 1
@@ -446,11 +447,12 @@ paths:
               examples: {}
       operationId: get-api-organization-id
       description: |-
-        Returns metadata for a single organization (a museum, institutional, or departmental collection of physical objects) record.
+        Returns metadata for a single Organization (a museum, institutional, or departmental collection of physical objects) record.
 
-        It is possible to include an API key, but by default all physical object records are public. Therefore, this is generally unnecessary.
+        It is possible to include an API key, but by default all Organization records are public. Therefore, this is generally unnecessary.
       parameters: []
       security:
+        - {}
         - API-Key: []
       tags:
         - Organization endpoints
@@ -489,7 +491,7 @@ paths:
               examples: {}
       operationId: get-api-organizations
       description: |-
-        Searches for organization (a museum, institutional, or departmental collection of physical objects) records and returns metadata. 
+        Searches for multiple Organization (a museum, institutional, or departmental collection of physical objects) records and returns metadata. 
 
         It is possible to include an API key, but by default all organization records are public. Therefore, this is generally unnecessary.
       parameters:
@@ -503,8 +505,53 @@ paths:
             type: string
           in: query
           name: q
-          description: Search query
+          description: 'Search query. This is optional, and without a query all Organizations matching filter facet options will be shown. Omitting query and filter information can be used to query all Organizations.'
+        - schema:
+            type: integer
+            default: 1
+          in: query
+          name: page
+          description: Current results page. Displays number of results equal to per_page parameter at current page increment.
+        - schema:
+            type: integer
+            default: 10
+            minimum: 1
+            maximum: 1000
+          in: query
+          name: per_page
+          description: Number of results to display. Maximum value of 1000 results per page.
+        - schema:
+            type: string
+          in: query
+          name: f.organization_type
+          description: Organization Type
+        - schema:
+            type: string
+          in: query
+          name: f.institution_name
+          description: Institution Name
+        - schema:
+            type: string
+          in: query
+          name: f.institution_code
+          description: Institution Code
+        - schema:
+            type: string
+          in: query
+          name: f.country
+          description: Country
+        - schema:
+            type: string
+          in: query
+          name: f.state_province
+          description: State/Province
+        - schema:
+            type: string
+          in: query
+          name: f.city
+          description: City
       security:
+        - {}
         - API-Key: []
       tags:
         - Organization endpoints
@@ -529,11 +576,12 @@ paths:
               examples: {}
       operationId: get-api-project-id
       description: |-
-        Returns metadata for a single project or team record.
+        Returns metadata for a single Project or Team record.
 
-        API key is not required for published projects or teams, but can be used to authenticate access to private projects or teams.
+        API key is optional. Querying published Projects or Teams does not require an API key. An API key can be used to query private Projects or Teams the user has specific access to view. If this route is used to query a Project or Team that does not exist, a Project or Team that is private and the request does not supply an API key, or a Project or Team that is private and an API key is supplied but the user does not have access to view the Media, then a 404 Not Found response will be returned.
       parameters: []
       security:
+        - {}
         - API-Key: []
       tags:
         - Project or team endpoints
@@ -572,22 +620,41 @@ paths:
               examples: {}
       operationId: get-api-projects
       description: |-
-        Searches for project or team records and returns metadata. 
+        Searches for multiple Project or Team records and returns metadata. 
 
-        API key is not required for published projects or teams, but can be used to authenticate access to private projects or teams.
+        API key is optional. Searching published Projects or Teams does not require an API key. An API key can be used to search private Projects or Teams the user has specific access to view.
       parameters:
         - schema:
             type: string
-            example: all_fields
           in: query
-          name: search_field
-          description: Must be "all_fields" to use search query
+          name: q
+          description: 'Search query. This is optional, and without a query all Projects and Teams matching filter facet options will be shown. Omitting query and filter information can be used to query all Projects or Teams the user has access to view'
+        - schema:
+            type: integer
+            default: 1
+          in: query
+          name: page
+          description: Current results page. Displays number of results equal to per_page parameter at current page increment.
+        - schema:
+            type: integer
+            minimum: 1
+            maximum: 1000
+            default: 10
+          in: query
+          name: per_page
+          description: Number of results to display. Maximum value of 1000 results per page.
         - schema:
             type: string
           in: query
-          name: q
-          description: Search query
+          name: f.type
+          description: Project or Team
+        - schema:
+            type: string
+          in: query
+          name: f.organization
+          description: Linked Organization
       security:
+        - {}
         - API-Key: []
       tags:
         - Project or team endpoints