Skip to content

Commit

Permalink
Update readme.md + development md (#93)
Browse files Browse the repository at this point in the history
* test_invalid_api_key

* Added test endpoint

* Adeed lint to Development.md

* added license to bottom of readme and development md

* fixed merge mistake
  • Loading branch information
knframe2 authored Nov 17, 2024
1 parent 3f0b3b9 commit 78503df
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 6 deletions.
19 changes: 19 additions & 0 deletions Development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Lint
To start lint your code, simply run
```shell
npm run lint
```

## License
Copyright 2024 SkywardAI
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,6 @@ make dev
```
**NOTE:** `make dev` Requires Node.js environment installed, or at least have `node_modules` specified in `package.json` installed on your server. Please see [Local Machine](#local-machine) section.

## Lint
To start lint your code, simply run
```shell
npm run lint
```

## APIs

Expand Down
14 changes: 14 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,17 @@ example/test_apis.py::TestAllAPIs::test_inference_by_request_stream PASSED

## Api Test
![Successful Running example](img/api_test.png)

## License
Copyright 2024 SkywardAI
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
8 changes: 7 additions & 1 deletion example/test_apis.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,10 @@ def test_version_api(self):
res = requests.get(url=self.base_url+"/v1/version")
self.assertEqual(res.status_code, 200)
data = res.json().get("inference_engine_version")
self.assertEqual('server--b1-27d4b7c', data)
self.assertEqual('server--b1-27d4b7c', data)
def test_invalid_api_key(self):
res = requests.get(url=self.base_url+"/v1/token/api-key", headers={"Authorization": "Bearer invalid-key"})
self.assertEqual(res.status_code, 401)
def test_invalid_endpoint(self):
res=requests.get(url=self.base_url+"/v1/invalid-endpoint")
self.assertEqual(res.status_code, 404)

0 comments on commit 78503df

Please sign in to comment.