Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Holds all schemas and data models for the Freight Shipment System
Weekly downloads
Readme
This repository holds the raw OAS documents for Freight Shipment APIs at DAT. The master branch should always be in sync with the Freight Shipment Redocly Project.
Changes to these schemas should be done in a feature branch and reviewed by the Freight development teams before being merged into the master branch and ported into Stoplight.
The first time you clone this repository you will want to do the following:
npm ci
npm run bootstrap
This project assumes that any OAS documents you want to generate TS models from and dereference are located under the
packages
directory and contain .oas2
or .oas3
(case-insensitive) in the filename.
To simplify how the code generation processes each respective package, it assumes that the directory name underneath
the packages
directory matches exactly with its respective npm package name that appears after the scope prefix.
(ex: packages/my-cool-api
--> @dat/my-cool-api
)
Once you feel your OAS changes are complete the next step is to generate the corresponding TypeScript models from them.
This project leverages lerna as a tool for managing monorepos, so the models for all OAS files can be generated at once
by running the npm script npm run build:dist
.
Make sure you've created an access token for your Redocly profile and set it as a system environment variable, ex:
$: export REDOCLY_TOKEN=<YOUR ACCESS TOKEN>
Please follow the semver guidance to decide whether to bump the OAS document's version's major, minor, or patch value.
Note: The package.json
version field is independent of OAS versions. This is because any given API schemas npm package
may or may not export multiple OAS documents and models which may lead to incompatibility and confusion when trying to synchronize
them.
Once you have made changes in API and created PR, please DON'T merge it until a feature that uses this API is not ready. It is important to merge PR with updated API version right before merging PR with a feature.
For local testing it is possible to replace the package in node_modules
or use npm link
.
With the option we use for lerna to publish the packages, we only need to worry about updating the version in the package.json
file to the desired value.
Once the PR is approved and merged, then the CI pipeline will execute the npm run publish
command, and any changed packages will be published to the npm registry under our @dat
scope.
FAQs
Holds all schemas and data models for the Freight Shipment System
The npm package freight-shipment-system-schemas receives a total of 0 weekly downloads. As such, freight-shipment-system-schemas popularity was classified as not popular.
We found that freight-shipment-system-schemas demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.