So far, I can't find a way to add a deion for path</co

Check this example: <div class="Box-header

Openapi description for path variable about spectree HOT 3 CLOSED

0b01001001 commented on August 25, 2024

Openapi description for path variable

from spectree.

Comments (3)

kemingy commented on August 25, 2024 3

Sorry I misunderstood your question before. Currently, this library doesn't support descriptions for the path variables. You can use function description for the path variables.

One possible way is to add another path model. But I'm not sure if we should validate the input again.

class PathVariables(pydantic.BaseModel):
    source: str = pydantic.Field(..., description='source language')
    target: str

@api.route('/api/<string:source>/<string:target>')
@spec.validate(path=PathVariables)
def index(source, target):
    pass

Feel free to give more feedbacks about this.

from spectree.

kemingy commented on August 25, 2024

Check this example:

spectree/examples/flask_demo.py

Lines 55 to 76 in 36c4d18

    
           @app.route( 
        
               "/api/predict/<string(length=2):source>/<string(length=2):target>", methods=["POST"] 
        
           ) 
        
           @api.validate( 
        
               query=Query, json=Data, resp=Response("HTTP_403", HTTP_200=Resp), tags=["model"] 
        
           ) 
        
           def predict(source, target): 
        
               """ 
        
               predict demo 
        
               demo for `query`, `data`, `resp`, `x` 
        
               query with 
        
               ``http POST ':8000/api/predict/zh/en?text=hello' uid=xxx limit=5 vip=false `` 
        
               """ 
        
               print(f"=> from {source} to {target}")  # path 
        
               print(f"JSON: {request.context.json}")  # Data 
        
               print(f"Query: {request.context.query}")  # Query 
        
               if random() < 0.5: 
        
                   abort(403) 
        
               return jsonify(label=int(10 * random()), score=random())

For the path variables, this library doesn't provide a strong validation with pydantic. It will use the default path converter.

But of course you can still get the correct OpenAPI document for path variables.

from spectree.

parisni commented on August 25, 2024

But of course you can still get the correct OpenAPI document for path variables

Sorry I cannot find out in your example how to add a description to source and target path variable. I can see how to add constraints on them such as length but no description field that would appear in the openapi specs

from spectree.

Recommend Projects

Openapi description for path variable about spectree HOT 3 CLOSED

Comments (3)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	@app.route(
	"/api/predict/<string(length=2):source>/<string(length=2):target>", methods=["POST"]
	)
	@api.validate(
	query=Query, json=Data, resp=Response("HTTP_403", HTTP_200=Resp), tags=["model"]
	)
	def predict(source, target):
	"""
	predict demo

	demo for `query`, `data`, `resp`, `x`

	query with
	``http POST ':8000/api/predict/zh/en?text=hello' uid=xxx limit=5 vip=false ``
	"""
	print(f"=> from {source} to {target}") # path
	print(f"JSON: {request.context.json}") # Data
	print(f"Query: {request.context.query}") # Query
	if random() < 0.5:
	abort(403)

	return jsonify(label=int(10 * random()), score=random())