Skip to content

Commit a661e3c

Browse files
committed
updated readme text
1 parent 3205395 commit a661e3c

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.rst

+7-13
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,13 @@ PointSecIO
5353
:target: https://github.com/PointSec-io/pointsecio/blob/main/LICENSE.txt
5454
:alt: License
5555

56-
PointSecIO is a framework based off of connexion that automagically handles HTTP requests based on `OpenAPI Specification`_
56+
PointSecIO (fork of Connexion_) is a framework that automagically handles HTTP requests based on `OpenAPI Specification`_
5757
(formerly known as Swagger Spec) of your API described in `YAML format`_. PointSecIO allows you to
5858
write an OpenAPI specification, then maps the endpoints to your Python functions; this makes it
5959
unique, as many tools generate the specification based on your Python code. You can describe your
6060
REST API in as much detail as you want; then PointSecIO guarantees that it will work as you
6161
specified.
6262

63-
We built PointSecIO this way in order to:
64-
65-
- simplify the development process
66-
- confirm expectations about what your API will look like
67-
6863
PointSecIO Features:
6964
--------------------
7065

@@ -91,15 +86,14 @@ single line of code.
9186

9287
If multiple teams depend on your APIs, you can use PointSecIO to easily send them the documentation of your API. This guarantees that your API will follow the specification that you wrote. This is a different process from that offered by frameworks such as Hug_, which generates a specification *after* you've written the code. Some disadvantages of generating specifications based on code is that they often end up lacking details or mix your documentation with the code logic of your application.
9388

94-
Other Sources/Mentions
95-
----------------------
89+
.. Other Sources/Mentions
90+
.. ----------------------
9691
97-
- Zalando RESTful API guidelines with `API First`_
98-
- PointSecIO listed on Swagger_'s website
99-
- Blog post: `Crafting effective Microservices in Python`_
92+
.. - Zalando RESTful API guidelines with `API First`_
93+
.. - Blog post: `Crafting effective Microservices in Python`_
10094
101-
New in PointSecIO 2.0:
102-
----------------------
95+
Whats in PointSecIO 1.0:
96+
------------------------
10397
- App and Api options must be provided through the "options" argument (``old_style_options`` have been removed).
10498
- You must specify a form content-type in 'consumes' in order to consume form data.
10599
- The `Operation` interface has been formalized in the `AbstractOperation` class.

0 commit comments

Comments
 (0)