diff --git a/README.md b/README.md index f9b9eb025..5b2760184 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,36 @@ Third Party Application -============= +======================= The Third Party Application microservice is responsible for maintaining the state of applications created by (or on behalf of) third parties to consume APIs registered on the API Platform. -# Tests +Application Search +------------------ +Searching of Applications within the microservice is acheived by issuing a `GET` to the `/applications` endpoint, making use of the following Query Parameters: + +Parameter Name | Data Type/Allowed Values | Description +------------------|-----------------------------------------------------------------------------------|------------ +`search` | Free Text | Search Application names and identifiers +`status` | `CREATED`, `PENDING_GATEKEEPER_CHECK`, `PENDING_SUBMITTER_VERIFICATION`, `ACTIVE` | Retrieve Applications based on lifecycle status +`termsOfUse` | `ACCEPTED`, `NOT_ACCEPTED` | Whether owner of Application has accepted relevant Terms of Use +`accessType` | `STANDARD`, `ROPC`, `PRIVILEGED` | Access type that Application uses +`apiSubscription` | `ANY`, `NONE`, or specific API name | Which API the Application is subscribed to +`apiVersion` | Version Number | Version of the specific API that Application is subscribed to. Only relevant when the name of an API has been specified for `apiSubscription` +`page` | Number (Defaults to `1` if not specified) | The page number to display (based on `pageSize`) +`pageSize` | Number (Defaults to `Int.MaxValue` if not specified) | The maximum number of results to return + +### Examples + +Request | Description +-----------------------------------------------------------|------------ +`/applications` | All Applications +`/applications?status=CREATED` | All Applications in testing +`/applications?search=foo` | All Applications containing the text `foo` in either their name or id +`/applications?apiSubscription=test-service&apiVersion=v1` | All Applications subscribing to `v1` of `test-service` API +`/applications?accessType=STANDARD&page=1&pageSize=25` | First 25 Applications using `Standard` access type + +Tests +----- Some tests require `MongoDB` to run. Thus, remember to start up MongoDB if you want to run the tests locally. The tests include unit tests and integration tests. @@ -18,7 +44,8 @@ A report will also be generated identifying any dependencies that need upgrading you have defined CATALOGUE_DEPENDENCIES_URL as an environment variable pointing to the dependencies endpoint on the Tax Platform Catalogue's API. -#Current Known Issues +Current Known Issues +-------------------- In some use cases, specifically if this microservice is running locally there may be a problem with Wso2. This can be resolved be entering application.conf and changing: