Repository navigation
docs(api): document who can access vessel endpoints #480
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
8 changes: 6 additions & 2 deletions
8
docs/api-docs/api-reference/vessels/get-a-vessel-using-the-id.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,11 @@ | ||
| --- | ||
| title: "Get a vessel by ID" | ||
| description: "Retrieve a vessel from the Terminal49 API using its internal vessel ID, including name, IMO number, and optional position data for paid plan accounts." | ||
| description: "Retrieve a vessel on one of your actively tracked shipments by its Terminal49 vessel ID, including name, IMO number, and current position. Requires Routing Data." | ||
| og:title: Get a Vessel by ID | Terminal49 API | ||
| og:description: Retrieve vessel details by Terminal49 resource ID. Returns the vessel name, IMO number, current position, flag, and linked shipment information. | ||
| openapi: get /vessels/{id} | ||
| --- | ||
| --- | ||
|
|
||
| <Note> | ||
| This is a paid Routing Data endpoint. It returns only vessels on your account's actively tracked shipments. See [Vessel data access](/api-docs/useful-info/entitlements#vessel-data-access) for the `401`, `403`, and `404` responses. | ||
| </Note> |
8 changes: 6 additions & 2 deletions
8
docs/api-docs/api-reference/vessels/get-a-vessel-using-the-imo.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,11 @@ | ||
| --- | ||
| title: "Get a vessel by IMO" | ||
| description: "Retrieve a vessel from the Terminal49 API by IMO number, including the vessel name, internal ID, and optional AIS position data on paid plan accounts." | ||
| description: "Retrieve a vessel on one of your actively tracked shipments by its IMO number, including name, Terminal49 vessel ID, and current position. Requires Routing Data." | ||
| og:title: Get a Vessel by IMO Number | Terminal49 API | ||
| og:description: Look up vessel details by IMO number using the Terminal49 API. Returns the vessel name, current position, flag, and associated shipment data. | ||
| openapi: get /vessels/{imo} | ||
| --- | ||
| --- | ||
|
|
||
| <Note> | ||
| This is a paid Routing Data endpoint. It returns only vessels on your account's actively tracked shipments. See [Vessel data access](/api-docs/useful-info/entitlements#vessel-data-access) for the `401`, `403`, and `404` responses. | ||
| </Note> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For callers on a free or paused plan, or those using an invalid key, this note promises that lacking Routing Data makes every vessel endpoint return
403, while the newly added access table specifies401for exactly those cases. Because this description is reused across all four vessel operations and their generated SDK/Postman documentation, it should say that403applies only when the caller has full API access but lacks Routing Data.AGENTS.md reference: AGENTS.md:L60-L65
Useful? React with 👍 / 👎.