From aa40c58381ed562aafa1969f2d23d90d89f78191 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Thu, 14 Jul 2016 12:33:54 +0100 Subject: [PATCH] Note 'coreapi dump' command --- docs/topics/api-clients.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/topics/api-clients.md b/docs/topics/api-clients.md index 25b0c6145..f17f5e4d4 100644 --- a/docs/topics/api-clients.md +++ b/docs/topics/api-clients.md @@ -161,15 +161,17 @@ credentials --help` or `coreapi headers --help`. ## Codecs By default the command line client only includes support for reading Core JSON -schemas, however it for installing additional codecs. +schemas, however it includes a plugin system for installing additional codecs. $ pip install openapi-codec jsonhyperschema-codec hal-codec $ coreapi codecs show Codecs - corejson "application/vnd.coreapi+json" - openapi "application/openapi+json" - jsonhyperschema "application/schema+json" - hal "application/hal+json" + corejson application/vnd.coreapi+json encoding, decoding + hal application/hal+json encoding, decoding + openapi application/openapi+json encoding, decoding + jsonhyperschema application/schema+json decoding + json application/json data + text text/* data ## Utilities @@ -202,6 +204,10 @@ To load a schema file from disk: $ coreapi load my-api-schema.json --format corejson +To dump the current document to console in a given format: + + $ coreapi dump --format openapi + To remove the current document, along with all currently saved history, credentials, headers and bookmarks: