Skip to content

Commit

Permalink
Merge pull request #105 from nulib/deploy/staging
Browse files Browse the repository at this point in the history
Deploy v2.0.0 to production
  • Loading branch information
bmquinn authored Feb 7, 2023
2 parents 65186db + 388c673 commit bc2da08
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Our mission is to create, acquire, describe, and archive digital objects for long-term preservation, as well as to develop and deploy software that supports the discovery, access, and use of digital resources by members of Northwestern University, scholarly communities, and the public. The API provides access to the rich collections of the Northwestern University Libraries and allows users to explore and discover new resources.

This API provides access to the Library's digital resources to easily integrate the data into your own applications and workflows, regardless of your preferred programming language or framework. In fact, we use the API internally to provide the data and search functionality for our [Digital Collections site](https://dc.library.northwestern.edu). See the code examples below for ways to interact with the API using a variety of programming languages.
This API provides access to the Library's digital resources to easily integrate the data into your own applications and workflows, regardless of your preferred programming language or framework. In fact, we use the API internally to provide the data and search functionality for our [Digital Collections site](https://dc.library.northwestern.edu). We also publish a command-line interface (CLI) [application](https://github.com/nulib/nuldc) written in Python that provides built-in commands for fetching and querying the API from your terminal. See the code examples below for ways to interact with the API using a variety of programming languages.

Check out the [OpenAPI specification page](./spec.md) for detailed descriptions of each API endpoint with runnable examples.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/spec.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<iframe width="1400" height="600" src="../spec/openapi.html"></iframe>
[full window :octicons-link-external-16:](../spec/openapi.html)

[Here](./spec/openapi.json) is the OpenAPI spec.
[Here](../spec/openapi.json) is the OpenAPI spec.
4 changes: 2 additions & 2 deletions docs/docs/spec/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ openapi: 3.0.1
info:
title: Northwestern University Libraries Digital Collections API
description: >
This is full Markdown intro text. This API drives the [Northwestern University Libraries Digital
This API provides direct access to the data that drives the [Northwestern University Libraries Digital
Collections](https://dc.library.northwestern.edu) site.
I can even put line breaks in it. I can also link back to the [main documentation](..).
Please visit the [documentation](..) for more information.
version: 2.0.0
contact:
name: NUL Repository Team
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dc-api-build",
"version": "2.0.0-rc.4",
"version": "2.0.0",
"description": "NUL Digital Collections API Build Environment",
"repository": "https://github.com/nulib/dc-api-v2",
"author": "nulib",
Expand Down
4 changes: 2 additions & 2 deletions src/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "dc-api",
"version": "2.0.0pre",
"version": "2.0.0",
"description": "NUL Digital Collections API",
"repository": "https://github.com/nulib/dc-api-v2",
"author": "nulib",
Expand Down
19 changes: 19 additions & 0 deletions test/unit/package.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
const chai = require("chai");
const expect = chai.expect;

describe("package.json", () => {
const rootPackage = requireSource("../package.json");
const srcPackage = requireSource("./package.json");

it("root package has no external runtime dependencies", () => {
expect(Object.keys(rootPackage.dependencies)).to.eql(["dc-api"]);
});

it("src package has no develoment dependencies", () => {
expect(srcPackage.devDependencies).to.be.undefined;
});

it("root and src packages are the same version", () => {
expect(rootPackage.version).to.eq(srcPackage.version);
});
});

0 comments on commit bc2da08

Please sign in to comment.