clean-up

stac-extensions · Apr 4, 2024 · e259f94 · e259f94
1 parent a1e7139
commit e259f94
Show file tree

Hide file tree

Showing 5 changed files with 212 additions and 246 deletions.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -7,8 +7,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Inject env variables
-        uses: rlespinasse/github-slug-action@v3.x
-      - uses: actions/checkout@v2
+        uses: rlespinasse/github-slug-action@v4
+      - uses: actions/checkout@v4
       - name: deploy JSON Schema for version ${{ env.GITHUB_REF_SLUG }}
         uses: peaceiris/actions-gh-pages@v3
         with:

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -4,10 +4,10 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v4
         with:
           node-version: 'lts/*'
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - run: |
           npm install
           npm test
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Allow CommonMark for the `description` fields.
-- `name` is required rather than `description`
+- `classification:classes`: `name` is required rather than `description`
 
 ### Fixed
 

diff --git a/README.md b/README.md
@@ -51,14 +51,14 @@ These classification objects can be used in the following places:
 
 *Describes multiple classes stored in a field of a continuous range of bits*
 
-| Field Name  | Type       | Description                                                                                                                           |
-| ----------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- |
-| offset      | `integer`  | **REQUIRED.** Offset to first bit in the field                                                                                        |
-| length      | `integer`  | **REQUIRED.** Number of bits in the field                                                                                             |
-| classes     | `[Class]`  | **REQUIRED.** Classes represented by the field values                                                                                 |
-| roles       | `[string]` | see [Asset Roles](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#asset-roles)                           |
+| Field Name  | Type       | Description                                                  |
+| ----------- | ---------- | ------------------------------------------------------------ |
+| offset      | `integer`  | **REQUIRED.** Offset to first bit in the field               |
+| length      | `integer`  | **REQUIRED.** Number of bits in the field                    |
+| classes     | `[Class]`  | **REQUIRED.** Classes represented by the field values        |
+| name        | `string`   | Short name of the class for machine readability. Must consist only of letters, numbers, `-`, and `_` characters. |
 | description | `string`   | A short description of the classification. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
-| name        | `string`   | Short name of the class for machine readability                                                                                       |
+| roles       | `[string]` | see [Asset Roles](https://github.com/radiantearth/stac-spec/blob/master/item-spec/item-spec.md#asset-roles) |
 
 A Bit Field stores classes within a range of bits in a data value. The range is described by the offset of the first
 bit from the rightmost position, and the length of bits used to store the class values.
@@ -113,12 +113,12 @@ For a real world example, see [Landsat 8's Quality raster](https://www.usgs.gov/
 
 | Field Name  | Type       | Description                                                                                                          |
 | ----------- | ---------- | -------------------------------------------------------------------------------------------------------------------- |
-| value       | `integer`  | **REQUIRED.** Value of the class                                                                                     |
-| description | `string`   | Description of the class. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
-| name        | `string`   | **REQUIRED.** Short name of the class for machine readability. Must consist only of letters, numbers, `-`, and `_` characters.                                                        |
-| title       | `string` | Human-readable name for use in, e.g., a map legend. |
-| color_hint  | RGB string | suggested color for rendering (Hex RGB code in upper-case without leading #)                                         |
-| nodata      | `boolean`  | If set to `true` classifies a value as a no-data value, defaults to `false`                                          |
+| value       | integer  | **REQUIRED.** Value of the class                                                                                     |
+| name        | string   | **REQUIRED.** Short name of the class for machine readability. Must consist only of letters, numbers, `-`, and `_` characters.                                                        |
+| title       | string | Human-readable name for use in, e.g., a map legend. |
+| description | string   | Description of the class. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
+| color_hint  | string | Suggested color for rendering (Hex RGB code in upper-case without leading #)                                        |
+| nodata      | boolean  | If set to `true` classifies a value as a no-data value, defaults to `false`                                          |
 
 Class objects enumerate data values and their corresponding classes.
 A cloud mask raster could contain the following four classes: