2.6.1 • Published 6 years ago

@image-intelligence/api-specification v2.6.1

Weekly downloads
-
License
-
Repository
github
Last release
6 years ago

api-specifications

Welcome to API Specifications!

This project contains OpenAPI specifications for the Image Intelligence API. There are currently two versions of our API (api-v1.json and v2/Api.js). Note that V1 will be marked for deprecation soon after the release of V2. If you've just started out, please build against V2.

Installation & Usage

npm install @image-intelligence/api-specification
import ApiSpec from '@image-intelligence/api-specification';

console.log(ApiSpec.v1);
console.log(ApiSpec.v2);

console.log(JSON.stringify(ApiSpec.v2, null, 2));

Development & Swagger

git clone git@github.com:ImageIntelligence/api-specification.git

When you're making changes to the API specification, it is often useful to verify the schema is valid:

npm install -g swagger-cli
swagger-cli help
swagger-cli validate xxx.json

Our JSON schema is generated from JavaScript files. To generate the schema:

node -e "console.log(JSON.stringify(require('./index').v2, null, 2))" | jq .
node -e "console.log(JSON.stringify(require('./index').v2, null, 2))" >! schema.json
node -e "console.log(JSON.stringify(require('./index').v2, null, 2))" | pbcopy

When editing the schema, perhaps you want a preview of your changes. The Swagger Editor can be useful here.

Not sure what Swagger or OpenAPI is? Check out this article.

Deployment

To publish a new version of api-specifications, update "version" in package.json and then create a GitHub Release.

2.6.1

6 years ago

2.6.0

6 years ago

2.6.0-rc4

6 years ago

2.6.0-rc3

6 years ago

2.6.0-rc2

6 years ago

2.6.0-rc1

6 years ago

2.5.0-rc18

7 years ago

2.5.0-rc17

7 years ago

2.5.0-rc16

7 years ago

2.5.0-rc15

7 years ago

2.5.0-rc14

7 years ago

2.5.0-rc13

7 years ago

2.5.0-rc12

7 years ago

2.5.0-rc11

7 years ago

2.5.0-rc10

7 years ago

2.5.0-rc9

7 years ago

2.5.0-rc8

7 years ago

2.5.0-rc7

7 years ago

2.5.0-rc6

7 years ago

2.5.0-rc5

7 years ago

2.5.0-rc4

7 years ago

2.5.0-rc3

7 years ago

2.5.0-rc2

7 years ago

2.5.0-rc1

7 years ago

2.4.0

7 years ago

2.3.2

7 years ago

2.2.0

7 years ago

2.1.1

7 years ago

2.1.0

7 years ago

2.0.0

7 years ago

2.0.0-rc18

7 years ago

2.0.0-rc17

7 years ago

2.0.0-rc16

7 years ago

2.0.0-rc15

7 years ago

2.0.0-rc14

7 years ago

2.0.0-rc13

7 years ago

2.0.0-rc12

7 years ago

2.0.0-rc11

8 years ago

2.0.0-rc10

8 years ago

2.0.0-rc9

8 years ago

2.0.0-rc8

8 years ago

2.0.0-rc7

8 years ago

2.0.0-rc6

8 years ago

2.0.0-rc5

8 years ago

2.0.0-rc4

8 years ago

2.0.0-rc1

8 years ago

2.0.0-rc3

8 years ago

2.0.0-rc2

8 years ago