Mercurial > hg > orthanc-book
changeset 583:502ac2047b9b
fix guide to contribute to openapi
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Sat, 02 Jan 2021 10:38:52 +0100 |
parents | 0ebb626a2b08 |
children | 4ca0061637ac |
files | README.md |
diffstat | 1 files changed, 13 insertions(+), 23 deletions(-) [+] |
line wrap: on
line diff
--- a/README.md Wed Dec 30 18:09:14 2020 +0100 +++ b/README.md Sat Jan 02 10:38:52 2021 +0100 @@ -67,27 +67,17 @@ REST API of Orthanc =================== -Setup ------ - -The REST API of Orthanc is documented according to the -[OpenAPI specification and in the YAML format](https://en.wikipedia.org/wiki/OpenAPI_Specification). - -The source code of the OpenAPI documentation can be found in the file -[./OpenAPI/orthanc-openapi.yaml](./OpenAPI/orthanc-openapi.yaml) -within this repository. +The REST API of Orthanc is now fully documented in the [source code of +the Orthanc +server](https://hg.orthanc-server.com/orthanc/file/default/OrthancServer/Sources/OrthancRestApi). +The `--openapi=` and the `--cheatsheet=` command-line options of +Orthanc automatically generate respectively the [OpenAPI in JSON +format](https://swagger.io/specification/) and its [quick reference +(cheatsheet)](https://book.orthanc-server.com/users/rest-cheatsheet.html) +in CSV format that is designed to be included right into the [Orthanc +Book](https://hg.orthanc-server.com/orthanc-book/file/default/Sphinx/source/users/rest-cheatsheet.csv). -Contributing to the OpenAPI ---------------------------- - - * Make sure to understand the - [OpenAPI YAML format](https://swagger.io/specification/). - * Fork this repository onto your BitBucket account. - * Edit the content of the - [`./OpenAPI/orthanc-openapi.yaml` file](./OpenAPI/orthanc-openapi.yaml). - * Submit a - [pull request](https://confluence.atlassian.com/bitbucket/create-a-pull-request-945541466.html) - for review by the Orthanc project. - * Once the pull request is reviewed and accepted, the continuous - integration server of the Orthanc project will automatically - publish the new version [online](http://api.orthanc-server.com/). +In order to contribute to the documentation of the REST API, you can +[propose a simple +patch](https://book.orthanc-server.com/developers/repositories.html#simple-patch-import-export) +to the core of Orthanc to be reviewed by the core maintainers.