Skip to content

Commit

Permalink
add docs for proto_port
Browse files Browse the repository at this point in the history
  • Loading branch information
@zupo
zupo committed Apr 6, 2023
1 parent 1c2fda3 commit 6e9c6b7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,13 @@ config.add_route("foo_route", pattern="/foo")

The `pyramid_openapi3_register_routes()` method supports setting a factory and route prefix as well. See the source for details.

### Specify protocol and port for getting the OpenAPI 3 spec file

Sometimes, it is necessary to specify the protocol and port to access the openapi3 spec file. This can be configured using the `proto_port` optional parameter to the the `pyramid_openapi3_add_explorer` function:

config.pyramid_openapi3_add_explorer(proto_port=('https', 443))


## Demo / Examples

There are three examples provided with this package:
Expand Down

2 comments on commit 6e9c6b7

@kskarthik
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel it's better to specify from which version this will take effect. I could not see it working in 0.16.0

image

@zupo
Copy link
Collaborator Author

@zupo zupo commented on 6e9c6b7 Jun 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README is versioned along with the code. One can open up one of the release tags and read the tag's README to see what is supported.

Please sign in to comment.