Skip to content
This repository has been archived by the owner on Jan 12, 2023. It is now read-only.

Commit

Permalink
Repo readme update (#185)
Browse files Browse the repository at this point in the history
* Improve README.md
  • Loading branch information
GoebelL authored Feb 25, 2020
1 parent 93aef36 commit a1ecb96
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@

# oscm-rest-api
This is a RESTful API for the Open Service Catalog Manager.
It is integrated with Swagger (an implementation of OpenApi standard). You can explore and use the API resources using Swagger-UI which is accessible via /oscm-rest-api context path on the oscm-core https port (default 8081).
All resources as well as Swagger UI are protected. When visiting the Swagger UI, your browser will ask for authorization. Enter the credentials for the platform administrator.

![Swagger UI endpoint categories view](https://raw.githubusercontent.com/servicecatalog/oscm-rest-api/master/oscm-rest-api-swagger/src/main/resources/swagger-ui-demo.png)
This API is integrated with Swagger - an implementation of [OpenAPI specification](https://www.openapis.org/). You can explore and use the OSCM API resources via the Swagger UI, which is deployed in the [oscm-core](https://hub.docker.com/r/servicecatalog/oscm-core/) container. A description for installing OSCM on docker can be found [here](https://github.com/servicecatalog/oscm-dockerbuild#setup).

# Prerequisites
A Linux system with:
You can access the Swagger UI with the context path **/oscm-rest-api**, by default on the oscm-core HTTPS port 8081. All resources as well as Swagger UI are protected. When visiting the Swagger UI, your browser will ask for authorization.
Enter the user key ```1000``` and password for the OSCM platform administrator.

![IMAGE Swagger UI](/swaggerui.png)

* Latest OSCM version installed and running (find the Quickstart instruction)
* Apache TomEE version >= 7.1.1 in the oscm-core container
# Prerequisites
A Linux operating system, with
* Mininum specification as described [here](https://github.com/servicecatalog/oscm-dockerbuild#prerequisites)
* Latest OSCM version installed and running (find the [Quickstart instructions](https://github.com/servicecatalog/oscm-dockerbuild#setup))
* Apache TomEE version >= 7.1.1, which is already included since OSCM v18.1

# Building from source
To build the REST API:
Expand All @@ -23,3 +26,4 @@ To build the REST API:
From docker host execute: `docker cp oscm-rest-api-uberwar/target/oscm-rest-api.war oscm-core:/opt/apache-tomee/webapps/`
There is no need to restart the container afterwards. You can view the .war deployment logs in the newest `/logs/juli.log` file in the oscm-core container.
4. Open the Swagger UI in your client browser on https://FQDN:8081/oscm-rest-api (where FQDN refers to your OSCM fully qualified domain name as configured in your `/docker/var.env` file).

Binary file added swaggerui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a1ecb96

Please sign in to comment.