chore(deps): bump the go-dependencies group in /.sage with 1 update

Bumps the go-dependencies group in /.sage with 1 update: [go.einride.tech/sage](https://github.com/einride/sage). - [Release notes](https://github.com/einride/sage/releases) - [Commits](einride/sage@v0.247.0...v0.259.0) --- updated-dependencies: - dependency-name: go.einride.tech/sage dependency-type: direct:production update-type: version-update:semver-minor dependency-group: go-dependencies ... Signed-off-by: dependabot[bot] <[email protected]>
einride · Dec 4, 2023 · b9610dd · b9610dd
1 parent cea58e6
commit b9610dd
Show file tree

Hide file tree

Showing 10 changed files with 168 additions and 64 deletions.
diff --git a/.sage/go.mod b/.sage/go.mod
@@ -2,4 +2,4 @@ module sage
 
 go 1.19
 
-require go.einride.tech/sage v0.247.0
+require go.einride.tech/sage v0.259.0
diff --git a/.sage/go.sum b/.sage/go.sum
@@ -1,2 +1,2 @@
-go.einride.tech/sage v0.247.0 h1:4K8KVRWP3gutmxhR7gMc+Q5ss8+OA7SFnGpVxmk6wT4=
-go.einride.tech/sage v0.247.0/go.mod h1:EzV5uciFX7/2ho8EKB5K9JghOfXIxlzs694b+Tkl5GQ=
+go.einride.tech/sage v0.259.0 h1:ZbQtl8IZ2fIc8zxKDMm1cprV4ysvPDvPkSZqvHXcRD4=
+go.einride.tech/sage v0.259.0/go.mod h1:EzV5uciFX7/2ho8EKB5K9JghOfXIxlzs694b+Tkl5GQ=
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -2,78 +2,127 @@
 
 ## Our Pledge
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
 
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
 - Demonstrating empathy and kindness toward other people
 - Being respectful of differing opinions, viewpoints, and experiences
 - Giving and gracefully accepting constructive feedback
-- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-- Focusing on what is best not just for us as individuals, but for the overall community
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
 - Trolling, insulting or derogatory comments, and personal or political attacks
 - Public or private harassment
-- Publishing others' private information, such as a physical or email address, without their explicit permission
-- Other conduct which could reasonably be considered inappropriate in a professional setting
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
 
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
 
 ## Scope
 
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected].
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
 
 All complaints will be reviewed and investigated promptly and fairly.
 
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
 
 ## Enforcement Guidelines
 
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+This Code of Conduct is adapted from the
+[Contributor Covenant](https://www.contributor-covenant.org), version 2.0,
+available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/README.md b/README.md
@@ -2,41 +2,51 @@
 
 # Einride Extend
 
-Open APIs and developer tools for building extensions and integrations to [Saga](https://einride.tech/saga), Einride's freight mobility platform.
+Open APIs and developer tools for building extensions and integrations to
+[Saga](https://einride.tech/saga), Einride's freight mobility platform.
 
-The full documentation for Saga developers is available at [extend.saga.einride.tech](https://extend.saga.einride.tech).
+The full documentation for Saga developers is available at
+[extend.saga.einride.tech](https://extend.saga.einride.tech).
 
-**Note:** *The Extend APIs are alpha versioned and currently available to select developers during an early-access phase. To become a Saga developer during the early-access phase, please apply below.*
+**Note:** *The Extend APIs are alpha versioned and currently available to select
+developers during an early-access phase. To become a Saga developer during the
+early-access phase, please apply below.*
 
 <a href="https://forms.gle/Sn3CYSgUgJbJE78X9"><img src="docs/img/button.svg" /></a>
 
 ## APIs
 
-Saga's APIs are resource-oriented and work like standard [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs.
+Saga's APIs are resource-oriented and work like standard
+[REST](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs.
 
 gRPC and HTTP protocols are supported.
 
 *[Read more ≫](./docs/apis.md)*
 
 ## CLI
 
-The [saga](./cmd/saga) CLI tool enables you to call the Extend APIs from the command line of your local development machine.
+The [saga](./cmd/saga) CLI tool enables you to call the Extend APIs from the
+command line of your local development machine.
 
-Get the latest version of the CLI from the [Releases](https://github.com/einride/extend/releases) page.
+Get the latest version of the CLI from the
+[Releases](https://github.com/einride/extend/releases) page.
 
 *[Read more ≫](./docs/cli.md)*
 
 ## SDKs
 
-SDKs for developing with Saga are available for [Go](https://github.com/einride/extend-go) and [TypeScript](https://github.com/einride/extend-typescript).
+SDKs for developing with Saga are available for
+[Go](https://github.com/einride/extend-go) and
+[TypeScript](https://github.com/einride/extend-typescript).
 
 Support for more languages are on the roadmap.
 
 *[Read more ≫](./docs/sdks.md)*
 
 ## UI
 
-A UI component framework for developing Saga apps is available for [React](https://github.com/einride/ui).
+A UI component framework for developing Saga apps is available for
+[React](https://github.com/einride/ui).
 
 *[Read more ≫](https://github.com/einride/ui)*
 

diff --git a/docs/apis.md b/docs/apis.md
@@ -1,29 +1,44 @@
 # Einride Extend APIs
 
-Based on REST principles, with support for gRPC, the Einride Extend APIs enable integrations and extensions to Einride's Saga platform.
+Based on REST principles, with support for gRPC, the Einride Extend APIs enable
+integrations and extensions to Einride's Saga platform.
 
 ## API design
 
-The Extend APIs are designed using the [AIP](https://aip.dev) design framework, which means that they are resource-oriented and work like standard [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs.
+The Extend APIs are designed using the [AIP](https://aip.dev) design framework,
+which means that they are resource-oriented and work like standard
+[REST](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs.
 
 ## API specification
 
-The APIs are specified and documented using the [Protocol Buffer](https://developers.google.com/protocol-buffers/docs/proto3) interface definition language.
+The APIs are specified and documented using the
+[Protocol Buffer](https://developers.google.com/protocol-buffers/docs/proto3)
+interface definition language.
 
 ## Protocols
 
 Saga's APIs support both gRPC and HTTP protocols.
 
 ### gRPC
 
-[gRPC](https://grpc.io) is a high performance, open source universal RPC framework that works across programming languages and platforms.
+[gRPC](https://grpc.io) is a high performance, open source universal RPC
+framework that works across programming languages and platforms.
 
-To call Saga's APIs via gRPC, you can use the protobuf source files to generate a client for [your preferred language](https://grpc.io/docs/languages).
+To call Saga's APIs via gRPC, you can use the protobuf source files to generate
+a client for [your preferred language](https://grpc.io/docs/languages).
 
-The Saga APIs are also available via the [Buf Schema Registry](buf.build/einride/saga), which is a registry for openly sharing gRPC APIs between organizations. You can use one of the [remote generation plugins](https://docs.buf.build/tour/use-remote-generation) provided by Buf.
+The Saga APIs are also available via the
+[Buf Schema Registry](buf.build/einride/saga), which is a registry for openly
+sharing gRPC APIs between organizations. You can use one of the
+[remote generation plugins](https://docs.buf.build/tour/use-remote-generation)
+provided by Buf.
 
 ### HTTP
 
-Saga's APIs are also available as RESTful HTTP endpoints, via automatic [gRPC to HTTP transcoding](https://google.aip.dev/127).
+Saga's APIs are also available as RESTful HTTP endpoints, via automatic
+[gRPC to HTTP transcoding](https://google.aip.dev/127).
 
-See the [openapiv2](https://github.com/einride/extend/openapiv2) directory for the latest OpenAPI specifications, or use the API documentation at [extend.saga.einride.tech](https://extend.saga.einride.tech) where you can also try out the REST APIs and make example requests.
+See the [openapiv2](https://github.com/einride/extend/openapiv2) directory for
+the latest OpenAPI specifications, or use the API documentation at
+[extend.saga.einride.tech](https://extend.saga.einride.tech) where you can also
+try out the REST APIs and make example requests.
diff --git a/docs/architecture-decisions/adr001-adrs.md b/docs/architecture-decisions/adr001-adrs.md
@@ -10,7 +10,8 @@ ______________________________________________________________________
 
 Users of the Extend APIs expect a stable and reliable API.
 
-Large changes to the API should be communicated openly, with context available for users to understand why the change is needed and how it might affect them.
+Large changes to the API should be communicated openly, with context available
+for users to understand why the change is needed and how it might affect them.
 
 ## Decision
 

diff --git a/docs/architecture-decisions/adr002-v1-resource-hierarchy.md b/docs/architecture-decisions/adr002-v1-resource-hierarchy.md
@@ -8,18 +8,32 @@ ______________________________________________________________________
 
 ## Context
 
-The Extend APIs are designed using the [AIP](https://aip.dev) design framework, which means that they are resource-oriented and work like standard [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs, as is documented in our [API Design docs](../apis.md).
-
-The current resources under `book/v1beta1` all use spaces as their parent, such as the [Shipment resource](../../proto/einride/saga/extend/book/v1beta1/shipment.proto) which is referenced with the `spaces/{space}/shipments/{shipment}` name format. This results in the REST based URLs to include the space name, such as the `GET /v1beta1/spaces/{space}/shipment/{shipment}` endpoint to get a shipment.
-
-We have received feedback from API users that they have found this confusing, and that it complicate integrations by requiring URLs with dynamic parts, even for creating resources.
+The Extend APIs are designed using the [AIP](https://aip.dev) design framework,
+which means that they are resource-oriented and work like standard
+[REST](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs, as
+is documented in our [API Design docs](../apis.md).
+
+The current resources under `book/v1beta1` all use spaces as their parent, such
+as the
+[Shipment resource](../../proto/einride/saga/extend/book/v1beta1/shipment.proto)
+which is referenced with the `spaces/{space}/shipments/{shipment}` name format.
+This results in the REST based URLs to include the space name, such as the
+`GET /v1beta1/spaces/{space}/shipment/{shipment}` endpoint to get a shipment.
+
+We have received feedback from API users that they have found this confusing,
+and that it complicate integrations by requiring URLs with dynamic parts, even
+for creating resources.
 
 ## Decision
 
-Resources in the V1 API will be owned by an organization, which an API user is always connected to.
+Resources in the V1 API will be owned by an organization, which an API user is
+always connected to.
 
-The V1 APIs will by-default not require spaces or organization as part of the resource names, and thus not part of the URLs, but will instead be inferred from the user transparently.
+The V1 APIs will by-default not require spaces or organization as part of the
+resource names, and thus not part of the URLs, but will instead be inferred from
+the user transparently.
 
 ## Consequences
 
-No need to specify space or organization in the V1 APIs, leading to slightly different but simpler REST based URLs.
+No need to specify space or organization in the V1 APIs, leading to slightly
+different but simpler REST based URLs.