Merge pull request #305 from pvretano/issue-300

Changes to close issues #304, #302, #300, #280, #276, #168.

Author: kalxas

core/openapi/schemas/catalog.yaml

@@ -0,0 +1,95 @@
+---
+allOf:
+  $ref: "http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/\
+         schemas/collection.yaml"
+  type: object
+  required:
+    - title
+    - type
+    - itemType
+  properties:
+    type:
+      type: string
+      enum:
+        - catalog
+    itemType:
+      description:
+        The itemType type can be a string with the value of
+        "record" to indicate that this object is a catalog
+        (i.e. a collection of records). 
+        If the itemType is an array, this indicates that
+        this object is a general collection that can point
+        to other catalogs, records and/or other related
+        resources.
+      oneOf:
+        - type: string
+          enum:
+            - record
+        - type: array
+          items:
+            type: string
+            enum: 
+              - record
+              - catalog
+              - collection
+              - other
+    conformsTo:
+      description:
+        If all records (`itemType=record`) of the catalog
+        conform to same set of extensions/conformance classes
+        then this member may be used to advertise this fact
+        rather than copying this information into each record.
+      $ref: common/confClasses.yaml#/properties/conformsTo
+    created:
+      type: string
+      description:
+        Date of creation of this catalog.
+      format: date-time
+    updated:
+      type: string
+      description:
+        The most recent date on which this catalog was
+        changed.
+      format: date-time
+    keywords:
+      type: array
+      description:
+        The topic or topics of the catalog. Typically
+        represented using free-form keywords, tags, key
+        phrases, or classification codes.
+      items:
+        type: string
+    language:
+      description:
+        The language used for textual values for this
+        catalog object.
+      $ref: language.yaml
+    languages:
+      type: array
+      description:
+        This list of other languages in which this
+        catalog object can be retrieved.
+      items:
+        $ref: language.yaml
+    themes:
+      type: array
+      description:
+        A knowledge organization system used to classify
+        the resource.
+      minItems: 1
+      items:
+        $ref: theme.yaml
+    contacts:
+      type: array
+      description:
+        A list of contacts qualified by their role(s).
+      items:
+        $ref: contact.yaml
+    license:
+      $ref: license.yaml
+    rights:
+      type: string
+      description:
+        A statement that concerns all rights not addresses
+        by the license such as a copyright statement.
+    additionalProperties: true

core/openapi/schemas/catalogue.yaml

@@ -40,15 +40,17 @@ properties:
       updated:
         type: string
         description:
-          The most recent date on which the record was changed.
+          The most recent date on which the record was
+          changed.
         format: date-time
       type:
         type: string
         description:
-          The nature or genre of the resource. The value should be a code,
-          convenient for filtering records. Where available, a link to
-          the canonical URI of the record type resource will be added to
-          the 'links' property.
+          The nature or genre of the resource. The value
+          should be a code, convenient for filtering
+          records. Where available, a link to the
+          canonical URI of the record type resource will
+          be added to the 'links' property.
         maxLength: 64
       title:
         type: string
@@ -61,84 +63,97 @@ properties:
       keywords:
         type: array
         description:
-          The topic or topics of the resource. Typically represented using
-          free-form keywords, tags, key phrases, or classification codes.
+          The topic or topics of the resource. Typically
+          represented using free-form keywords, tags,
+          key phrases, or classification codes.
         items:
           type: string
       language:
         description:
-          The language used for textual values in this record representation.
+          The language used for textual values in this
+          record representation.
         $ref: language.yaml
       languages:
         type: array
         description:
-          This list of languages in which this record is available.
+          This list of languages in which this record
+          is available.
         items:
           $ref: language.yaml
       resourceLanguages:
         type: array
         description:
-          The list of languages in which the resource described by this
-          record is available.
+          The list of languages in which the resource
+          described by this record is available.
         items:
           $ref: language.yaml
       externalIds:
         type: array
         description:
-          An identifier for the resource assigned by an external (to the
-          catalogue) entity.
+          An identifier for the resource assigned by
+          an external (to the catalogue) entity.
         items:
           type: object
           properties:
             scheme:
               type: string
               description:
-                A reference to an authority or identifier for a knowledge
-                organization system from which the external identifier was
-                obtained.  It is recommended that the identifier be a
+                A reference to an authority or
+                identifier for a knowledge
+                organization system from which
+                the external identifier was
+                obtained.  It is recommended
+                that the identifier be a
                 resolvable URI.
             value:
               type: string
-              description: The value of the identifier.
+              description:
+                The value of the identifier.
           required:
             - value
       themes:
         type: array
         description:
-          A knowledge organization system used to classify the resource.
+          A knowledge organization system used
+          to classify the resource.
         minItems: 1
         items:
           $ref: theme.yaml
       formats:
         type: array
         description:
-          A list of available distributions of the resource.
+          A list of available distributions of
+          the resource.
         items:
           type: string
       contacts:
         type: array
         description:
-          A list of contacts qualified by their role(s) in association to the
-          record or the resource described by the record.
+          A list of contacts qualified by their
+          role(s) in association to the record
+          or the resource described by the record.
         items:
           $ref: contact.yaml
       license:
         $ref: license.yaml
       rights:
         type: string
         description:
-          A statement that concerns all rights not addressed by the license
-          such as a copyright statement.
+          A statement that concerns all rights
+          not addressed by the license such as
+          a copyright statement.
   links:
     type: array
     description:
-      A list of links for accessing the resource (e.g. download link,
-      access link) in one of the supported distribution formats and/or
-      links to other resources associated with this resource.
-      Also, a list of links for navigating the API (e.g. prev,
-      next, etc.).  Since the specification requires that at least
-      the self link be present then the min items for this list should
-      be one.
+      A list of links for accessing the resource
+      (e.g. download link, access link) in one of
+      the supported distribution formats and/or
+      links to other resources associated with this
+      resource. Also, a list of links for navigating
+      the API (e.g. prev, next, etc.).  Since the
+      specification requires that at least the self
+      link be present then the min items for this
+      list should be one.
     items:
       minItems: 1
       $ref: common/link.yaml

core/openapi/schemas/recordGeoJSON.yaml

@@ -83,6 +83,8 @@ toc::[]
 
 include::clause_0_front_material.adoc[]
 
+include::clause_10_security.adoc[]
+
 include::clause_1_scope.adoc[]
 
 include::clause_2_conformance.adoc[]
@@ -95,29 +97,11 @@ include::clause_5_conventions.adoc[]
 
 include::clause_6_overview.adoc[]
 
-include::clause_7_record.adoc[]
-
-include::clause_8_collection.adoc[]
-
-include::clause_9_api.adoc[]
-
-include::clause_10_crawlable_catalogue.adoc[]
-
-include::clause_11_searchable_catalogue.adoc[]
-
-include::clause_12_local_resources_catalogue.adoc[]
-
-include::clause_13_sorting.adoc[]
-
-include::clause_14_record-filter.adoc[]
-
-include::clause_15_autodiscovery.adoc[]
-
-include::clause_16_encodings.adoc[]
+include::clause_7_building_blocks.adoc[]
 
-include::clause_17_media_types.adoc[]
+include::clause_8_deployments.adoc[]
 
-include::clause_18_security.adoc[]
+include::clause_9_media_types.adoc[]
 
 include::annex_ats.adoc[]
 

core/standard/20-004.adoc

@@ -183,7 +183,7 @@ A successful response to the <<collections-meta-operation,Collections Operation>
 In a typical API deployment, the <<collection-meta-operation,collections response>>
 will list collections of all offered resource types.  The collections where
 the value of the `itemType` property (JSONPath: `$.collections[*].itemType`)
-is `record` are collections of records (i.e. catalogues).
+is `record` are collections of records (i.e. catalogs).
 
 [#collections-schema,reftext='Collections Response Schema']
 .Collections Response Schema